Skip to content

Class: SetPoint

An analog control that issues a set point value.

URI: cim:SetPoint

 classDiagram
    class SetPoint
      AnalogControl <|-- SetPoint

      SetPoint : alias_name

      SetPoint : analog_value

          SetPoint --> AnalogValue : analog_value

      SetPoint : bilateral_to_iopoint

          SetPoint --> ProvidedBilateralPoint : bilateral_to_iopoint

      SetPoint : control_action

          SetPoint --> ControlAction : control_action

      SetPoint : control_type

      SetPoint : description

      SetPoint : diagram_objects

          SetPoint --> DiagramObject : diagram_objects

      SetPoint : instance_set

          SetPoint --> InstanceSet : instance_set

      SetPoint : iopoint_source

          SetPoint --> IOPointSource : iopoint_source

      SetPoint : m_rid

      SetPoint : max_value

      SetPoint : min_value

      SetPoint : names

          SetPoint --> Name : names

      SetPoint : normal_value

      SetPoint : operation_in_progress

      SetPoint : power_system_resource

          SetPoint --> PowerSystemResource : power_system_resource

      SetPoint : properties_cimdata_object

          SetPoint --> ChangeSetMember : properties_cimdata_object

      SetPoint : remote_control

          SetPoint --> RemoteControl : remote_control

      SetPoint : targeting_cimdata_object

          SetPoint --> ChangeSetMember : targeting_cimdata_object

      SetPoint : time_stamp

      SetPoint : unit_multiplier

          SetPoint --> UnitMultiplier : unit_multiplier

      SetPoint : unit_symbol

          SetPoint --> UnitSymbol : unit_symbol

      SetPoint : value

Inheritance

Slots

Name Cardinality and Range Description Inheritance
normal_value 0..1
Float		 Normal value for Control direct
value 0..1
Float		 The value representing the actuator output direct
max_value 0..1
Float		 Normal value range maximum for any of the Control AnalogControl
min_value 0..1
Float		 Normal value range minimum for any of the Control AnalogControl
analog_value 1..1
AnalogValue		 The MeasurementValue that is controlled AnalogControl
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

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: SetPoint
description: An analog control that issues a set point value.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: AnalogControl
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:SetPoint.normalValue
    multivalued: false
    domain_of:
    - Analog
    - Discrete
    - Command
    - ActivePowerLimit
    - ApparentPowerLimit
    - CurrentLimit
    - VoltageLimit
    - SetPoint
    range: float
    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:SetPoint.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: float
    required: false
class_uri: cim:SetPoint

Induced

name: SetPoint
description: An analog control that issues a set point value.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: AnalogControl
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:SetPoint.normalValue
    multivalued: false
    alias: normal_value
    owner: SetPoint
    domain_of:
    - Analog
    - Discrete
    - Command
    - ActivePowerLimit
    - ApparentPowerLimit
    - CurrentLimit
    - VoltageLimit
    - SetPoint
    range: float
    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:SetPoint.value
    multivalued: false
    alias: value
    owner: SetPoint
    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: float
    required: false
  max_value:
    name: max_value
    description: Normal value range maximum for any of the Control.value. Used for
      scaling, e.g. in bar graphs.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:AnalogControl.maxValue
    multivalued: false
    alias: max_value
    owner: SetPoint
    domain_of:
    - Analog
    - AnalogControl
    - Discrete
    - Accumulator
    range: float
    required: false
  min_value:
    name: min_value
    description: Normal value range minimum for any of the Control.value. Used for
      scaling, e.g. in bar graphs.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:AnalogControl.minValue
    multivalued: false
    alias: min_value
    owner: SetPoint
    domain_of:
    - Analog
    - AnalogControl
    - Discrete
    range: float
    required: false
  analog_value:
    name: analog_value
    description: The MeasurementValue that is controlled.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:AnalogControl.AnalogValue
    multivalued: false
    alias: analog_value
    owner: SetPoint
    domain_of:
    - AltGeneratingUnitMeas
    - AltTieMeas
    - AnalogControl
    - ControlAction
    range: AnalogValue
    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: SetPoint
    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: SetPoint
    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: SetPoint
    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: SetPoint
    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: SetPoint
    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: SetPoint
    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: SetPoint
    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: SetPoint
    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: SetPoint
    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: SetPoint
    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: SetPoint
    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: SetPoint
    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: SetPoint
    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: SetPoint
    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: SetPoint
    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: SetPoint
    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: SetPoint
    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: SetPoint
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:SetPoint