Skip to content

Class: ResponseMethod

Specifies a category of energy usage that the demand response applies for; e.g. energy from lighting, HVAC, other.

URI: cim:ResponseMethod

 classDiagram
    class ResponseMethod
      IdentifiedObject <|-- ResponseMethod

      ResponseMethod : active_power

      ResponseMethod : active_power_uom

      ResponseMethod : alias_name

      ResponseMethod : description

      ResponseMethod : diagram_objects

          ResponseMethod --> DiagramObject : diagram_objects

      ResponseMethod : instance_set

          ResponseMethod --> InstanceSet : instance_set

      ResponseMethod : m_rid

      ResponseMethod : method

      ResponseMethod : names

          ResponseMethod --> Name : names

      ResponseMethod : properties_cimdata_object

          ResponseMethod --> ChangeSetMember : properties_cimdata_object

      ResponseMethod : registered_resource

          ResponseMethod --> RegisteredDistributedResource : registered_resource

      ResponseMethod : site_multiplier

      ResponseMethod : targeting_cimdata_object

          ResponseMethod --> ChangeSetMember : targeting_cimdata_object

Inheritance

Slots

Name Cardinality and Range Description Inheritance
active_power 0..1
Float		 The active power value for the demand adjustment type direct
active_power_uom 0..1
String		 The unit of measure of active power, e direct
method 0..1
String		 The response method (e direct
site_multiplier 0..1
Integer		 This value provides for scaling of a response method's active power direct
registered_resource 1..1
RegisteredDistributedResource		 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
RegisteredDistributedResource response_methods range ResponseMethod

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: ResponseMethod
description: Specifies a category of energy usage that the demand response applies
  for; e.g. energy from lighting, HVAC, other.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  active_power:
    name: active_power
    description: The active power value for the demand adjustment type. This supports
      requests to be made to a resource for some amount of active power provided by
      a particular response method, as specified by the method attribute (e.g. lighting,
      HVAC, wall mounted air conditioners, etc.).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ResponseMethod.activePower
    multivalued: false
    domain_of:
    - EnergySource
    - ResponseMethod
    range: float
    required: false
  active_power_uom:
    name: active_power_uom
    description: The unit of measure of active power, e.g. kiloWatts (kW), megaWatts
      (mW), etc.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ResponseMethod.activePowerUOM
    multivalued: false
    domain_of:
    - ResponseMethod
    range: string
    required: false
  method:
    name: method
    description: The response method (e.g. lighting, HVAC, wall mounted air conditioners,
      etc.).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ResponseMethod.method
    multivalued: false
    domain_of:
    - ResponseMethod
    range: string
    required: false
  site_multiplier:
    name: site_multiplier
    description: This value provides for scaling of a response method's active power.
      For example, a response method of air conditioning could utilize a small amount
      of active power from each air conditioning unit (e.g. 0.1 kiloWatt), but the
      site multiplier could be used to produce a the total active power adjustment
      by multiplying the response method active power by this value (e.g. a building
      with 100 window air conditioning  units, so 100 * 0.1 kW = 10 kW).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ResponseMethod.siteMultiplier
    multivalued: false
    domain_of:
    - ResponseMethod
    range: integer
    required: false
  registered_resource:
    name: registered_resource
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ResponseMethod.RegisteredResource
    multivalued: false
    domain_of:
    - TimeSeries
    - Reason
    - DotInstruction
    - MarketParticipant
    - MPMResourceStatus
    - MPMTestThreshold
    - SubControlArea
    - AdjacentCASet
    - HostControlArea
    - RampRateCurve
    - SchedulingPoint
    - ResourceVerifiableCosts
    - ContractDistributionFactor
    - SubstitutionResourceList
    - MktConnectivityNode
    - AggregateNode
    - Instructions
    - ControlAreaDesignation
    - ResourceAwardInstruction
    - RUCAwardInstruction
    - Domain
    - ExPostResourceResults
    - LoadFollowingOperatorInput
    - MarketObjectStatus
    - DefaultBid
    - ResourceCertification
    - FormerReference
    - IntermittentResourceEligibility
    - ResourceCapacity
    - ExpectedEnergyValues
    - ResourceLoadFollowingInst
    - ResourceDispatchResults
    - LoadFollowingInst
    - AllocationResultValues
    - Commitments
    - RMROperatorInput
    - OrgResOwnership
    - DispatchInstReply
    - ForbiddenRegion
    - ResourcePerformanceRating
    - ResponseMethod
    range: RegisteredDistributedResource
    required: true
class_uri: cim:ResponseMethod

Induced

name: ResponseMethod
description: Specifies a category of energy usage that the demand response applies
  for; e.g. energy from lighting, HVAC, other.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  active_power:
    name: active_power
    description: The active power value for the demand adjustment type. This supports
      requests to be made to a resource for some amount of active power provided by
      a particular response method, as specified by the method attribute (e.g. lighting,
      HVAC, wall mounted air conditioners, etc.).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ResponseMethod.activePower
    multivalued: false
    alias: active_power
    owner: ResponseMethod
    domain_of:
    - EnergySource
    - ResponseMethod
    range: float
    required: false
  active_power_uom:
    name: active_power_uom
    description: The unit of measure of active power, e.g. kiloWatts (kW), megaWatts
      (mW), etc.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ResponseMethod.activePowerUOM
    multivalued: false
    alias: active_power_uom
    owner: ResponseMethod
    domain_of:
    - ResponseMethod
    range: string
    required: false
  method:
    name: method
    description: The response method (e.g. lighting, HVAC, wall mounted air conditioners,
      etc.).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ResponseMethod.method
    multivalued: false
    alias: method
    owner: ResponseMethod
    domain_of:
    - ResponseMethod
    range: string
    required: false
  site_multiplier:
    name: site_multiplier
    description: This value provides for scaling of a response method's active power.
      For example, a response method of air conditioning could utilize a small amount
      of active power from each air conditioning unit (e.g. 0.1 kiloWatt), but the
      site multiplier could be used to produce a the total active power adjustment
      by multiplying the response method active power by this value (e.g. a building
      with 100 window air conditioning  units, so 100 * 0.1 kW = 10 kW).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ResponseMethod.siteMultiplier
    multivalued: false
    alias: site_multiplier
    owner: ResponseMethod
    domain_of:
    - ResponseMethod
    range: integer
    required: false
  registered_resource:
    name: registered_resource
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ResponseMethod.RegisteredResource
    multivalued: false
    alias: registered_resource
    owner: ResponseMethod
    domain_of:
    - TimeSeries
    - Reason
    - DotInstruction
    - MarketParticipant
    - MPMResourceStatus
    - MPMTestThreshold
    - SubControlArea
    - AdjacentCASet
    - HostControlArea
    - RampRateCurve
    - SchedulingPoint
    - ResourceVerifiableCosts
    - ContractDistributionFactor
    - SubstitutionResourceList
    - MktConnectivityNode
    - AggregateNode
    - Instructions
    - ControlAreaDesignation
    - ResourceAwardInstruction
    - RUCAwardInstruction
    - Domain
    - ExPostResourceResults
    - LoadFollowingOperatorInput
    - MarketObjectStatus
    - DefaultBid
    - ResourceCertification
    - FormerReference
    - IntermittentResourceEligibility
    - ResourceCapacity
    - ExpectedEnergyValues
    - ResourceLoadFollowingInst
    - ResourceDispatchResults
    - LoadFollowingInst
    - AllocationResultValues
    - Commitments
    - RMROperatorInput
    - OrgResOwnership
    - DispatchInstReply
    - ForbiddenRegion
    - ResourcePerformanceRating
    - ResponseMethod
    range: RegisteredDistributedResource
    required: true
  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: ResponseMethod
    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: ResponseMethod
    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: ResponseMethod
    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: ResponseMethod
    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: ResponseMethod
    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: ResponseMethod
    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: ResponseMethod
    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: ResponseMethod
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:ResponseMethod