Skip to content

Commit

Permalink
update code-documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@ElisabethKloren
ElisabethKloren committed Apr 27, 2024
1 parent 356de3e commit d1588b2
Show file tree
Hide file tree
Showing 7 changed files with 281 additions and 135 deletions.
4 changes: 1 addition & 3 deletions docs/code_documentation/h/0-samenvatting.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
Dit document beschrijft het informatiemodel van NLCS. NLCS is als linked data gepubliceerd.
Dit document beschrijft het informatiemodel van NLCS en de distributievormen. NLCS is als linked data gepubliceerd, conform de NEN 2660-2. De laagnamen, symbolen en arceringen die gebruikt worden in NLCS, worden beschouwd als nen2660-2-InformatieObject.

<p><dfn>NLCS</dfn> Een afkorting van Nederlandse CAD Standaard, een standaard voor het maken en overdragen van digitale [=CAD-modellen=] in de openbare ruimte en infrastructuur.</p>

<p><dfn>CAD</dfn> "Computer Aided Design" ofwel het ontwerpen van ruimtelijke objecten met behulp van een applicatie.</p>
32 changes: 10 additions & 22 deletions docs/code_documentation/h/1.md
View file
Original file line number Diff line number Diff line change
@@ -1,31 +1,19 @@
# Inleiding

## Doel documentatie
De <abbr title="Nederlandse CAD-standaard">NLCS</abbr> is als linked data gepubliceerd. Dit document beschrijft de structuur van het gepubliceerde informatiemodel.



## Samenvatting NLCS

De NLCS is een open standaard, die afspraken bevat voor:
* A. [=Metadata=]: de (minimale) set van gegevens en/of onderdelen die moeten worden opgenomen in het titelblok van een [=CAD-tekening=];
* B. Basis digitaal tekenen: afspraken met betrekking tot de wijze waarop digitaal wordt gemodelleerd, te hanteren eenheden, assenstelsels, peilen en tekenbladschalen;
* C. Uiterlijk van de [=CAD-tekening=]: afspraken met betrekking tot onder andere toegestane afmetingen van het tekenblad, kaders, tekststijlen, bematingsstijlen en lettertypen;
* D. Ordening/codering en representatie van objecten: afspraken met betrekking tot de wijze waarop informatie binnen een tekening in lagen wordt geordend in een [=CAD-model=].

<p><dfn data-lt="CAD-model|CAD-modellen">CAD-model</dfn> Een model in een CAD-applicatie met daarin een weergave van ruimtelijke objecten in 2D of 3D </p>

<p><dfn data-lt="CAD-tekening|CAD-tekeningen">CAD-tekening</dfn> Een printbare weergave van het CAD-model met een kader en een titelblok met informatie over de tekening</p>

<p><dfn>Metadata</dfn> Onder “Metadata” wordt in NLCS verstaan: <ol><li> de (minimale) set van informatie over een tekening die noodzakelijk is voor adequaat document management.</li>
<li>Metadata worden als regel opgenomen in het titelblok van de tekening. </li><li> Attribuutnamen die worden gebruikt voor Metadata, mogen zowel in het Nederlands als in het Engels zijn.</li></ol></p>


Dit document beschrijft het informatiemodel van NLCS en de distributievormen.


## Semantiek
Het informatiemodel is gebaserd op het conceptuele model van [[NEN_2660_2_2022]] - Regels voor informatiemodellering van de gebouwde omgeving. Deze NEN-norm wordt gebruikt als primaire standaard en verwijst in zichzelf ook naar andere standaarden zoals [[skos-reference]], [[rdf-schema]]-[[owl2-syntax]] en [[SHACL]].

Het informatiemodel is gebaserd op het conceptuele model van [[NEN_2660_2_2022]] - Regels voor informatiemodellering van de gebouwde omgeving. Deze NEN-norm wordt gebruikt als primaire standaard en verwijst in zichzelf ook naar andere standaarden zoals [[skos-reference]], [[rdf-schema]]-[[owl2-syntax]] en [[SHACL]]. De laagnamen, symbolen en arceringen die gebruikt worden in NLCS, worden beschouwd als nen2660-2-InformatieObject.

## Leeswijzer
* In **hoofdstuk 2** worden de modellen beschreven in het informatiemodel van de NLCS.
* In **hoofdstuk 3** wordt de thesaurus beschreven.
* In **hoofdstuk 4** wordt de taxonomie beschreven.
* In **hoofdstuk 5** worden de attributen en relaties van objecten, symbolen en arceringen beschreven en worden deze gerelateerd aan de tabellen die met query's uit de linked data publicatie worden gehaald.
* In **hoofdstuk 6** worden de distributievormen beschreven.
* In **Bijlag 1** staat een lijst met afwijkende lijnstijlen die niet in de database zijn opgenomen.



22 changes: 7 additions & 15 deletions docs/code_documentation/h/2.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,34 +16,26 @@ NLCS wil acteren in niveau 1 en niveau 3. Niveau 2 wordt voor NLCS over geslagen


### Model van begrippen
De NLCS publicatie kent op dit moment geen begrippen. Om NLCS te kunnen relateren aan andere standaarden moet er een model van begrippen (thesaurus, op het skos-niveau uit de NEN 2660-2) gepubliceerd worden.
De NLCS publicatie kent op dit moment geen begrippen. Om NLCS te kunnen relateren aan andere standaarden moet er een model van begrippen gepubliceerd worden. Deze wordt in de documentatie "thesaurus" genoemd.

<div class="issue" data-number="178"></div>
<p><dfn>thesaurus</dfn>: Een set van termen en definities, met eventueel relaties tussen deze termen uit [[skos]].

