Skip to content

Class: EndDeviceControlType

Detailed description for a control produced by an end device. Values in attributes allow for creation of recommended codes to be used for identifying end device controls as follows: ....

URI: cim:EndDeviceControlType

 classDiagram
    class EndDeviceControlType
      IdentifiedObject <|-- EndDeviceControlType

      EndDeviceControlType : alias_name

      EndDeviceControlType : description

      EndDeviceControlType : diagram_objects

          EndDeviceControlType --> DiagramObject : diagram_objects

      EndDeviceControlType : domain

      EndDeviceControlType : end_device_controls

          EndDeviceControlType --> EndDeviceControl : end_device_controls

      EndDeviceControlType : event_or_action

      EndDeviceControlType : instance_set

          EndDeviceControlType --> InstanceSet : instance_set

      EndDeviceControlType : m_rid

      EndDeviceControlType : names

          EndDeviceControlType --> Name : names

      EndDeviceControlType : properties_cimdata_object

          EndDeviceControlType --> ChangeSetMember : properties_cimdata_object

      EndDeviceControlType : sub_domain

      EndDeviceControlType : targeting_cimdata_object

          EndDeviceControlType --> ChangeSetMember : targeting_cimdata_object

      EndDeviceControlType : type

Inheritance

Slots

Name Cardinality and Range Description Inheritance
domain 0..1
String		 High-level nature of the control direct
event_or_action 0..1
String		 The most specific part of this control type direct
sub_domain 0..1
String		 More specific nature of the control, as a further sub-categorisation of 'doma... direct
type 0..1
String		 Type of physical device from which the control was created direct
end_device_controls 0..*
EndDeviceControl		 All end device controls of this type direct
alias_name 0..1
String		 The aliasName is free text human readable name of the object alternative to I... IdentifiedObject
description 0..1
String		 The description is a free human readable text describing or naming the object IdentifiedObject
m_rid 0..1
String		 Master resource identifier issued by a model authority IdentifiedObject
diagram_objects 0..*
DiagramObject		 The diagram objects that are associated with the domain object IdentifiedObject
instance_set 1..1
InstanceSet		 Dataset containing the data objects IdentifiedObject
names 0..*
Name		 All names of this identified object IdentifiedObject
properties_cimdata_object 0..1
ChangeSetMember		 The single CIM data object in the appropriate dataset context IdentifiedObject
targeting_cimdata_object 0..*
ChangeSetMember		 Data objects registered IdentifiedObject

Usages

used by used in type used
EndDeviceControl end_device_control_type range EndDeviceControlType

Identifier and Mapping Information

Schema Source

  • from schema: https://cim.ucaiug.io/ns#TC57CIM

Mappings

Mapping Type Mapped Value
self cim:EndDeviceControlType
native cim:EndDeviceControlType

LinkML Source

Direct

name: EndDeviceControlType
description: 'Detailed description for a control produced by an end device. Values
  in attributes allow for creation of recommended codes to be used for identifying
  end device controls as follows: <type>.<domain>.<subDomain>.<eventOrAction>.'
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  domain:
    name: domain
    description: "High-level nature of the control.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControlType.domain
    multivalued: false
    domain_of:
    - EndDeviceEventType
    - EndDeviceControlType
    - TimeSeries
    - MarketDocument
    - RegisteredResource
    - Quantity
    - Price
    range: string
    required: false
  event_or_action:
    name: event_or_action
    description: "The most specific part of this control type. It is mainly in the\
      \ form of a verb that gives action to the control that just occurred.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControlType.eventOrAction
    multivalued: false
    domain_of:
    - EndDeviceEventType
    - EndDeviceControlType
    range: string
    required: false
  sub_domain:
    name: sub_domain
    description: "More specific nature of the control, as a further sub-categorisation\
      \ of 'domain'.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControlType.subDomain
    multivalued: false
    domain_of:
    - EndDeviceEventType
    - EndDeviceControlType
    range: string
    required: false
  type:
    name: type
    description: "Type of physical device from which the control was created. A value\
      \ of zero (0) can be used when the source is unknown.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControlType.type
    multivalued: false
    domain_of:
    - Asset
    - AcceptanceTest
    - Document
    - StreetDetail
    - Location
    - Priority
    - CatalogAssetType
    - Capability
    - Craft
    - OldPerson
    - Role
    - ActivityRecord
    - EndDeviceEventType
    - EndDeviceGroup
    - DemandResponseProgram
    - UsagePointGroup
    - EndDeviceControlType
    - Hazard
    - OldCrew
    - Route
    - ConstraintDuration
    - AceTariffType
    - ControlArea
    - SynchronousMachine
    - ChargeProfile
    - ChargeComponent
    - MarketRole
    - ResourceGroup
    - Quantity
    - ResourceCertification
    - Auction
    - ScheduledEvent
    - PotentialTransformer
    - BusinessRole
    range: string
    required: false
  end_device_controls:
    name: end_device_controls
    description: All end device controls of this type.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControlType.EndDeviceControls
    multivalued: true
    domain_of:
    - UsagePoint
    - EndDevice
    - EndDeviceGroup
    - UsagePointGroup
    - EndDeviceControlType
    range: EndDeviceControl
    required: false
