Skip to content

Class: Channel

_A single path for the collection or reporting of register values over a period of time. For example, a register which measures forward energy can have two channels, one providing bulk quantity readings and the other providing interval readings of a fixed interval size. _

__

URI: cim:Channel

 classDiagram
    class Channel
      IdentifiedObject <|-- Channel

      Channel : alias_name

      Channel : description

      Channel : diagram_objects

          Channel --> DiagramObject : diagram_objects

      Channel : instance_set

          Channel --> InstanceSet : instance_set

      Channel : is_virtual

      Channel : m_rid

      Channel : names

          Channel --> Name : names

      Channel : properties_cimdata_object

          Channel --> ChangeSetMember : properties_cimdata_object

      Channel : reading_type

          Channel --> ReadingType : reading_type

      Channel : register

          Channel --> Register : register

      Channel : targeting_cimdata_object

          Channel --> ChangeSetMember : targeting_cimdata_object

Inheritance

Slots

Name Cardinality and Range Description Inheritance
is_virtual 0..1
Boolean		 If true, the data is being calculated by an enterprise system rather than met... direct
register 0..1
Register		 Register whose values are collected/reported by this channel direct
reading_type 0..1
ReadingType		 Reading type for register values reported/collected by this channel 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
ReadingType channel range Channel
Register channels range Channel

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Channel
description: "A single path for the collection or reporting of register values over\
  \ a period of time. For example, a register which measures forward energy can have\
  \ two channels, one providing bulk quantity readings and the other providing interval\
  \ readings of a fixed interval size.\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 is being calculated by an enterprise system rather\
      \ than metered directly.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Channel.isVirtual
    multivalued: false
    domain_of:
    - UsagePoint
    - EndDevice
    - Register
    - Channel
    range: boolean
    required: false
  register:
    name: register
    description: Register whose values are collected/reported by this channel.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Channel.Register
    multivalued: false
    domain_of:
    - UsagePoint
    - Channel
    range: Register
    required: false
  reading_type:
    name: reading_type
    description: Reading type for register values reported/collected by this channel.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Channel.ReadingType
    multivalued: false
    domain_of:
    - MeterReadSchedule
    - ConsumptionTariffInterval
    - PendingCalculation
    - IntervalBlock
    - Reading
    - Channel
    range: ReadingType
    required: false
class_uri: cim:Channel

Induced

name: Channel
description: "A single path for the collection or reporting of register values over\
  \ a period of time. For example, a register which measures forward energy can have\
  \ two channels, one providing bulk quantity readings and the other providing interval\
  \ readings of a fixed interval size.\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 is being calculated by an enterprise system rather\
      \ than metered directly.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Channel.isVirtual
    multivalued: false
    alias: is_virtual
    owner: Channel
    domain_of:
    - UsagePoint
    - EndDevice
    - Register
    - Channel
    range: boolean
    required: false
  register:
    name: register
    description: Register whose values are collected/reported by this channel.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Channel.Register
    multivalued: false
    alias: register
    owner: Channel
    domain_of:
    - UsagePoint
    - Channel
    range: Register
    required: false
  reading_type:
    name: reading_type
    description: Reading type for register values reported/collected by this channel.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Channel.ReadingType
    multivalued: false
    alias: reading_type
    owner: Channel
    domain_of:
    - MeterReadSchedule
    - ConsumptionTariffInterval
    - PendingCalculation
    - IntervalBlock
    - Reading
    - Channel
    range: ReadingType
    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: Channel
    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: Channel
    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: Channel
    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: Channel
    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: Channel
    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: Channel
    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: Channel
    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: Channel
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:Channel