Class: Command

A Command is a discrete control used for supervisory control.

 classDiagram
    class Command
      Control <|-- Command

      Command : alias_name

      Command : bilateral_to_iopoint

          Command --> ProvidedBilateralPoint : bilateral_to_iopoint

      Command : control_action

          Command --> ControlAction : control_action

      Command : control_type

      Command : description

      Command : diagram_objects

          Command --> DiagramObject : diagram_objects

      Command : discrete_value

          Command --> DiscreteValue : discrete_value

      Command : instance_set

          Command --> InstanceSet : instance_set

      Command : iopoint_source

          Command --> IOPointSource : iopoint_source

      Command : m_rid

      Command : names

          Command --> Name : names

      Command : normal_value

      Command : operation_in_progress

      Command : power_system_resource

          Command --> PowerSystemResource : power_system_resource

      Command : properties_cimdata_object

          Command --> ChangeSetMember : properties_cimdata_object

      Command : remote_control

          Command --> RemoteControl : remote_control

      Command : targeting_cimdata_object

          Command --> ChangeSetMember : targeting_cimdata_object

      Command : time_stamp

      Command : unit_multiplier

          Command --> UnitMultiplier : unit_multiplier

      Command : unit_symbol

          Command --> UnitSymbol : unit_symbol

      Command : value

      Command : value_alias_set

          Command --> ValueAliasSet : value_alias_set

Inheritance

IdentifiedObject
- IOPoint
  - Control
    - Command

Slots

Name	Cardinality and Range	Description	Inheritance
normal_value	0..1 Integer	Normal value for Control	direct
value	0..1 Integer	The value representing the actuator output	direct
value_alias_set	0..1 ValueAliasSet	The ValueAliasSet used for translation of a Control value to a name	direct
discrete_value	1..1 DiscreteValue	The MeasurementValue that is controlled	direct
control_type	0..1 String	Specifies the type of Control	Control
operation_in_progress	0..1 Boolean	Indicates that a client is currently sending control commands that has not co...	Control
time_stamp	0..1 date	The last time a control output was sent	Control
unit_multiplier	0..1 UnitMultiplier	The unit multiplier of the controlled quantity	Control
unit_symbol	0..1 UnitSymbol	The unit of measure of the controlled quantity	Control
remote_control	0..1 RemoteControl	The remote point controlling the physical actuator	Control
power_system_resource	0..1 PowerSystemResource	Regulating device governed by this control output	Control
control_action	0..1 ControlAction	The control action that is performed on the control	Control
bilateral_to_iopoint	0..* ProvidedBilateralPoint	Bilateral ICCP point for the measurement or control	IOPoint
iopoint_source	0..1 IOPointSource	Local merasurement value source for an ICCP point	IOPoint
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
ValueAliasSet	commands	range	Command
DiscreteValue	command	range	Command

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Command
description: A Command is a discrete control used for supervisory control.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Control
attributes:
  normal_value:
    name: normal_value
    description: "Normal value for Control.value e.g. used for percentage scaling.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Command.normalValue
    multivalued: false
    domain_of:
    - Analog
    - Discrete
    - Command
    - ActivePowerLimit
    - ApparentPowerLimit
    - CurrentLimit
    - VoltageLimit
    - SetPoint
    range: integer
    required: false
  value:
    name: value
    description: "The value representing the actuator output.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Command.value
    multivalued: false
    domain_of:
    - VoltagePerReactivePower
    - Length
    - ConductancePerLength
    - VolumeFlowRate
    - Volume
    - Voltage
    - Temperature
    - Admittance
    - Impedance
    - CostPerVolume
    - SusceptancePerLength
    - Money
    - Minutes
    - FloatQuantity
    - CostPerEnergyUnit
    - PerCent
    - IntegerQuantity
    - ApparentPower
    - WaterLevel
    - Displacement
    - Damping
    - Seconds
    - ResistancePerLength
    - Inductance
    - AngleDegrees
    - CostRate
    - Speed
    - Capacitance
    - PU
    - Pressure
    - KiloActivePower
    - ReactivePower
    - StringQuantity
    - ActivePowerChangeRate
    - Hours
    - Conductance
    - RotationSpeed
    - CurrentFlow
    - Frequency
    - AngleRadians
    - ActivePower
    - ReactancePerLength
    - Resistance
    - Reactance
    - Susceptance
    - RealEnergy
    - Classification
    - HeatRate
    - Emission
    - CostPerHeatUnit
    - ActivePowerPerFrequency
    - InductancePerLength
    - CapacitancePerLength
    - DecimalQuantity
    - Area
    - ActivePowerPerCurrentFlow
    - Mass
    - Status
    - UserAttribute
    - AccountingUnit
    - BaseReading
    - EndDeviceEventDetail
    - MeterMultiplier
    - RegularTimePoint
    - AnalogValue
    - AnalogLimit
    - CommodityPrice
    - ChargeProfileData
    - StringMeasurementValue
    - Command
    - DiscreteValue
    - ValueToAlias
    - ServiceMultiplier
    - AnalyticScore
    - IrregularTimePoint
    - ActivePowerLimit
    - ApparentPowerLimit
    - CurrentLimit
    - VoltageLimit
    - AccumulatorValue
    - AccumulatorLimit
    - SetPoint
    - ScheduledActivePowerLimitValue
    - ScheduledApparentPowerLimitValue
    - ScheduledCurrentLimitValue
    - ScheduledVoltageLimitValue
    - MagneticField
    - ParticulateDensity
    - Bearing
    - PumpingShutDownCostSchedule
    - PumpingLevelSchedule
    - HourlyPreDispatchSchedule
    - PumpingCostSchedule
    - OpenTieSchedule
    - WheelingReferenceSchedule
    range: integer
    required: false
  value_alias_set:
    name: value_alias_set
    description: The ValueAliasSet used for translation of a Control value to a name.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Command.ValueAliasSet
    multivalued: false
    domain_of:
    - Discrete
    - Command
    - RaiseLowerCommand
    - ValueToAlias
    range: ValueAliasSet
    required: false
  discrete_value:
    name: discrete_value
    description: The MeasurementValue that is controlled.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Command.DiscreteValue
    multivalued: false
    domain_of:
    - ControlAction
    - Command
    range: DiscreteValue
    required: true
