TextDiagramObject
A diagram object for placing free-text or text derived from an associated domain object.
Type |
Class |
---|---|
URI |
|
CIM standard (perspective) |
IEC61970 (Grid) |
Slots
Name | Cardinality | Type | Description |
---|---|---|---|
1 |
Dataset containing the data objects. |
||
0..1 |
The text that is displayed by this text diagram object. |
||
0..1 |
A diagram object is part of a diagram. |
||
0..1 |
A diagram object has a style associated that provides a reference for the style used in the originating system. |
||
0..1 |
The domain object to which this diagram object is associated. |
||
0..1 |
The single CIM data object in the appropriate dataset context. |
||
0..1 |
The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy. The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time. |
||
0..1 |
The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy. |
||
0..1 |
The drawing order of this element. The higher the number, the later the element is drawn in sequence. This is used to ensure that elements that overlap are rendered in the correct order. |
||
0..1 |
Defines whether or not the diagram objects points define the boundaries of a polygon or the routing of a polyline. If this value is true then a receiving application should consider the first and last points to be connected. |
||
0..1 |
Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended. For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements. |
||
0..1 |
The name is any free human readable and possibly non unique text naming the object. |
||
0..1 |
The offset in the X direction. This is used for defining the offset from centre for rendering an icon (the default is that a single point specifies the centre of the icon). The offset is in per-unit with 0 indicating there is no offset from the horizontal centre of the icon. -0.5 indicates it is offset by 50% to the left and 0.5 indicates an offset of 50% to the right. |
||
0..1 |
The offset in the Y direction. This is used for defining the offset from centre for rendering an icon (the default is that a single point specifies the centre of the icon). The offset is in per-unit with 0 indicating there is no offset from the vertical centre of the icon. The offset direction is dependent on the orientation of the diagram, with -0.5 and 0.5 indicating an offset of +/- 50% on the vertical axis. |
||
0..1 |
Sets the angle of rotation of the diagram object. Zero degrees is pointing to the top of the diagram. Rotation is clockwise. DiagramObject.rotation=0 has the following meaning: The connection point of an element which has one terminal is pointing to the top side of the diagram. The connection point "From side" of an element which has more than one terminal is pointing to the top side of the diagram. DiagramObject.rotation=90 has the following meaning: The connection point of an element which has one terminal is pointing to the right hand side of the diagram. The connection point "From side" of an element which has more than one terminal is pointing to the right hand side of the diagram. |
||
0..* |
A diagram object can have 0 or more points to reflect its layout position, routing (for polylines) or boundary (for polygons). |
||
0..* |
The diagram objects that are associated with the domain object. |
||
0..* |
All names of this identified object. |
||
0..* |
Data objects registered. |
||
0..* |
A diagram object can be part of multiple visibility layers. |
aliasName
The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy. The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.
URI |
|
---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
description
The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.
URI |
|
---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
Diagram
A diagram object is part of a diagram.
URI |
|
---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
DiagramObjectPoints
A diagram object can have 0 or more points to reflect its layout position, routing (for polylines) or boundary (for polygons).
URI |
|
---|---|
Cardinality |
0..* |
Type |
|
Inherited from |
DiagramObjects
The diagram objects that are associated with the domain object.
URI |
|
---|---|
Cardinality |
0..* |
Type |
|
Inherited from |
DiagramObjectStyle
A diagram object has a style associated that provides a reference for the style used in the originating system.
URI |
|
---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
drawingOrder
The drawing order of this element. The higher the number, the later the element is drawn in sequence. This is used to ensure that elements that overlap are rendered in the correct order.
URI |
|
---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
IdentifiedObject
The domain object to which this diagram object is associated.
URI |
|
---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
InstanceSet
Dataset containing the data objects.
URI |
|
---|---|
Cardinality |
1 |
Type |
|
Inherited from |
isPolygon
Defines whether or not the diagram objects points define the boundaries of a polygon or the routing of a polyline. If this value is true then a receiving application should consider the first and last points to be connected.
URI |
|
---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
mRID
Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended. For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.
URI |
|
---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
name
The name is any free human readable and possibly non unique text naming the object.
URI |
|
---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
Names
All names of this identified object.
URI |
|
---|---|
Cardinality |
0..* |
Type |
|
Inherited from |
offsetX
+++The offset in the X direction. This is used for defining the offset from centre for rendering an icon (the default is that a single point specifies the centre of the icon).
The offset is in per-unit with 0 indicating there is no offset from the horizontal centre of the icon. -0.5 indicates it is offset by 50% to the left and 0.5 indicates an offset of 50% to the right.+
URI |
|
---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
offsetY
+++The offset in the Y direction. This is used for defining the offset from centre for rendering an icon (the default is that a single point specifies the centre of the icon).
The offset is in per-unit with 0 indicating there is no offset from the vertical centre of the icon. The offset direction is dependent on the orientation of the diagram, with -0.5 and 0.5 indicating an offset of /- 50% on the vertical axis.++
URI |
|
---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
PropertiesCIMDataObject
The single CIM data object in the appropriate dataset context.
URI |
|
---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
rotation
Sets the angle of rotation of the diagram object. Zero degrees is pointing to the top of the diagram. Rotation is clockwise. DiagramObject.rotation=0 has the following meaning: The connection point of an element which has one terminal is pointing to the top side of the diagram. The connection point "From side" of an element which has more than one terminal is pointing to the top side of the diagram. DiagramObject.rotation=90 has the following meaning: The connection point of an element which has one terminal is pointing to the right hand side of the diagram. The connection point "From side" of an element which has more than one terminal is pointing to the right hand side of the diagram.
URI |
|
---|---|
Cardinality |
0..1 |
Type |
|
Inherited from |
TargetingCIMDataObject
Data objects registered.
URI |
|
---|---|
Cardinality |
0..* |
Type |
|
Inherited from |
text
The text that is displayed by this text diagram object.
URI |
|
---|---|
Cardinality |
0..1 |
Type |