Skip to content

Class: ComFunction

_Communication function of communication equipment or a device such as a meter. _

URI: cim:ComFunction

 classDiagram
    class ComFunction
      EndDeviceFunction <|-- ComFunction

      ComFunction : alias_name

      ComFunction : amr_address

      ComFunction : amr_router

      ComFunction : asset

          ComFunction --> Asset : asset

      ComFunction : com_module

          ComFunction --> ComModule : com_module

      ComFunction : config_id

      ComFunction : description

      ComFunction : diagram_objects

          ComFunction --> DiagramObject : diagram_objects

      ComFunction : direction

          ComFunction --> ComDirectionKind : direction

      ComFunction : enabled

      ComFunction : end_device

          ComFunction --> EndDevice : end_device

      ComFunction : firmware_id

      ComFunction : hardware_id

      ComFunction : instance_set

          ComFunction --> InstanceSet : instance_set

      ComFunction : m_rid

      ComFunction : names

          ComFunction --> Name : names

      ComFunction : password

      ComFunction : program_id

      ComFunction : properties_cimdata_object

          ComFunction --> ChangeSetMember : properties_cimdata_object

      ComFunction : registers

          ComFunction --> Register : registers

      ComFunction : targeting_cimdata_object

          ComFunction --> ChangeSetMember : targeting_cimdata_object

      ComFunction : technology

          ComFunction --> ComTechnologyKind : technology

Inheritance

Slots

