TextDiagramObject

A diagram object for placing free-text or text derived from an associated domain object.

Type

Class

URI

cim:TextDiagramObject

CIM standard (perspective)

IEC61970 (Grid)

Class hierarchy

Slots

Associated classes
Figure 1. Associated classes
Name Cardinality Type Description

InstanceSet

1

InstanceSet

Dataset containing the data objects.

text

0..1

string

The text that is displayed by this text diagram object.

Diagram

0..1

Diagram

A diagram object is part of a diagram.

DiagramObjectStyle

0..1

DiagramObjectStyle

A diagram object has a style associated that provides a reference for the style used in the originating system.

IdentifiedObject

0..1

IdentifiedObject

The domain object to which this diagram object is associated.

PropertiesCIMDataObject

0..1

ChangeSetMember

The single CIM data object in the appropriate dataset context.

aliasName

0..1

string

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.

description

0..1

string

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.

drawingOrder

0..1

integer

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.

isPolygon

0..1

boolean

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.

mRID

0..1

string

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.

name

0..1

string

The name is any free human readable and possibly non unique text naming the object.

offsetX

0..1

float

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.

offsetY

0..1

float

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.

rotation

0..1

AngleDegrees

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.

DiagramObjectPoints

0..*

DiagramObjectPoint

A diagram object can have 0 or more points to reflect its layout position, routing (for polylines) or boundary (for polygons).

DiagramObjects

0..*

DiagramObject

The diagram objects that are associated with the domain object.

Names

0..*

Name

All names of this identified object.

TargetingCIMDataObject

0..*

ChangeSetMember

Data objects registered.

VisibilityLayers

0..*

VisibilityLayer

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

cim:IdentifiedObject.aliasName

Cardinality

0..1

Type

string

Inherited from

IdentifiedObject

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

cim:IdentifiedObject.description

Cardinality

0..1

Type

string

Inherited from

IdentifiedObject

Diagram

A diagram object is part of a diagram.

URI

cim:DiagramObject.Diagram

Cardinality

0..1

Type

Diagram

Inherited from

DiagramObject

DiagramObjectPoints

A diagram object can have 0 or more points to reflect its layout position, routing (for polylines) or boundary (for polygons).

URI

cim:DiagramObject.DiagramObjectPoints

Cardinality

0..*

Type

DiagramObjectPoint

Inherited from

DiagramObject

DiagramObjects

The diagram objects that are associated with the domain object.

URI

cim:IdentifiedObject.DiagramObjects

Cardinality

0..*

Type

DiagramObject

Inherited from

IdentifiedObject

DiagramObjectStyle

A diagram object has a style associated that provides a reference for the style used in the originating system.

URI

cim:DiagramObject.DiagramObjectStyle

Cardinality

0..1

Type

DiagramObjectStyle

Inherited from

DiagramObject

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

cim:DiagramObject.drawingOrder

Cardinality

0..1

Type

integer

Inherited from

DiagramObject

IdentifiedObject

The domain object to which this diagram object is associated.

URI

cim:DiagramObject.IdentifiedObject

Cardinality

0..1

Type

IdentifiedObject

Inherited from

DiagramObject

InstanceSet

Dataset containing the data objects.

URI

cim:IdentifiedObject.InstanceSet

Cardinality

1

Type

InstanceSet

Inherited from

IdentifiedObject

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

cim:DiagramObject.isPolygon

Cardinality

0..1

Type

boolean

Inherited from

DiagramObject

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

cim:IdentifiedObject.mRID

Cardinality

0..1

Type

string

Inherited from

IdentifiedObject

name

The name is any free human readable and possibly non unique text naming the object.

URI

cim:IdentifiedObject.name

Cardinality

0..1

Type

string

Inherited from

IdentifiedObject

Names

All names of this identified object.

URI

cim:IdentifiedObject.Names

Cardinality

0..*

Type

Name

Inherited from

IdentifiedObject

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

cim:DiagramObject.offsetX

Cardinality

0..1

Type

float

Inherited from

DiagramObject

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

cim:DiagramObject.offsetY

Cardinality

0..1

Type

float

Inherited from

DiagramObject

PropertiesCIMDataObject

The single CIM data object in the appropriate dataset context.

URI

cim:IdentifiedObject.PropertiesCIMDataObject

Cardinality

0..1

Type

ChangeSetMember

Inherited from

IdentifiedObject

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

cim:DiagramObject.rotation

Cardinality

0..1

Type

AngleDegrees

Inherited from

DiagramObject

TargetingCIMDataObject

Data objects registered.

URI

cim:IdentifiedObject.TargetingCIMDataObject

Cardinality

0..*

Type

ChangeSetMember

Inherited from

IdentifiedObject

text

The text that is displayed by this text diagram object.

URI

cim:TextDiagramObject.text

Cardinality

0..1

Type

string

VisibilityLayers

A diagram object can be part of multiple visibility layers.

URI

cim:DiagramObject.VisibilityLayers

Cardinality

0..*

Type

VisibilityLayer

Inherited from

DiagramObject