Class: DispatchInstReply

_Response from registered resource acknowledging receipt of dispatch instructions. _

__

 classDiagram
    class DispatchInstReply
      IdentifiedObject <|-- DispatchInstReply

      DispatchInstReply : accept_mw

          DispatchInstReply --> ActivePower : accept_mw

      DispatchInstReply : accept_status

          DispatchInstReply --> DispatchResponseType : accept_status

      DispatchInstReply : alias_name

      DispatchInstReply : certification_name

      DispatchInstReply : cleared_mw

          DispatchInstReply --> ActivePower : cleared_mw

      DispatchInstReply : description

      DispatchInstReply : diagram_objects

          DispatchInstReply --> DiagramObject : diagram_objects

      DispatchInstReply : instance_set

          DispatchInstReply --> InstanceSet : instance_set

      DispatchInstReply : instruction_time

      DispatchInstReply : instruction_type

      DispatchInstReply : m_rid

      DispatchInstReply : names

          DispatchInstReply --> Name : names

      DispatchInstReply : pass_indicator

          DispatchInstReply --> PassIndicatorType : pass_indicator

      DispatchInstReply : properties_cimdata_object

          DispatchInstReply --> ChangeSetMember : properties_cimdata_object

      DispatchInstReply : received_time

      DispatchInstReply : registered_resource

          DispatchInstReply --> RegisteredResource : registered_resource

      DispatchInstReply : start_time

      DispatchInstReply : targeting_cimdata_object

          DispatchInstReply --> ChangeSetMember : targeting_cimdata_object

Inheritance

IdentifiedObject
- DispatchInstReply

Slots

Name	Cardinality and Range	Description	Inheritance
accept_mw	0..1 ActivePower	The accepted mw amount by the responder	direct
accept_status	0..1 DispatchResponseType	The accept status submitted by the responder	direct
certification_name	0..1 String	The Subject DN is the X509 Certificate Subject DN	direct
cleared_mw	0..1 ActivePower	MW amount associated with instruction	direct
instruction_time	0..1 date	The target date/time for the received instruction	direct
instruction_type	0..1 String	instruction type:
direct
pass_indicator	0..1 PassIndicatorType	The type of run for the market clearing	direct
received_time	0..1 date	Timestamp indicating the time at which the instruction was received	direct
start_time	0..1 date	start time
direct
registered_resource	1..1 RegisteredResource		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
RegisteredResource	dispatch_inst_reply	range	DispatchInstReply
RegisteredGenerator	dispatch_inst_reply	range	DispatchInstReply
RegisteredInterTie	dispatch_inst_reply	range	DispatchInstReply
RegisteredLoad	dispatch_inst_reply	range	DispatchInstReply
CombinedCycleConfiguration	dispatch_inst_reply	range	DispatchInstReply
RegisteredDistributedResource	dispatch_inst_reply	range	DispatchInstReply

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: DispatchInstReply
description: "Response from registered resource acknowledging receipt of dispatch\
  \ instructions.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  accept_mw:
    name: accept_mw
    description: "The accepted mw amount by the responder. aka response mw.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DispatchInstReply.acceptMW
    multivalued: false
    domain_of:
    - InterTieDispatchResponse
    - DispatchInstReply
    range: ActivePower
    required: false
  accept_status:
    name: accept_status
    description: The accept status submitted by the responder. enumeration type needs
      to be defined
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DispatchInstReply.acceptStatus
    multivalued: false
    domain_of:
    - InterTieDispatchResponse
    - ResourceDeploymentStatus
    - DispatchInstReply
    range: DispatchResponseType
    required: false
  certification_name:
    name: certification_name
    description: "The Subject DN is the X509 Certificate Subject DN. This is the essentially\
      \ the certificate name presented by the client. In the case of ADS Certificates,\
      \ this will be the user name. It may be from an API Client or the MP Client\
      \ (GUI).\r\n\r\nThe Subject ID normally includes more than just the user name\
      \ (Common Name), it can also contain information such as City, Company ID, etc.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:DispatchInstReply.certificationName
    multivalued: false
    domain_of:
    - DispatchInstReply
    range: string
    required: false
  cleared_mw:
    name: cleared_mw
    description: "MW amount associated with instruction.  For 5 minute binding dispatches,\
      \ this is the Goto MW or DOT\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DispatchInstReply.clearedMW
    multivalued: false
    domain_of:
    - TransactionBidResults
    - InterTieDispatchResponse
    - MarketRegionResults
    - ResourceAwardInstruction
    - DispatchInstReply
    range: ActivePower
    required: false
  instruction_time:
    name: instruction_time
    description: "The target date/time for the received instruction.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DispatchInstReply.instructionTime
    multivalued: false
    domain_of:
    - DotInstruction
    - DispatchInstReply
    range: date
    required: false
  instruction_type:
    name: instruction_type
    description: "instruction type:\r\n\r\ncommitment\r\nout of sequence\r\ndispatch\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DispatchInstReply.instructionType
    multivalued: false
    domain_of:
    - Instructions
    - Commitments
    - DispatchInstReply
    range: string
    required: false
  pass_indicator:
    name: pass_indicator
    description: "The type of run for the market clearing.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DispatchInstReply.passIndicator
    multivalued: false
    domain_of:
    - InterTieDispatchResponse
    - DispatchInstReply
    range: PassIndicatorType
    required: false
  received_time:
    name: received_time
    description: "Timestamp indicating the time at which the instruction was received.\
      \  \r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:DispatchInstReply.receivedTime
    multivalued: false
    domain_of:
    - DispatchInstReply
    range: date
    required: false
  start_time:
    name: start_time
    description: "start time\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DispatchInstReply.startTime
    multivalued: false
    domain_of:
    - TimeTariffInterval
    - DispatchSchedule
    - BasicIntervalSchedule
    - Bid
    - Trade
    - BidError
    - InterTieDispatchResponse
    - TradeError
    - LoadFollowingInst
    - DispatchInstReply
    range: date
    required: false
  registered_resource:
    name: registered_resource
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DispatchInstReply.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: RegisteredResource
    required: true
