Skip to content

Class: UsagePointGroup

_Abstraction for management of group communications within a two-way AMR system or the data for a group of related usage points. Commands can be issued to all of the usage points that belong to a usage point group using a defined group address and the underlying AMR communication infrastructure. _

__

URI: cim:UsagePointGroup

 classDiagram
    class UsagePointGroup
      IdentifiedObject <|-- UsagePointGroup

      UsagePointGroup : alias_name

      UsagePointGroup : demand_response_programs

          UsagePointGroup --> DemandResponseProgram : demand_response_programs

      UsagePointGroup : description

      UsagePointGroup : diagram_objects

          UsagePointGroup --> DiagramObject : diagram_objects

      UsagePointGroup : end_device_controls

          UsagePointGroup --> EndDeviceControl : end_device_controls

      UsagePointGroup : instance_set

          UsagePointGroup --> InstanceSet : instance_set

      UsagePointGroup : m_rid

      UsagePointGroup : meter_read_schedule

          UsagePointGroup --> MeterReadSchedule : meter_read_schedule

      UsagePointGroup : names

          UsagePointGroup --> Name : names

      UsagePointGroup : properties_cimdata_object

          UsagePointGroup --> ChangeSetMember : properties_cimdata_object

      UsagePointGroup : targeting_cimdata_object

          UsagePointGroup --> ChangeSetMember : targeting_cimdata_object

      UsagePointGroup : type

      UsagePointGroup : usage_points

          UsagePointGroup --> UsagePoint : usage_points

Inheritance

Slots

Name Cardinality and Range Description Inheritance
type 0..1
String		 Type of this group direct
usage_points 0..*
UsagePoint		 All usage points in this group direct
demand_response_programs 0..*
DemandResponseProgram		 All demand response programs this usage point group is enrolled in direct
meter_read_schedule 0..1
MeterReadSchedule		 Meter read schedule that applies to the usage point group direct
end_device_controls 0..*
EndDeviceControl		 All end device controls sending commands to this usage point group 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
MeterReadSchedule usage_point_group range UsagePointGroup
UsagePoint usage_point_groups range UsagePointGroup
EndDeviceControl usage_point_groups range UsagePointGroup
DemandResponseProgram usage_point_groups range UsagePointGroup
MarketEvaluationPoint usage_point_groups range UsagePointGroup

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: UsagePointGroup
description: "Abstraction for management of group communications within a two-way\
  \ AMR system or the data for a group of related usage points. Commands can be issued\
  \ to all of the usage points that belong to a usage point group using a defined\
  \ group address and the underlying AMR communication infrastructure. \r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  type:
    name: type
    description: Type of this group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:UsagePointGroup.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
  usage_points:
    name: usage_points
    description: All usage points in this group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:UsagePointGroup.UsagePoints
    multivalued: true
    domain_of:
    - Equipment
    - CustomerAgreement
    - ServiceCategory
    - PricingStructure
    - EndDeviceControl
    - UsagePointGroup
    - ServiceLocation
    - MetrologyRequirement
    - ServiceSupplier
    - UsagePointLocation
    range: UsagePoint
    required: false
  demand_response_programs:
    name: demand_response_programs
    description: All demand response programs this usage point group is enrolled in.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:UsagePointGroup.DemandResponsePrograms
    multivalued: true
    domain_of:
    - CustomerAgreement
    - EndDeviceGroup
    - UsagePointGroup
    range: DemandResponseProgram
    required: false
  meter_read_schedule:
    name: meter_read_schedule
    description: Meter read schedule that applies to the usage point group
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:UsagePointGroup.MeterReadSchedule
    multivalued: false
    domain_of:
    - TimeSchedule
    - UsagePoint
    - CustomerAgreement
    - CustomerAccount
    - ReadingType
    - EndDevice
    - EndDeviceGroup
    - UsagePointGroup
    range: MeterReadSchedule
    required: false
  end_device_controls:
    name: end_device_controls
    description: All end device controls sending commands to this usage point group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:UsagePointGroup.EndDeviceControls
    multivalued: true
    domain_of:
    - UsagePoint
    - EndDevice
    - EndDeviceGroup
    - UsagePointGroup
    - EndDeviceControlType
    range: EndDeviceControl
    required: false
class_uri: cim:UsagePointGroup

Induced

name: UsagePointGroup
description: "Abstraction for management of group communications within a two-way\
  \ AMR system or the data for a group of related usage points. Commands can be issued\
  \ to all of the usage points that belong to a usage point group using a defined\
  \ group address and the underlying AMR communication infrastructure. \r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  type:
    name: type
    description: Type of this group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:UsagePointGroup.type
    multivalued: false
    alias: type
    owner: UsagePointGroup
    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
  usage_points:
    name: usage_points
    description: All usage points in this group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:UsagePointGroup.UsagePoints
    multivalued: true
    alias: usage_points
    owner: UsagePointGroup
    domain_of:
    - Equipment
    - CustomerAgreement
    - ServiceCategory
    - PricingStructure
    - EndDeviceControl
    - UsagePointGroup
    - ServiceLocation
    - MetrologyRequirement
    - ServiceSupplier
    - UsagePointLocation
    range: UsagePoint
    required: false
  demand_response_programs:
    name: demand_response_programs
    description: All demand response programs this usage point group is enrolled in.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:UsagePointGroup.DemandResponsePrograms
    multivalued: true
    alias: demand_response_programs
    owner: UsagePointGroup
    domain_of:
    - CustomerAgreement
    - EndDeviceGroup
    - UsagePointGroup
    range: DemandResponseProgram
    required: false
  meter_read_schedule:
    name: meter_read_schedule
    description: Meter read schedule that applies to the usage point group
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:UsagePointGroup.MeterReadSchedule
    multivalued: false
    alias: meter_read_schedule
    owner: UsagePointGroup
    domain_of:
    - TimeSchedule
    - UsagePoint
    - CustomerAgreement
    - CustomerAccount
    - ReadingType
    - EndDevice
    - EndDeviceGroup
    - UsagePointGroup
    range: MeterReadSchedule
    required: false
  end_device_controls:
    name: end_device_controls
    description: All end device controls sending commands to this usage point group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:UsagePointGroup.EndDeviceControls
    multivalued: true
    alias: end_device_controls
    owner: UsagePointGroup
    domain_of:
    - UsagePoint
    - EndDevice
    - EndDeviceGroup
    - UsagePointGroup
    - EndDeviceControlType
    range: EndDeviceControl
    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: UsagePointGroup
    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: UsagePointGroup
    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: UsagePointGroup
    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: UsagePointGroup
    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: UsagePointGroup
    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: UsagePointGroup
    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: UsagePointGroup
    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: UsagePointGroup
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:UsagePointGroup