class_uri: cim:EndDeviceControlType

Induced

name: EndDeviceControlType
description: 'Detailed description for a control produced by an end device. Values
  in attributes allow for creation of recommended codes to be used for identifying
  end device controls as follows: <type>.<domain>.<subDomain>.<eventOrAction>.'
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  domain:
    name: domain
    description: "High-level nature of the control.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControlType.domain
    multivalued: false
    alias: domain
    owner: EndDeviceControlType
    domain_of:
    - EndDeviceEventType
    - EndDeviceControlType
    - TimeSeries
    - MarketDocument
    - RegisteredResource
    - Quantity
    - Price
    range: string
    required: false
  event_or_action:
    name: event_or_action
    description: "The most specific part of this control type. It is mainly in the\
      \ form of a verb that gives action to the control that just occurred.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControlType.eventOrAction
    multivalued: false
    alias: event_or_action
    owner: EndDeviceControlType
    domain_of:
    - EndDeviceEventType
    - EndDeviceControlType
    range: string
    required: false
  sub_domain:
    name: sub_domain
    description: "More specific nature of the control, as a further sub-categorisation\
      \ of 'domain'.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControlType.subDomain
    multivalued: false
    alias: sub_domain
    owner: EndDeviceControlType
    domain_of:
    - EndDeviceEventType
    - EndDeviceControlType
    range: string
    required: false
  type:
    name: type
    description: "Type of physical device from which the control was created. A value\
      \ of zero (0) can be used when the source is unknown.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControlType.type
    multivalued: false
    alias: type
    owner: EndDeviceControlType
    domain_of:
    - Asset
    - AcceptanceTest
    - Document
    - StreetDetail
    - Location
    - Priority
    - CatalogAssetType
    - Capability
    - Craft
    - OldPerson
    - Role
    - ActivityRecord
    - EndDeviceEventType
    - EndDeviceGroup
    - DemandResponseProgram
    - UsagePointGroup
    - EndDeviceControlType
    - Hazard
    - OldCrew
    - Route
    - ConstraintDuration
    - AceTariffType
    - ControlArea
    - SynchronousMachine
    - ChargeProfile
    - ChargeComponent
    - MarketRole
    - ResourceGroup
    - Quantity
    - ResourceCertification
    - Auction
    - ScheduledEvent
    - PotentialTransformer
    - BusinessRole
    range: string
    required: false
  end_device_controls:
    name: end_device_controls
    description: All end device controls of this type.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceControlType.EndDeviceControls
    multivalued: true
    alias: end_device_controls
    owner: EndDeviceControlType
    domain_of:
    - UsagePoint
    - EndDevice
    - EndDeviceGroup
    - UsagePointGroup
    - EndDeviceControlType
    range: EndDeviceControl
    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: EndDeviceControlType
    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: EndDeviceControlType
    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: EndDeviceControlType
    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: EndDeviceControlType
    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: EndDeviceControlType
    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: EndDeviceControlType
    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: EndDeviceControlType
    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: EndDeviceControlType
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:EndDeviceControlType