Note¶

Core::Note

Overview¶

Concrete Class

RDL: NOTE (http://sandbox.dexpi.org/rdl/Note)

A textual annotation about ConceptualObjects. See also ReferencedNotes.

(Fullscreen Diagram)

Supertypes

ConceptualObject

Members¶

Data Properties¶

Name	Multiplicity	Type	Ordered	Unique
LocalNoteIdentifier	0..1	Undefined \| String	no	no	An identifier for the Note in a local context.
NoteClassification	0..1	Undefined \| String	no	no	A textual classification of the Note.
NoteRegistrationNumber	0..1	Undefined \| String	no	no	A registration number of the Note.
NoteText	0..1	MultiLanguageString	no	no	The text of the Note.

LocalNoteIdentifier¶

Data Property

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 and 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.

Type: Undefined | String

Multiplicity: 0..1

Ordered: no

Unique: no

RDL: LOCAL NOTE IDENTIFIER ASSIGNMENT CLASS (http://sandbox.dexpi.org/rdl/LocalNoteIdentifierAssignmentClass)

Example¶

"42"

NoteClassification¶

Data Property

A textual classification of the Note.

Type: Undefined | String

Multiplicity: 0..1

Ordered: no

Unique: no

RDL: NOTE CLASSIFICATION ASSIGNMENT CLASS (http://sandbox.dexpi.org/rdl/NoteClassificationAssignmentClass)

Example¶

"operational requirement"

NoteRegistrationNumber¶

Data Property

A registration number of the Note.

Type: Undefined | String

Multiplicity: 0..1

Ordered: no

Unique: no

RDL: NOTE REGISTRATION NUMBER ASSIGNMENT CLASS (http://sandbox.dexpi.org/rdl/NoteRegistrationNumberAssignmentClass)

Example¶

"XY-42-1"

NoteText¶

Data Property

The text of the Note.

Type: MultiLanguageString

Multiplicity: 0..1

Ordered: no

Unique: no

RDL: NOTE TEXT ASSIGNMENT CLASS (http://sandbox.dexpi.org/rdl/NoteTextAssignmentClass)

Example¶

MultiLanguageString(

SingleLanguageStrings = [

SingleLanguageString(

Language = "en",

Value = "Water outlet is elevated to reduce sand entrainment.")])

Example in DEXPI XML¶

<Object type="Core/Note">
  <Data property="LocalNoteIdentifier">
    <String>42</String>
  </Data>
  <Data property="NoteClassification">
    <String>operational requirement</String>
  </Data>
  <Data property="NoteRegistrationNumber">
    <String>XY-42-1</String>
  </Data>
  <Data property="NoteText">
    <AggregatedDataValue type="Core/DataTypes.MultiLanguageString">
      <Data property="SingleLanguageStrings">
        <AggregatedDataValue type="Core/DataTypes.SingleLanguageString">
          <Data property="Language">
            <String>en</String>
          </Data>
          <Data property="Value">
            <String>Water outlet is elevated to reduce sand entrainment.</String>
          </Data>
        </AggregatedDataValue>
      </Data>
    </AggregatedDataValue>
  </Data>
</Object>