Skip to content

DiagramObject

An object that defines one or more points in a given space. This object can be associated with anything that specializes IdentifiedObject. For single line diagrams such objects typically include such items as analog values, breakers, disconnectors, power transformers, and transmission lines.

URI: cim:DiagramObject
Type: Class

DiagramObject class diagram

Inheritance

Attributes

Name URI Cardinality and Range Inheritance Description
drawingOrder cim:DiagramObject.drawingOrder 0..1 integer direct 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 cim:DiagramObject.isPolygon 0..1 boolean direct 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.
offsetX cim:DiagramObject.offsetX 0..1 float direct 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 cim:DiagramObject.offsetY 0..1 float direct 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 cim:DiagramObject.rotation 0..1 AngleDegrees direct 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.
Diagram cim:DiagramObject.Diagram 1..1 Diagram direct A diagram object is part of a diagram.
DiagramObjectStyle cim:DiagramObject.DiagramObjectStyle 0..1 DiagramObjectStyle direct A diagram object has a style associated that provides a reference for the style used in the originating system.
IdentifiedObject cim:DiagramObject.IdentifiedObject 0..1 IdentifiedObject direct The domain object to which this diagram object is associated.
mRID cim:IdentifiedObject.mRID 1..1 string IdentifiedObject 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.
description cim:IdentifiedObject.description 0..1 string IdentifiedObject 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.
name cim:IdentifiedObject.name 1..1 string IdentifiedObject The name is any free human readable and possibly non unique text naming the object.

Format Examples

{
    "@context": {"rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#", "linkml": "https://w3id.org/linkml/", "sh": "http://www.w3.org/ns/shacl#", "skos": "http://www.w3.org/2004/02/skos/core#", "dc": "http://purl.org/dc/elements/1.1/", "profcim": "http://iec.ch/TC57/ns/CIM/prof-cim#", "owl": "http://www.w3.org/2002/07/owl#", "cim": "http://iec.ch/TC57/CIM100#", "cims": "http://iec.ch/TC57/1999/rdf-schema-extensions-19990926#", "dct": "http://purl.org/dc/terms/", "rdfs": "http://www.w3.org/2000/01/rdf-schema#", "this": "http://ucaiug.org/ns/CGMES/DiagramLayout-EU/3.0#", "dcat": "http://www.w3.org/ns/dcat#", "eu": "http://iec.ch/TC57/CIM100-European#"},
    "@id": "urn:uuid:<uuid>",
    "@type": "cim:DiagramObject",
    "cim:DiagramObject.drawingOrder": "integer",
    "cim:DiagramObject.isPolygon": "boolean",
    "cim:DiagramObject.offsetX": "float",
    "cim:DiagramObject.offsetY": "float",
    "cim:DiagramObject.rotation": "float",
    "cim:DiagramObject.Diagram": { "@id": "urn:uuid:<uuid of Diagram>" },
    "cim:DiagramObject.DiagramObjectStyle": { "@id": "urn:uuid:<uuid of DiagramObjectStyle>" },
    "cim:DiagramObject.IdentifiedObject": { "@id": "urn:uuid:<uuid of IdentifiedObject>" },
    "cim:IdentifiedObject.mRID": "string",
    "cim:IdentifiedObject.description": "string",
    "cim:IdentifiedObject.name": "string"
}

<cim:DiagramObject rdf:ID="_<uuid>">
    <cim:DiagramObject.drawingOrder>integer</cim:DiagramObject.drawingOrder>
    <cim:DiagramObject.isPolygon>boolean</cim:DiagramObject.isPolygon>
    <cim:DiagramObject.offsetX>float</cim:DiagramObject.offsetX>
    <cim:DiagramObject.offsetY>float</cim:DiagramObject.offsetY>
    <cim:DiagramObject.rotation>float</cim:DiagramObject.rotation>
    <cim:DiagramObject.Diagram rdf:resource="#_<uuid of Diagram>" />
    <cim:DiagramObject.DiagramObjectStyle rdf:resource="#_<uuid of DiagramObjectStyle>" />
    <cim:DiagramObject.IdentifiedObject rdf:resource="#_<uuid of IdentifiedObject>" />
    <cim:IdentifiedObject.mRID>string</cim:IdentifiedObject.mRID>
    <cim:IdentifiedObject.description>string</cim:IdentifiedObject.description>
    <cim:IdentifiedObject.name>string</cim:IdentifiedObject.name>
</cim:DiagramObject>

{
    "drawingOrder": "integer",
    "isPolygon": "boolean",
    "offsetX": "float",
    "offsetY": "float",
    "rotation": "float",
    "Diagram": "<Diagram>",
    "DiagramObjectStyle": "<DiagramObjectStyle>",
    "IdentifiedObject": "<IdentifiedObject>",
    "mRID": "string",
    "description": "string",
    "name": "string"
}

<urn:uuid:<graph-id>> {
    <urn:uuid:<uuid>>
        a cim:DiagramObject ;
        cim:DiagramObject.drawingOrder "integer" ;
        cim:DiagramObject.isPolygon "boolean" ;
        cim:DiagramObject.offsetX "float" ;
        cim:DiagramObject.offsetY "float" ;
        cim:DiagramObject.rotation "float" ;
        cim:DiagramObject.Diagram <urn:uuid:<uuid of Diagram>> ;
        cim:DiagramObject.DiagramObjectStyle <urn:uuid:<uuid of DiagramObjectStyle>> ;
        cim:DiagramObject.IdentifiedObject <urn:uuid:<uuid of IdentifiedObject>> ;
        cim:IdentifiedObject.mRID "string" ;
        cim:IdentifiedObject.description "string" ;
        cim:IdentifiedObject.name "string" .
}

Schema Source