Note¶
Overview¶
Class
A textual annotation about ConceptualObjects.
See also ReferencedNotes.
Supertypes
Attributes (data)
Name |
Multiplicity |
Type |
---|---|---|
0..1 |
||
0..1 |
||
0..1 |
||
0..1 |
Implementation in Proteus Schema
The class is implemented as a Proteus XML element with RDL reference.
Tag: <Note>
RDL reference: NOTE
ComponentClass: Note
ComponentClassURI: http://sandbox.dexpi.org/rdl/Note
Example
Implementation in Proteus Schema
<Note
ID="note1"
ComponentClass="Note"
ComponentClassURI="http://sandbox.dexpi.org/rdl/Note" ...>
...
</Note>
LocalNoteIdentifier¶
Attribute (data)
An identifier for the Note in a local context.
A typical usage of the LocalNoteIdentifier is to visualize the relation between a ConceptualObject shown on a diagram und the actual NoteText shown elsewhere on the diagram: The LocalNoteIdentifier would be drawn near the symbol of the ConceptualObject. A separate table would list the LocalNoteIdentifier and NoteText attributes of all Notes on the diagram.
Multiplicity: 0..1
Type: NullableString
Implementation in Proteus Schema
The attribute is implemented as a DEXPI generic attribute for string values.
RDL reference: LOCAL NOTE IDENTIFIER ASSIGNMENT CLASS
Name: LocalNoteIdentifierAssignmentClass
Example
“42” (String)
Implementation in Proteus Schema
<Note
ID="note1"
ComponentClass="Note"
ComponentClassURI="http://sandbox.dexpi.org/rdl/Note" ...>
...
<GenericAttributes Set="DexpiAttributes" ...>
<GenericAttribute
Name="LocalNoteIdentifierAssignmentClass"
AttributeURI="http://sandbox.dexpi.org/rdl/LocalNoteIdentifierAssignmentClass"
Format="string"
Value="42" />
...
</GenericAttributes>
...
</Note>
NoteClassification¶
Attribute (data)
A textual classification of the Note.
Multiplicity: 0..1
Type: NullableString
Implementation in Proteus Schema
The attribute is implemented as a DEXPI generic attribute for string values.
RDL reference: NOTE CLASSIFICATION ASSIGNMENT CLASS
Name: NoteClassificationAssignmentClass
Example
“operational requirement” (String)
Implementation in Proteus Schema
<Note
ID="note1"
ComponentClass="Note"
ComponentClassURI="http://sandbox.dexpi.org/rdl/Note" ...>
...
<GenericAttributes Set="DexpiAttributes" ...>
<GenericAttribute
Name="NoteClassificationAssignmentClass"
AttributeURI="http://sandbox.dexpi.org/rdl/NoteClassificationAssignmentClass"
Format="string"
Value="operational requirement" />
...
</GenericAttributes>
...
</Note>
NoteRegistrationNumber¶
Attribute (data)
A registration number of the Note
Multiplicity: 0..1
Type: NullableString
Implementation in Proteus Schema
The attribute is implemented as a DEXPI generic attribute for string values.
RDL reference: NOTE REGISTRATION NUMBER ASSIGNMENT CLASS
Name: NoteRegistrationNumberAssignmentClass
Example
“XY-42-1” (String)
Implementation in Proteus Schema
<Note
ID="note1"
ComponentClass="Note"
ComponentClassURI="http://sandbox.dexpi.org/rdl/Note" ...>
...
<GenericAttributes Set="DexpiAttributes" ...>
<GenericAttribute
Name="NoteRegistrationNumberAssignmentClass"
AttributeURI="http://sandbox.dexpi.org/rdl/NoteRegistrationNumberAssignmentClass"
Format="string"
Value="XY-42-1" />
...
</GenericAttributes>
...
</Note>
NoteText¶
Attribute (data)
The text of the Note.
Multiplicity: 0..1
Type: MultiLanguageString
Implementation in Proteus Schema
The attribute is implemented as a set of DEXPI generic attributes for multi-language string values.
RDL reference: NOTE TEXT ASSIGNMENT CLASS
Name: NoteTextAssignmentClass
AttributeURI: http://sandbox.dexpi.org/rdl/NoteTextAssignmentClass
Example
Language |
Value |
---|---|
en |
Water outlet is elevated to reduce sand entrainment. |
(MultiLanguageString with 1 SingleLanguageString)
Implementation in Proteus Schema
<Note
ID="note1"
ComponentClass="Note"
ComponentClassURI="http://sandbox.dexpi.org/rdl/Note" ...>
...
<GenericAttributes Set="DexpiAttributes" ...>
<GenericAttribute
Name="NoteTextAssignmentClass"
AttributeURI="http://sandbox.dexpi.org/rdl/NoteTextAssignmentClass"
Format="string"
Language="en"
Value="Water outlet is elevated to reduce sand entrainment." />
...
</GenericAttributes>
...
</Note>