Class: Charge

A charge element associated with other entities such as tariff structures, auxiliary agreements or other charge elements. The total charge amount applicable to this instance of charge is the sum of fixed and variable portion.

URI: cim:Charge

 classDiagram
    class Charge
      IdentifiedObject <|-- Charge

      Charge : alias_name

      Charge : auxiliary_accounts

          Charge --> AuxiliaryAccount : auxiliary_accounts

      Charge : child_charges

          Charge --> Charge : child_charges

      Charge : consumption_tariff_intervals

          Charge --> ConsumptionTariffInterval : consumption_tariff_intervals

      Charge : description

      Charge : diagram_objects

          Charge --> DiagramObject : diagram_objects

      Charge : fixed_portion

          Charge --> AccountingUnit : fixed_portion

      Charge : instance_set

          Charge --> InstanceSet : instance_set

      Charge : kind

          Charge --> ChargeKind : kind

      Charge : m_rid

      Charge : names

          Charge --> Name : names

      Charge : parent_charge

          Charge --> Charge : parent_charge

      Charge : properties_cimdata_object

          Charge --> ChangeSetMember : properties_cimdata_object

      Charge : targeting_cimdata_object

          Charge --> ChangeSetMember : targeting_cimdata_object

      Charge : time_tariff_intervals

          Charge --> TimeTariffInterval : time_tariff_intervals

      Charge : variable_portion

          Charge --> PerCent : variable_portion

Inheritance

IdentifiedObject
- Charge

Slots

