Class: TextDiagramObject

name: TextDiagramObject
description: A diagram object for placing free-text or text derived from an associated
  domain object.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: DiagramObject
attributes:
  text:
    name: text
    description: "The text that is displayed by this text diagram object.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TextDiagramObject.text
    multivalued: false
    domain_of:
    - Reason
    - TextDiagramObject
    range: string
    required: false
class_uri: cim:TextDiagramObject

name: TextDiagramObject
description: A diagram object for placing free-text or text derived from an associated
  domain object.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: DiagramObject
attributes:
  text:
    name: text
    description: "The text that is displayed by this text diagram object.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:TextDiagramObject.text
    multivalued: false
    alias: text
    owner: TextDiagramObject
    domain_of:
    - Reason
    - TextDiagramObject
    range: string
    required: false
  drawing_order:
    name: drawing_order
    description: 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.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:DiagramObject.drawingOrder
    multivalued: false
    alias: drawing_order
    owner: TextDiagramObject
    domain_of:
    - DiagramObject
    - VisibilityLayer
    range: integer
    required: false
  is_polygon:
    name: is_polygon
    description: 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.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:DiagramObject.isPolygon
    multivalued: false
    alias: is_polygon
    owner: TextDiagramObject
    domain_of:
    - DiagramObject
    range: boolean
    required: false
  offset_x:
    name: offset_x
    description: "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).\r\n\r\nThe 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.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:DiagramObject.offsetX
    multivalued: false
    alias: offset_x
    owner: TextDiagramObject
    domain_of:
    - DiagramObject
    range: float
    required: false
  offset_y:
    name: offset_y
    description: "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).\r\n\r\nThe 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.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:DiagramObject.offsetY
    multivalued: false
    alias: offset_y
    owner: TextDiagramObject
    domain_of:
    - DiagramObject
    range: float
    required: false
  rotation:
    name: rotation
    description: "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.\r\nDiagramObject.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."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:DiagramObject.rotation
    multivalued: false
    alias: rotation
    owner: TextDiagramObject
    domain_of:
    - DiagramObject
    range: AngleDegrees
    required: false
  diagram:
    name: diagram
    description: A diagram object is part of a diagram.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:DiagramObject.Diagram
    multivalued: false
    alias: diagram
    owner: TextDiagramObject
    domain_of:
    - DiagramObject
    - DiagramStyle
    range: Diagram
    required: false
  visibility_layers:
    name: visibility_layers
    description: A diagram object can be part of multiple visibility layers.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:DiagramObject.VisibilityLayers
    multivalued: true
    alias: visibility_layers
    owner: TextDiagramObject
    domain_of:
    - DiagramObject
    range: VisibilityLayer
    required: false
  diagram_object_points:
    name: diagram_object_points
    description: A diagram object can have 0 or more points to reflect its layout
      position, routing (for polylines) or boundary (for polygons).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:DiagramObject.DiagramObjectPoints
    multivalued: true
    alias: diagram_object_points
    owner: TextDiagramObject
    domain_of:
    - DiagramObject
    - DiagramObjectGluePoint
    range: DiagramObjectPoint
    required: false
  diagram_object_style:
    name: diagram_object_style
    description: A diagram object has a style associated that provides a reference
      for the style used in the originating system.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:DiagramObject.DiagramObjectStyle
    multivalued: false
    alias: diagram_object_style
    owner: TextDiagramObject
    domain_of:
    - DiagramObject
    range: DiagramObjectStyle
    required: false
  identified_object:
    name: identified_object
    description: The domain object to which this diagram object is associated.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DiagramObject.IdentifiedObject
    multivalued: false
    alias: identified_object
    owner: TextDiagramObject
    domain_of:
    - Name
    - DiagramObject
    range: IdentifiedObject
    required: false
  alias_name:
    name: alias_name
    description: "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.\r\nThe 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.\r\
      \n\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.aliasName
    multivalued: false
    alias: alias_name
    owner: TextDiagramObject
    domain_of:
    - IdentifiedObject
    range: string
    required: false
  description:
    name: description
    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.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.description
    multivalued: false
    alias: description
    owner: TextDiagramObject
    domain_of:
    - IdentifiedObject
    - NameType
    - NameTypeAuthority
    - DataSet
    - SwitchingStepGroup
    - AreaReserveSpec
    range: string
    required: false
  m_rid:
    name: m_rid
    description: "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.\r\nFor 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."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.mRID
    multivalued: false
    alias: m_rid
    owner: TextDiagramObject
    domain_of:
    - IdentifiedObject
    - DataSet
    range: string
    required: false
  diagram_objects:
    name: diagram_objects
    description: The diagram objects that are associated with the domain object.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.DiagramObjects
    multivalued: true
    alias: diagram_objects
    owner: TextDiagramObject
    domain_of:
    - IdentifiedObject
    range: DiagramObject
    required: false
  instance_set:
    name: instance_set
    description: Dataset containing the data objects.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.InstanceSet
    multivalued: false
    alias: instance_set
    owner: TextDiagramObject
    domain_of:
    - IdentifiedObject
    range: InstanceSet
    required: true
  names:
    name: names
    description: All names of this identified object.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.Names
    multivalued: true
    alias: names
    owner: TextDiagramObject
    domain_of:
    - IdentifiedObject
    - NameType
    range: Name
    required: false
  properties_cimdata_object:
    name: properties_cimdata_object
    description: The single CIM data object in the appropriate dataset context.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.PropertiesCIMDataObject
    multivalued: false
    alias: properties_cimdata_object
    owner: TextDiagramObject
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
  targeting_cimdata_object:
    name: targeting_cimdata_object
    description: Data objects registered.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.TargetingCIMDataObject
    multivalued: true
    alias: targeting_cimdata_object
    owner: TextDiagramObject
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:TextDiagramObject