class_uri: cim:DispatchInstReply

Induced

name: DispatchInstReply
description: "Response from registered resource acknowledging receipt of dispatch\
  \ instructions.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  accept_mw:
    name: accept_mw
    description: "The accepted mw amount by the responder. aka response mw.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DispatchInstReply.acceptMW
    multivalued: false
    alias: accept_mw
    owner: DispatchInstReply
    domain_of:
    - InterTieDispatchResponse
    - DispatchInstReply
    range: ActivePower
    required: false
  accept_status:
    name: accept_status
    description: The accept status submitted by the responder. enumeration type needs
      to be defined
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DispatchInstReply.acceptStatus
    multivalued: false
    alias: accept_status
    owner: DispatchInstReply
    domain_of:
    - InterTieDispatchResponse
    - ResourceDeploymentStatus
    - DispatchInstReply
    range: DispatchResponseType
    required: false
  certification_name:
    name: certification_name
    description: "The Subject DN is the X509 Certificate Subject DN. This is the essentially\
      \ the certificate name presented by the client. In the case of ADS Certificates,\
      \ this will be the user name. It may be from an API Client or the MP Client\
      \ (GUI).\r\n\r\nThe Subject ID normally includes more than just the user name\
      \ (Common Name), it can also contain information such as City, Company ID, etc.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:DispatchInstReply.certificationName
    multivalued: false
    alias: certification_name
    owner: DispatchInstReply
    domain_of:
    - DispatchInstReply
    range: string
    required: false
  cleared_mw:
    name: cleared_mw
    description: "MW amount associated with instruction.  For 5 minute binding dispatches,\
      \ this is the Goto MW or DOT\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DispatchInstReply.clearedMW
    multivalued: false
    alias: cleared_mw
    owner: DispatchInstReply
    domain_of:
    - TransactionBidResults
    - InterTieDispatchResponse
    - MarketRegionResults
    - ResourceAwardInstruction
    - DispatchInstReply
    range: ActivePower
    required: false
  instruction_time:
    name: instruction_time
    description: "The target date/time for the received instruction.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DispatchInstReply.instructionTime
    multivalued: false
    alias: instruction_time
    owner: DispatchInstReply
    domain_of:
    - DotInstruction
    - DispatchInstReply
    range: date
    required: false
  instruction_type:
    name: instruction_type
    description: "instruction type:\r\n\r\ncommitment\r\nout of sequence\r\ndispatch\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DispatchInstReply.instructionType
    multivalued: false
    alias: instruction_type
    owner: DispatchInstReply
    domain_of:
    - Instructions
    - Commitments
    - DispatchInstReply
    range: string
    required: false
  pass_indicator:
    name: pass_indicator
    description: "The type of run for the market clearing.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DispatchInstReply.passIndicator
    multivalued: false
    alias: pass_indicator
    owner: DispatchInstReply
    domain_of:
    - InterTieDispatchResponse
    - DispatchInstReply
    range: PassIndicatorType
    required: false
  received_time:
    name: received_time
    description: "Timestamp indicating the time at which the instruction was received.\
      \  \r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:DispatchInstReply.receivedTime
    multivalued: false
    alias: received_time
    owner: DispatchInstReply
    domain_of:
    - DispatchInstReply
    range: date
    required: false
  start_time:
    name: start_time
    description: "start time\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DispatchInstReply.startTime
    multivalued: false
    alias: start_time
    owner: DispatchInstReply
    domain_of:
    - TimeTariffInterval
    - DispatchSchedule
    - BasicIntervalSchedule
    - Bid
    - Trade
    - BidError
    - InterTieDispatchResponse
    - TradeError
    - LoadFollowingInst
    - DispatchInstReply
    range: date
    required: false
  registered_resource:
    name: registered_resource
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DispatchInstReply.RegisteredResource
    multivalued: false
    alias: registered_resource
    owner: DispatchInstReply
    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: RegisteredResource
    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: DispatchInstReply
    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: DispatchInstReply
    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: DispatchInstReply
    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: DispatchInstReply
    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: DispatchInstReply
    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: DispatchInstReply
    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: DispatchInstReply
    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: DispatchInstReply
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:DispatchInstReply