Name Cardinality and Range Description Inheritance
amr_address 0..1
String		 Communication ID number (e direct
amr_router 0..1
String		 Communication ID number (e direct
direction 0..1
ComDirectionKind		 Kind of communication direction direct
technology 0..1
ComTechnologyKind		 Kind of communication technology direct
com_module 0..1
ComModule		 Module performing this communication function direct
enabled 0..1
Boolean		 True if the function is enabled EndDeviceFunction
end_device 0..1
EndDevice		 End device that performs this function EndDeviceFunction
registers 0..*
Register		 All registers for quantities metered by this end device function EndDeviceFunction
config_id 0..1
String		 Configuration specified for this function AssetFunction
firmware_id 0..1
String		 Firmware version AssetFunction
hardware_id 0..1
String		 Hardware version AssetFunction
password 0..1
String		 Password needed to access this function AssetFunction
program_id 0..1
String		 Name of program AssetFunction
asset 0..1
Asset		 Asset on which this function can be performed AssetFunction
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
ComModule com_functions range ComFunction

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: ComFunction
description: 'Communication function of communication equipment or a device such as
  a meter. '
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: EndDeviceFunction
attributes:
  amr_address:
    name: amr_address
    description: Communication ID number (e.g. serial number, IP address, telephone
      number, etc.) of the AMR module which serves this meter.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ComFunction.amrAddress
    multivalued: false
    domain_of:
    - ComFunction
    range: string
    required: false
  amr_router:
    name: amr_router
    description: "Communication ID number (e.g. port number, serial number, data collector\
      \ ID, etc.) of the parent device associated to this AMR module.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ComFunction.amrRouter
    multivalued: false
    domain_of:
    - ComFunction
    range: string
    required: false
  direction:
    name: direction
    description: "Kind of communication direction.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ComFunction.direction
    multivalued: false
    domain_of:
    - Location
    - StructureSupport
    - Flowgate
    - RegisteredInterTie
    - Price
    - FlowDirection
    - OperationalLimitType
    - ComFunction
    - AtmosphericPhenomenon
    - BidTimeSeries
    range: ComDirectionKind
    required: false
  technology:
    name: technology
    description: "Kind of communication technology.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ComFunction.technology
    multivalued: false
    domain_of:
    - ComFunction
    range: ComTechnologyKind
    required: false
  com_module:
    name: com_module
    description: Module performing this communication function.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ComFunction.ComModule
    multivalued: false
    domain_of:
    - ComFunction
    range: ComModule
    required: false
class_uri: cim:ComFunction

Induced

name: ComFunction
description: 'Communication function of communication equipment or a device such as
  a meter. '
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: EndDeviceFunction
attributes:
  amr_address:
    name: amr_address
    description: Communication ID number (e.g. serial number, IP address, telephone
      number, etc.) of the AMR module which serves this meter.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ComFunction.amrAddress
    multivalued: false
    alias: amr_address
    owner: ComFunction
    domain_of:
    - ComFunction
    range: string
    required: false
  amr_router:
    name: amr_router
    description: "Communication ID number (e.g. port number, serial number, data collector\
      \ ID, etc.) of the parent device associated to this AMR module.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ComFunction.amrRouter
    multivalued: false
    alias: amr_router
    owner: ComFunction
    domain_of:
    - ComFunction
    range: string
    required: false
  direction:
    name: direction
    description: "Kind of communication direction.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ComFunction.direction
    multivalued: false
    alias: direction
    owner: ComFunction
    domain_of:
    - Location
    - StructureSupport
    - Flowgate
    - RegisteredInterTie
    - Price
    - FlowDirection
    - OperationalLimitType
    - ComFunction
    - AtmosphericPhenomenon
    - BidTimeSeries
    range: ComDirectionKind
    required: false
  technology:
    name: technology
    description: "Kind of communication technology.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ComFunction.technology
    multivalued: false
    alias: technology
    owner: ComFunction
    domain_of:
    - ComFunction
    range: ComTechnologyKind
    required: false
  com_module:
    name: com_module
    description: Module performing this communication function.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ComFunction.ComModule
    multivalued: false
    alias: com_module
    owner: ComFunction
    domain_of:
    - ComFunction
    range: ComModule
    required: false
  enabled:
    name: enabled
    description: "True if the function is enabled.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceFunction.enabled
    multivalued: false
    alias: enabled
    owner: ComFunction
    domain_of:
    - ProtectiveAction
    - EndDeviceFunction
    - RegulatingControl
    - DynamicsFunctionBlock
    range: boolean
    required: false
  end_device:
    name: end_device
    description: End device that performs this function.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceFunction.EndDevice
    multivalued: false
    alias: end_device
    owner: ComFunction
    domain_of:
    - MeterReadSchedule
    - EndDeviceEvent
    - EndDeviceFunction
    range: EndDevice
    required: false
  registers:
    name: registers
    description: All registers for quantities metered by this end device function.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceFunction.Registers
    multivalued: true
    alias: registers
    owner: ComFunction
    domain_of:
    - EndDeviceFunction
    range: Register
    required: false
  config_id:
    name: config_id
    description: Configuration specified for this function.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AssetFunction.configID
    multivalued: false
    alias: config_id
    owner: ComFunction
    domain_of:
    - AssetFunction
    range: string
    required: false
  firmware_id:
    name: firmware_id
    description: Firmware version.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AssetFunction.firmwareID
    multivalued: false
    alias: firmware_id
    owner: ComFunction
    domain_of:
    - AssetFunction
    range: string
    required: false
  hardware_id:
    name: hardware_id
    description: Hardware version.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AssetFunction.hardwareID
    multivalued: false
    alias: hardware_id
    owner: ComFunction
    domain_of:
    - AssetFunction
    range: string
    required: false
  password:
    name: password
    description: Password needed to access this function.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:AssetFunction.password
    multivalued: false
    alias: password
    owner: ComFunction
    domain_of:
    - ElectronicAddress
    - AssetFunction
    range: string
    required: false
  program_id:
    name: program_id
    description: Name of program.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:AssetFunction.programID
    multivalued: false
    alias: program_id
    owner: ComFunction
    domain_of:
    - AssetFunction
    range: string
    required: false
  asset:
    name: asset
    description: Asset on which this function can be performed.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:AssetFunction.Asset
    multivalued: false
    alias: asset
    owner: ComFunction
    domain_of:
    - FinancialInfo
    - Incident
    - ProductAssetModel
    - Measurement
    - AssetDeployment
    - ProcedureDataSet
    - Reconditioning
    - Medium
    - ServiceLocation
    - AssetFunction
    - AnalyticScore
    - Analytic
    - AssetGroup
    - OperationalTag
    - Ownership
    - ErpItemMaster
    - ErpInventory
    range: Asset
    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: ComFunction
    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: ComFunction
    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: ComFunction
    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: ComFunction
    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: ComFunction
    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: ComFunction
    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: ComFunction
    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: ComFunction
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:ComFunction