class_uri: cim:Command

Induced

name: Command
description: A Command is a discrete control used for supervisory control.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Control
attributes:
  normal_value:
    name: normal_value
    description: "Normal value for Control.value e.g. used for percentage scaling.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Command.normalValue
    multivalued: false
    alias: normal_value
    owner: Command
    domain_of:
    - Analog
    - Discrete
    - Command
    - ActivePowerLimit
    - ApparentPowerLimit
    - CurrentLimit
    - VoltageLimit
    - SetPoint
    range: integer
    required: false
  value:
    name: value
    description: "The value representing the actuator output.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Command.value
    multivalued: false
    alias: value
    owner: Command
    domain_of:
    - VoltagePerReactivePower
    - Length
    - ConductancePerLength
    - VolumeFlowRate
    - Volume
    - Voltage
    - Temperature
    - Admittance
    - Impedance
    - CostPerVolume
    - SusceptancePerLength
    - Money
    - Minutes
    - FloatQuantity
    - CostPerEnergyUnit
    - PerCent
    - IntegerQuantity
    - ApparentPower
    - WaterLevel
    - Displacement
    - Damping
    - Seconds
    - ResistancePerLength
    - Inductance
    - AngleDegrees
    - CostRate
    - Speed
    - Capacitance
    - PU
    - Pressure
    - KiloActivePower
    - ReactivePower
    - StringQuantity
    - ActivePowerChangeRate
    - Hours
    - Conductance
    - RotationSpeed
    - CurrentFlow
    - Frequency
    - AngleRadians
    - ActivePower
    - ReactancePerLength
    - Resistance
    - Reactance
    - Susceptance
    - RealEnergy
    - Classification
    - HeatRate
    - Emission
    - CostPerHeatUnit
    - ActivePowerPerFrequency
    - InductancePerLength
    - CapacitancePerLength
    - DecimalQuantity
    - Area
    - ActivePowerPerCurrentFlow
    - Mass
    - Status
    - UserAttribute
    - AccountingUnit
    - BaseReading
    - EndDeviceEventDetail
    - MeterMultiplier
    - RegularTimePoint
    - AnalogValue
    - AnalogLimit
    - CommodityPrice
    - ChargeProfileData
    - StringMeasurementValue
    - Command
    - DiscreteValue
    - ValueToAlias
    - ServiceMultiplier
    - AnalyticScore
    - IrregularTimePoint
    - ActivePowerLimit
    - ApparentPowerLimit
    - CurrentLimit
    - VoltageLimit
    - AccumulatorValue
    - AccumulatorLimit
    - SetPoint
    - ScheduledActivePowerLimitValue
    - ScheduledApparentPowerLimitValue
    - ScheduledCurrentLimitValue
    - ScheduledVoltageLimitValue
    - MagneticField
    - ParticulateDensity
    - Bearing
    - PumpingShutDownCostSchedule
    - PumpingLevelSchedule
    - HourlyPreDispatchSchedule
    - PumpingCostSchedule
    - OpenTieSchedule
    - WheelingReferenceSchedule
    range: integer
    required: false
  value_alias_set:
    name: value_alias_set
    description: The ValueAliasSet used for translation of a Control value to a name.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Command.ValueAliasSet
    multivalued: false
    alias: value_alias_set
    owner: Command
    domain_of:
    - Discrete
    - Command
    - RaiseLowerCommand
    - ValueToAlias
    range: ValueAliasSet
    required: false
  discrete_value:
    name: discrete_value
    description: The MeasurementValue that is controlled.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Command.DiscreteValue
    multivalued: false
    alias: discrete_value
    owner: Command
    domain_of:
    - ControlAction
    - Command
    range: DiscreteValue
    required: true
  control_type:
    name: control_type
    description: Specifies the type of Control. For example, this specifies if the
      Control represents BreakerOpen, BreakerClose, GeneratorVoltageSetPoint, GeneratorRaise,
      GeneratorLower, etc.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Control.controlType
    multivalued: false
    alias: control_type
    owner: Command
    domain_of:
    - Control
    range: string
    required: false
  operation_in_progress:
    name: operation_in_progress
    description: "Indicates that a client is currently sending control commands that\
      \ has not completed.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Control.operationInProgress
    multivalued: false
    alias: operation_in_progress
    owner: Command
    domain_of:
    - Control
    range: boolean
    required: false
  time_stamp:
    name: time_stamp
    description: "The last time a control output was sent.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Control.timeStamp
    multivalued: false
    alias: time_stamp
    owner: Command
    domain_of:
    - NetworkModelProjectChangeVersion
    - MeasurementValue
    - ReadingQuality
    - DERCurveData
    - Control
    - ChargeProfileData
    - SCADAInformation
    range: date
    required: false
  unit_multiplier:
    name: unit_multiplier
    description: The unit multiplier of the controlled quantity.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Control.unitMultiplier
    multivalued: false
    alias: unit_multiplier
    owner: Command
    domain_of:
    - Measurement
    - ProtectionEquipment
    - Control
    range: UnitMultiplier
    required: false
  unit_symbol:
    name: unit_symbol
    description: The unit of measure of the controlled quantity.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Control.unitSymbol
    multivalued: false
    alias: unit_symbol
    owner: Command
    domain_of:
    - Measurement
    - ProtectionEquipment
    - Control
    - ResourceCapacity
    range: UnitSymbol
    required: false
  remote_control:
    name: remote_control
    description: The remote point controlling the physical actuator.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Control.RemoteControl
    multivalued: false
    alias: remote_control
    owner: Command
    domain_of:
    - Control
    range: RemoteControl
    required: false
  power_system_resource:
    name: power_system_resource
    description: Regulating device governed by this control output.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Control.PowerSystemResource
    multivalued: false
    alias: power_system_resource
    owner: Command
    domain_of:
    - ReportingGroup
    - Measurement
    - ConfigurationEvent
    - Control
    - OperationalTag
    - OperatingShare
    - VerificationAction
    - GenericAction
    - PSREvent
    range: PowerSystemResource
    required: false
  control_action:
    name: control_action
    description: The control action that is performed on the control
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Control.ControlAction
    multivalued: false
    alias: control_action
    owner: Command
    domain_of:
    - Control
    range: ControlAction
    required: false
  bilateral_to_iopoint:
    name: bilateral_to_iopoint
    description: Bilateral ICCP point for the measurement or control.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IOPoint.BilateralToIOPoint
    multivalued: true
    alias: bilateral_to_iopoint
    owner: Command
    domain_of:
    - IOPoint
    range: ProvidedBilateralPoint
    required: false
  iopoint_source:
    name: iopoint_source
    description: Local merasurement value source for an ICCP point.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IOPoint.IOPointSource
    multivalued: false
    alias: iopoint_source
    owner: Command
    domain_of:
    - IOPoint
    range: IOPointSource
    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: Command
    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: Command
    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: Command
    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: Command
    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: Command
    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: Command
    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: Command
    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: Command
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:Command