Name	Cardinality and Range	Description	Inheritance
fixed_portion	0..1 AccountingUnit	The fixed portion of this charge element	direct
kind	0..1 ChargeKind	The kind of charge to be applied	direct
variable_portion	0..1 PerCent	The variable portion of this charge element, calculated as a percentage of th...	direct
child_charges	0..* Charge	All sub-components of this complex charge	direct
parent_charge	0..1 Charge	Parent of this charge sub-component	direct
time_tariff_intervals	0..* TimeTariffInterval	Tariff intervals to which this time-based charge has to be levied	direct
consumption_tariff_intervals	0..* ConsumptionTariffInterval	Tariff intervals to which this consumption-based charge has to be levied	direct
auxiliary_accounts	0..* AuxiliaryAccount	All auxiliary accounts to which this charge has to be levied	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
AuxiliaryAccount	charges	range	Charge
Charge	child_charges	range	Charge
Charge	parent_charge	range	Charge
TimeTariffInterval	charges	range	Charge
ConsumptionTariffInterval	charges	range	Charge

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Charge
description: A charge element associated with other entities such as tariff structures,
  auxiliary agreements or other charge elements. The total charge amount applicable
  to this instance of charge is the sum of fixed and variable portion.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  fixed_portion:
    name: fixed_portion
    description: The fixed portion of this charge element.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Charge.fixedPortion
    multivalued: false
    domain_of:
    - Charge
    range: AccountingUnit
    required: false
  kind:
    name: kind
    description: The kind of charge to be applied.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Charge.kind
    multivalued: false
    domain_of:
    - Asset
    - Customer
    - BaseWork
    - WorkTimeSchedule
    - CustomerBillingInfo
    - ErpInvoiceLineItem
    - CatalogAssetType
    - Design
    - ConditionFactor
    - LandProperty
    - Seal
    - Gate
    - JumperAction
    - RevisionHistory
    - SwitchAction
    - Fault
    - ServiceCategory
    - Transaction
    - Procedure
    - Medium
    - Tender
    - Cheque
    - Charge
    - ServiceRequest
    - MeterMultiplier
    - StructureSupport
    - CutAction
    - GroundAction
    - ClampAction
    - ProtectiveActionAdjustment
    - RemedialActionScheme
    - MeasurementCalculator
    - ErpInvoice
    - ServiceSupplier
    - EnergyTypeReference
    - CRROrgRole
    - MarketInvoice
    - MarketInvoiceLineItem
    - EnvironmentalLocationType
    - EnvironmentalDiscrete
    - ServiceMultiplier
    - AssetLocationHazard
    - Analytic
    - AssetGroup
    - TagAction
    - PinBranchGroup
    - PinTerminal
    - PinEquipment
    - ClearanceAction
    - PSREvent
    - ShuntCompensatorAction
    - EnergyConsumerAction
    - EnergySourceAction
    - Zone
    - OilAnalysisMoistureAnalog
    - AssetStringMeasurement
    - InspectionAnalog
    - AssetTemperaturePressureAnalog
    - OilAnalysisFluidDiscrete
    - InspectionDiscrete
    - OilAnalysisPCBDiscrete
    - OilAnalysisFluidAnalog
    - OilAnalysisGasAnalog
    - OilAnalysisPCBAnalog
    - OilAnalysisParticleDiscrete
    - OilAnalysisMetalsAnalog
    - OilAnalysisParticleAnalog
    - OilAnalysisPaperAnalog
    - CompositeSwitchInfo
    - Facility
    - RiskScore
    - FACTSDevice
    - SimpleEndDeviceFunction
    - UndergroundStructure
    - RelativeDisplacement
    - CloudCondition
    - GeosphericAnalog
    - HydrosphericAnalog
    - AtmosphericAnalog
    - SpaceAnalog
    range: ChargeKind
    required: false
  variable_portion:
    name: variable_portion
    description: The variable portion of this charge element, calculated as a percentage
      of the total amount of a parent charge.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Charge.variablePortion
    multivalued: false
    domain_of:
    - Charge
    range: PerCent
    required: false
  child_charges:
    name: child_charges
    description: All sub-components of this complex charge.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Charge.ChildCharges
    multivalued: true
    domain_of:
    - Charge
    range: Charge
    required: false
  parent_charge:
    name: parent_charge
    description: Parent of this charge sub-component.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Charge.ParentCharge
    multivalued: false
    domain_of:
    - Charge
    range: Charge
    required: false
  time_tariff_intervals:
    name: time_tariff_intervals
    description: Tariff intervals to which this time-based charge has to be levied.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Charge.TimeTariffIntervals
    multivalued: true
    domain_of:
    - Charge
    - TariffProfile
    range: TimeTariffInterval
    required: false
  consumption_tariff_intervals:
    name: consumption_tariff_intervals
    description: Tariff intervals to which this consumption-based charge has to be
      levied.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Charge.ConsumptionTariffIntervals
    multivalued: true
    domain_of:
    - Charge
    - TimeTariffInterval
    - TariffProfile
    - ReadingType
    range: ConsumptionTariffInterval
    required: false
  auxiliary_accounts:
    name: auxiliary_accounts
    description: All auxiliary accounts to which this charge has to be levied.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Charge.AuxiliaryAccounts
    multivalued: true
    domain_of:
    - AuxiliaryAgreement
    - Charge
    range: AuxiliaryAccount
    required: false
class_uri: cim:Charge

Induced

