Class: Register

_A device that indicates or records units of the commodity or other quantity measured. _

__

 classDiagram
    class Register
      IdentifiedObject <|-- Register

      Register : alias_name

      Register : channels

          Register --> Channel : channels

      Register : description

      Register : diagram_objects

          Register --> DiagramObject : diagram_objects

      Register : end_device_function

          Register --> EndDeviceFunction : end_device_function

      Register : instance_set

          Register --> InstanceSet : instance_set

      Register : is_virtual

      Register : left_digit_count

      Register : m_rid

      Register : names

          Register --> Name : names

      Register : properties_cimdata_object

          Register --> ChangeSetMember : properties_cimdata_object

      Register : right_digit_count

      Register : targeting_cimdata_object

          Register --> ChangeSetMember : targeting_cimdata_object

      Register : tou_tier

          Register --> TimeInterval : tou_tier

      Register : tou_tier_name

      Register : usage_point

          Register --> UsagePoint : usage_point

Inheritance

IdentifiedObject
- Register

Slots

Name	Cardinality and Range	Description	Inheritance
is_virtual	0..1 Boolean	If true, the data it produces is calculated or measured by a device other th...	direct
left_digit_count	0..1 Integer	Number of digits (dials on a mechanical meter) to the left of the decimal pla...	direct
right_digit_count	0..1 Integer	Number of digits (dials on a mechanical meter) to the right of the decimal pl...	direct
tou_tier	0..1 TimeInterval	Clock time interval for register to beging/cease accumulating time of usage (...	direct
tou_tier_name	0..1 String	Name used for the time of use tier (also known as bin or bucket)	direct
channels	0..* Channel	All channels that collect/report values from this register	direct
end_device_function	0..1 EndDeviceFunction	End device function metering quantities displayed by this register	direct
usage_point	0..1 UsagePoint	Usage Point, when metered, has these registers	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
UsagePoint	register	range	Register
EndDeviceFunction	registers	range	Register
Channel	register	range	Register
ConnectDisconnectFunction	registers	range	Register
MarketEvaluationPoint	register	range	Register
ComFunction	registers	range	Register
SimpleEndDeviceFunction	registers	range	Register

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Register
description: "A device that indicates or records units of the commodity or other quantity\
  \ measured.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  is_virtual:
    name: is_virtual
    description: "If true, the data it produces is  calculated or measured by a device\
      \ other than a physical end device/meter. Otherwise, any data streams it produces\
      \ are measured by the hardware of the end device/meter itself. \r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Register.isVirtual
    multivalued: false
    domain_of:
    - UsagePoint
    - EndDevice
    - Register
    - Channel
    range: boolean
    required: false
  left_digit_count:
    name: left_digit_count
    description: "Number of digits (dials on a mechanical meter) to the left of the\
      \ decimal place; default is normally 5.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Register.leftDigitCount
    multivalued: false
    domain_of:
    - Register
    range: integer
    required: false
  right_digit_count:
    name: right_digit_count
    description: Number of digits (dials on a mechanical meter) to the right of the
      decimal place.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Register.rightDigitCount
    multivalued: false
    domain_of:
    - Register
    range: integer
    required: false
  tou_tier:
    name: tou_tier
    description: Clock time interval for register to beging/cease accumulating time
      of usage (e.g., start at 8:00 am, stop at 5:00 pm).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Register.touTier
    multivalued: false
    domain_of:
    - Register
    range: TimeInterval
    required: false
  tou_tier_name:
    name: tou_tier_name
    description: "Name used for the time of use tier (also known as bin or bucket).\
      \  For example, \"peak\", \"off-peak\", \"TOU Category A\", etc. \r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Register.touTierName
    multivalued: false
    domain_of:
    - Register
    range: string
    required: false
  channels:
    name: channels
    description: All channels that collect/report values from this register.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Register.Channels
    multivalued: true
    domain_of:
    - Register
    range: Channel
    required: false
  end_device_function:
    name: end_device_function
    description: End device function metering quantities displayed by this register.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Register.EndDeviceFunction
    multivalued: false
    domain_of:
    - Register
    range: EndDeviceFunction
    required: false
  usage_point:
    name: usage_point
    description: Usage Point, when metered, has these registers.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Register.Usage%20Point
    multivalued: false
    domain_of:
    - MeterReadSchedule
    - MeterReading
    - EndDevice
    - EndDeviceEvent
    - Register
    - MeterWorkTask
    - PlannedOutageNotification
    - EnvironmentalMonitoringStation
    - ServiceMultiplier
    range: UsagePoint
    required: false
class_uri: cim:Register

Induced

name: Register
description: "A device that indicates or records units of the commodity or other quantity\
  \ measured.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  is_virtual:
    name: is_virtual
    description: "If true, the data it produces is  calculated or measured by a device\
      \ other than a physical end device/meter. Otherwise, any data streams it produces\
      \ are measured by the hardware of the end device/meter itself. \r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Register.isVirtual
    multivalued: false
    alias: is_virtual
    owner: Register
    domain_of:
    - UsagePoint
    - EndDevice
    - Register
    - Channel
    range: boolean
    required: false
  left_digit_count:
    name: left_digit_count
    description: "Number of digits (dials on a mechanical meter) to the left of the\
      \ decimal place; default is normally 5.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Register.leftDigitCount
    multivalued: false
    alias: left_digit_count
    owner: Register
    domain_of:
    - Register
    range: integer
    required: false
  right_digit_count:
    name: right_digit_count
    description: Number of digits (dials on a mechanical meter) to the right of the
      decimal place.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Register.rightDigitCount
    multivalued: false
    alias: right_digit_count
    owner: Register
    domain_of:
    - Register
    range: integer
    required: false
  tou_tier:
    name: tou_tier
    description: Clock time interval for register to beging/cease accumulating time
      of usage (e.g., start at 8:00 am, stop at 5:00 pm).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Register.touTier
    multivalued: false
    alias: tou_tier
    owner: Register
    domain_of:
    - Register
    range: TimeInterval
    required: false
  tou_tier_name:
    name: tou_tier_name
    description: "Name used for the time of use tier (also known as bin or bucket).\
      \  For example, \"peak\", \"off-peak\", \"TOU Category A\", etc. \r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Register.touTierName
    multivalued: false
    alias: tou_tier_name
    owner: Register
    domain_of:
    - Register
    range: string
    required: false
  channels:
    name: channels
    description: All channels that collect/report values from this register.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Register.Channels
    multivalued: true
    alias: channels
    owner: Register
    domain_of:
    - Register
    range: Channel
    required: false
  end_device_function:
    name: end_device_function
    description: End device function metering quantities displayed by this register.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Register.EndDeviceFunction
    multivalued: false
    alias: end_device_function
    owner: Register
    domain_of:
    - Register
    range: EndDeviceFunction
    required: false
  usage_point:
    name: usage_point
    description: Usage Point, when metered, has these registers.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Register.Usage%20Point
    multivalued: false
    alias: usage_point
    owner: Register
    domain_of:
    - MeterReadSchedule
    - MeterReading
    - EndDevice
    - EndDeviceEvent
    - Register
    - MeterWorkTask
    - PlannedOutageNotification
    - EnvironmentalMonitoringStation
    - ServiceMultiplier
    range: UsagePoint
    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: Register
    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: Register
    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: Register
    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: Register
    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: Register
    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: Register
    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: Register
    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: Register
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:Register