Skip to content

Class: DemandResponseProgram

Demand response program.

URI: cim:DemandResponseProgram

 classDiagram
    class DemandResponseProgram
      IdentifiedObject <|-- DemandResponseProgram

      DemandResponseProgram : alias_name

      DemandResponseProgram : customer_agreements

          DemandResponseProgram --> CustomerAgreement : customer_agreements

      DemandResponseProgram : description

      DemandResponseProgram : diagram_objects

          DemandResponseProgram --> DiagramObject : diagram_objects

      DemandResponseProgram : end_device_groups

          DemandResponseProgram --> EndDeviceGroup : end_device_groups

      DemandResponseProgram : instance_set

          DemandResponseProgram --> InstanceSet : instance_set

      DemandResponseProgram : m_rid

      DemandResponseProgram : names

          DemandResponseProgram --> Name : names

      DemandResponseProgram : properties_cimdata_object

          DemandResponseProgram --> ChangeSetMember : properties_cimdata_object

      DemandResponseProgram : targeting_cimdata_object

          DemandResponseProgram --> ChangeSetMember : targeting_cimdata_object

      DemandResponseProgram : type

      DemandResponseProgram : usage_point_groups

          DemandResponseProgram --> UsagePointGroup : usage_point_groups

      DemandResponseProgram : validity_interval

          DemandResponseProgram --> DateTimeInterval : validity_interval

Inheritance

Slots

Name Cardinality and Range Description Inheritance
type 0..1
String		 Type of demand response program; examples are CPP (critical-peak pricing), RT... direct
validity_interval 0..1
DateTimeInterval		 Interval within which the program is valid direct
end_device_groups 0..*
EndDeviceGroup		 All groups of end devices enrolled in this demand response program direct
usage_point_groups 0..*
UsagePointGroup		 All usage point groups enrolled in this demand response program direct
customer_agreements 0..*
CustomerAgreement		 All customer agreements through which the customer is enrolled in this demand... 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
CustomerAgreement demand_response_programs range DemandResponseProgram
EndDeviceGroup demand_response_programs range DemandResponseProgram
UsagePointGroup demand_response_programs range DemandResponseProgram

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: DemandResponseProgram
description: Demand response program.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  type:
    name: type
    description: Type of demand response program; examples are CPP (critical-peak
      pricing), RTP (real-time pricing), DLC (direct load control), DBP (demand bidding
      program), BIP (base interruptible program). Note that possible types change
      a lot and it would be impossible to enumerate them all.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DemandResponseProgram.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
  validity_interval:
    name: validity_interval
    description: Interval within which the program is valid.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DemandResponseProgram.validityInterval
    multivalued: false
    domain_of:
    - Agreement
    - Capability
    - DemandResponseProgram
    - ShiftPattern
    range: DateTimeInterval
    required: false
  end_device_groups:
    name: end_device_groups
    description: All groups of end devices enrolled in this demand response program.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DemandResponseProgram.EndDeviceGroups
    multivalued: true
    domain_of:
    - EndDevice
    - EndDeviceControl
    - DemandResponseProgram
    range: EndDeviceGroup
    required: false
  usage_point_groups:
    name: usage_point_groups
    description: All usage point groups enrolled in this demand response program.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DemandResponseProgram.UsagePointGroups
    multivalued: true
    domain_of:
    - UsagePoint
    - EndDeviceControl
    - DemandResponseProgram
    range: UsagePointGroup
    required: false
  customer_agreements:
    name: customer_agreements
    description: All customer agreements through which the customer is enrolled in
      this demand response program.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DemandResponseProgram.CustomerAgreements
    multivalued: true
    domain_of:
    - Customer
    - CustomerAccount
    - ServiceCategory
    - PricingStructure
    - DemandResponseProgram
    - ServiceLocation
    - ServiceSupplier
    - StandardIndustryCode
    range: CustomerAgreement
    required: false
class_uri: cim:DemandResponseProgram

Induced

name: DemandResponseProgram
description: Demand response program.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  type:
    name: type
    description: Type of demand response program; examples are CPP (critical-peak
      pricing), RTP (real-time pricing), DLC (direct load control), DBP (demand bidding
      program), BIP (base interruptible program). Note that possible types change
      a lot and it would be impossible to enumerate them all.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DemandResponseProgram.type
    multivalued: false
    alias: type
    owner: DemandResponseProgram
    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
  validity_interval:
    name: validity_interval
    description: Interval within which the program is valid.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DemandResponseProgram.validityInterval
    multivalued: false
    alias: validity_interval
    owner: DemandResponseProgram
    domain_of:
    - Agreement
    - Capability
    - DemandResponseProgram
    - ShiftPattern
    range: DateTimeInterval
    required: false
  end_device_groups:
    name: end_device_groups
    description: All groups of end devices enrolled in this demand response program.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DemandResponseProgram.EndDeviceGroups
    multivalued: true
    alias: end_device_groups
    owner: DemandResponseProgram
    domain_of:
    - EndDevice
    - EndDeviceControl
    - DemandResponseProgram
    range: EndDeviceGroup
    required: false
  usage_point_groups:
    name: usage_point_groups
    description: All usage point groups enrolled in this demand response program.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DemandResponseProgram.UsagePointGroups
    multivalued: true
    alias: usage_point_groups
    owner: DemandResponseProgram
    domain_of:
    - UsagePoint
    - EndDeviceControl
    - DemandResponseProgram
    range: UsagePointGroup
    required: false
  customer_agreements:
    name: customer_agreements
    description: All customer agreements through which the customer is enrolled in
      this demand response program.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DemandResponseProgram.CustomerAgreements
    multivalued: true
    alias: customer_agreements
    owner: DemandResponseProgram
    domain_of:
    - Customer
    - CustomerAccount
    - ServiceCategory
    - PricingStructure
    - DemandResponseProgram
    - ServiceLocation
    - ServiceSupplier
    - StandardIndustryCode
    range: CustomerAgreement
    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: DemandResponseProgram
    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: DemandResponseProgram
    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: DemandResponseProgram
    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: DemandResponseProgram
    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: DemandResponseProgram
    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: DemandResponseProgram
    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: DemandResponseProgram
    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: DemandResponseProgram
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:DemandResponseProgram