name: Charge
description: A charge element associated with other entities such as tariff structures,
  auxiliary agreements or other charge elements. The total charge amount applicable
  to this instance of charge is the sum of fixed and variable portion.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  fixed_portion:
    name: fixed_portion
    description: The fixed portion of this charge element.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Charge.fixedPortion
    multivalued: false
    alias: fixed_portion
    owner: Charge
    domain_of:
    - Charge
    range: AccountingUnit
    required: false
  kind:
    name: kind
    description: The kind of charge to be applied.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Charge.kind
    multivalued: false
    alias: kind
    owner: Charge
    domain_of:
    - Asset
    - Customer
    - BaseWork
    - WorkTimeSchedule
    - CustomerBillingInfo
    - ErpInvoiceLineItem
    - CatalogAssetType
    - Design
    - ConditionFactor
    - LandProperty
    - Seal
    - Gate
    - JumperAction
    - RevisionHistory
    - SwitchAction
    - Fault
    - ServiceCategory
    - Transaction
    - Procedure
    - Medium
    - Tender
    - Cheque
    - Charge
    - ServiceRequest
    - MeterMultiplier
    - StructureSupport
    - CutAction
    - GroundAction
    - ClampAction
    - ProtectiveActionAdjustment
    - RemedialActionScheme
    - MeasurementCalculator
    - ErpInvoice
    - ServiceSupplier
    - EnergyTypeReference
    - CRROrgRole
    - MarketInvoice
    - MarketInvoiceLineItem
    - EnvironmentalLocationType
    - EnvironmentalDiscrete
    - ServiceMultiplier
    - AssetLocationHazard
    - Analytic
    - AssetGroup
    - TagAction
    - PinBranchGroup
    - PinTerminal
    - PinEquipment
    - ClearanceAction
    - PSREvent
    - ShuntCompensatorAction
    - EnergyConsumerAction
    - EnergySourceAction
    - Zone
    - OilAnalysisMoistureAnalog
    - AssetStringMeasurement
    - InspectionAnalog
    - AssetTemperaturePressureAnalog
    - OilAnalysisFluidDiscrete
    - InspectionDiscrete
    - OilAnalysisPCBDiscrete
    - OilAnalysisFluidAnalog
    - OilAnalysisGasAnalog
    - OilAnalysisPCBAnalog
    - OilAnalysisParticleDiscrete
    - OilAnalysisMetalsAnalog
    - OilAnalysisParticleAnalog
    - OilAnalysisPaperAnalog
    - CompositeSwitchInfo
    - Facility
    - RiskScore
    - FACTSDevice
    - SimpleEndDeviceFunction
    - UndergroundStructure
    - RelativeDisplacement
    - CloudCondition
    - GeosphericAnalog
    - HydrosphericAnalog
    - AtmosphericAnalog
    - SpaceAnalog
    range: ChargeKind
    required: false
  variable_portion:
    name: variable_portion
    description: The variable portion of this charge element, calculated as a percentage
      of the total amount of a parent charge.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Charge.variablePortion
    multivalued: false
    alias: variable_portion
    owner: Charge
    domain_of:
    - Charge
    range: PerCent
    required: false
  child_charges:
    name: child_charges
    description: All sub-components of this complex charge.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Charge.ChildCharges
    multivalued: true
    alias: child_charges
    owner: Charge
    domain_of:
    - Charge
    range: Charge
    required: false
  parent_charge:
    name: parent_charge
    description: Parent of this charge sub-component.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Charge.ParentCharge
    multivalued: false
    alias: parent_charge
    owner: Charge
    domain_of:
    - Charge
    range: Charge
    required: false
  time_tariff_intervals:
    name: time_tariff_intervals
    description: Tariff intervals to which this time-based charge has to be levied.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Charge.TimeTariffIntervals
    multivalued: true
    alias: time_tariff_intervals
    owner: Charge
    domain_of:
    - Charge
    - TariffProfile
    range: TimeTariffInterval
    required: false
  consumption_tariff_intervals:
    name: consumption_tariff_intervals
    description: Tariff intervals to which this consumption-based charge has to be
      levied.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Charge.ConsumptionTariffIntervals
    multivalued: true
    alias: consumption_tariff_intervals
    owner: Charge
    domain_of:
    - Charge
    - TimeTariffInterval
    - TariffProfile
    - ReadingType
    range: ConsumptionTariffInterval
    required: false
  auxiliary_accounts:
    name: auxiliary_accounts
    description: All auxiliary accounts to which this charge has to be levied.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Charge.AuxiliaryAccounts
    multivalued: true
    alias: auxiliary_accounts
    owner: Charge
    domain_of:
    - AuxiliaryAgreement
    - Charge
    range: AuxiliaryAccount
    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: Charge
    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: Charge
    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: Charge
    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: Charge
    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: Charge
    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: Charge
    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: Charge
    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: Charge
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:Charge