### Logisch informatiemodel
Binnen NLCS gaan we uit van het bestaande vocabulaire uit de [[NEN_2660_2_2022]]. Binnen het logische informatiemodel wordt een ontologie onderscheiden. In deze ontologie maken we voornamelijk gebruik van het "NEN2660-2 Praktisch toplevelmodel". Alle concepten binnen de NLCS ontologie worden beschreven binnen de context van de NEN2660-2. Hiermee sluiten we aan bij de ordeningsregels en uiteindelijk ook de taalbinding die in de NEN2660-2 beschreven worden. Hiermee is het "NEN2660-2 praktisch toplevelmodel" ook de top van de NLCS. Het logische informatiemodel beschrijft alle concepten, attributen en relaties binnen NLCS.

Onderstaande figuur is niet het logische informatiemodel zelf, maar het metamodel hiervan. Dit metamodel is specifieke voor NLCS en staat dus 'naast' het MIM.

<div class="issue" data-number="229"></div>


In het logisch informatiemodel van NLCS komt een taxonomie voor.

<p><dfn>taxonomie</dfn>: Een hiërarchie, waarin onderliggende concepten specifieker zijn dan het bovenlggende concept.




### Fysiek datamodel
Omdat NLCS gedistribueerd wordt in LinkedData en als tabellen is het fysieke datamodel een beschrijving van hoe de IMBOR onderdelen uitgedrukt worden. Dit betekent geenszins dat NLCS ook dit fysieke datamodel voorschrijft bij implementatie. Het geeft wel een goed inzicht in hoe de relaties lopen en welke verschillende (normatieve) onderdelen NLCS kent.
Omdat NLCS gedistribueerd wordt in LinkedData en als tabellen is het fysieke datamodel een beschrijving van hoe de NLCS onderdelen uitgedrukt worden in de tabellen. Dit betekent geenszins dat NLCS ook dit fysieke datamodel voorschrijft bij implementatie. Het geeft wel een goed inzicht in hoe de relaties lopen en welke verschillende (normatieve) onderdelen NLCS kent.

De tabellen worden [hier](#ordening-codering-en-representatie-van-objecten) beschreven.
De tabellen worden [hier](#tabellen) beschreven.

Het fysieke datamodel in LinkedData kan gelijk worden gesteld aan de 'serialisatie'. In het geval van IMBOR is dit [turtle].
Het fysieke datamodel in LinkedData kan gelijk worden gesteld aan de 'serialisatie'. In het geval van NLCS is dit [turtle].

<aside class="example" title="NLCS ontolgie">
De NLCS Ontologie is te verkennen in de <a href="https://nl-digigo.github.io/ld-viewer/nlcs/">NLCS viewer van concept-publicatie</a>
<aside class="example" title="Viewer">
De publicatie van NLCS is te verkennen in de <a href="https://nl-digigo.github.io/ld-viewer/nlcs/">NLCS viewer van concept-publicatie</a>
</aside>


Expand Down
2 changes: 1 addition & 1 deletion docs/code_documentation/h/3.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Thesaurus

<div class="issue" data-number="2"></div>
NLCS 5.0 publiceert nog geen expliciete begrippen.In de laagnamen wordt gebruik gemaakt van impliciete termen.
27 changes: 6 additions & 21 deletions docs/code_documentation/h/4.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,18 @@

NLCS heeft als doel, de geometrische weergave van objecten in CAD modellen te ordenen en de visuele weergave van de objecten te standaardiseren. NLCS bestaat daarmee uit [nen2660:InformatieObject](https://w3id.org/nen2660/def#InformationObject).

Het informatiemodel van NLCS kent een [=taxonomie=] van InformatieObjecten, die begint bij [nen2660:InformatieObject](https://w3id.org/nen2660/def#InformationObject). Daaronder vallen in NLCS vier types informatieobjecten:
Het informatiemodel van NLCS kent een [=taxonomie=] van InformatieObjecten, die begint bij [nen2660:InformatieObject](https://w3id.org/nen2660/def#InformationObject). Daaronder vallen in NLCS deze soorten informatieobjecten:

1. [NLCSObject](#nlcsobject)
2. [Arcering](#arcering)
3. [Lijntype](#lijntype)
4. [Symbool](#symbool)
3. [Symbool](#symbool)
4. [Lijntype](#lijntype)
5. [Lijnkleuren](#lijnkleur)
6. [Lijnweights](#lijnweights)


### <dfn>NLCSObject</dfn>

NLCSObjecten bevatten laagnamen voor geometrische representaties van objecten in de vorm van punten, lijnen en vlakken.

In de laagnaam wordt aangegeven dat in de laag geometrische objecten voorkomen met de code -G. Deze geometrische objecten (lijnen, punten, vlakken) representeren een fysiek object, waarvan NLCS nog geen expliciete definitie kent.
### <dfn>Harmonicamodel</dfn>

Binnen de taxonomie van NLCS is de relatie tussen bovenliggende en onderliggende NLCSObjecten: [rdfs:subClassof](https://www.w3.org/2000/01/rdf-schema#subClassOf). Deze relatie betekent ook, dat informatie over een concept overerft op het onderliggende concept. Als op het niveau van "GELEIDECONSTRUCTIE" al lijntypes zijn gedefinieerd, gelden deze ook voor "GELEIDECONSTRUCTIE_BEBAKENING".

<div class="issue" data-number="3"></div>



### <dfn>Arcering</dfn>


### <dfn>Lijntype</dfn>


### <dfn>Symbool</dfn>


<div class="issue" data-number="98"></div>
Loading

0 comments on commit d1588b2

Please sign in to comment.