Class: ReadingType
Detailed description for a type of a reading value. Values in attributes allow for the creation of recommended codes to be used for identifying reading value types as follows:
URI: cim:ReadingType
classDiagram
class ReadingType
IdentifiedObject <|-- ReadingType
ReadingType : accumulation
ReadingType --> AccumulationKind : accumulation
ReadingType : aggregate
ReadingType --> AggregateKind : aggregate
ReadingType : alias_name
ReadingType : argument
ReadingType --> RationalNumber : argument
ReadingType : channel
ReadingType --> Channel : channel
ReadingType : commodity
ReadingType --> CommodityKind : commodity
ReadingType : consumption_tariff_intervals
ReadingType --> ConsumptionTariffInterval : consumption_tariff_intervals
ReadingType : consumption_tier
ReadingType : cpp
ReadingType : currency
ReadingType --> Currency : currency
ReadingType : description
ReadingType : diagram_objects
ReadingType --> DiagramObject : diagram_objects
ReadingType : flow_direction
ReadingType --> FlowDirectionKind : flow_direction
ReadingType : instance_set
ReadingType --> InstanceSet : instance_set
ReadingType : interharmonic
ReadingType --> ReadingInterharmonic : interharmonic
ReadingType : interval_blocks
ReadingType --> IntervalBlock : interval_blocks
ReadingType : m_rid
ReadingType : macro_period
ReadingType --> MacroPeriodKind : macro_period
ReadingType : measurement_kind
ReadingType --> MeasurementKind : measurement_kind
ReadingType : measuring_period
ReadingType --> MeasuringPeriodKind : measuring_period
ReadingType : meter_read_schedule
ReadingType --> MeterReadSchedule : meter_read_schedule
ReadingType : metrology_requirements
ReadingType --> MetrologyRequirement : metrology_requirements
ReadingType : multiplier
ReadingType --> UnitMultiplier : multiplier
ReadingType : names
ReadingType --> Name : names
ReadingType : pending_calculation
ReadingType --> PendingCalculation : pending_calculation
ReadingType : phases
ReadingType --> PhaseCode : phases
ReadingType : properties_cimdata_object
ReadingType --> ChangeSetMember : properties_cimdata_object
ReadingType : readings
ReadingType --> Reading : readings
ReadingType : targeting_cimdata_object
ReadingType --> ChangeSetMember : targeting_cimdata_object
ReadingType : tou
ReadingType : unit
ReadingType --> UnitSymbol : unit
Inheritance
- IdentifiedObject
- ReadingType
Slots
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| accumulation | 0..1 AccumulationKind |
Accumulation behaviour of a reading over time, usually 'measuringPeriod', to ... | direct |
| aggregate | 0..1 AggregateKind |
Salient attribute of the reading data aggregated from individual endpoints | direct |
| argument | 0..1 RationalNumber |
Argument used to introduce numbers into the unit of measure description where... | direct |
| commodity | 0..1 CommodityKind |
Commodity being measured | direct |
| consumption_tier | 0..1 Integer |
In case of common flat-rate pricing for power, in which all purchases are at ... | direct |
| cpp | 0..1 Integer |
Critical peak period (CPP) bucket the reading value is attributed to | direct |
| currency | 0..1 Currency |
Metering-specific currency | direct |
| flow_direction | 0..1 FlowDirectionKind |
Flow direction for a reading where the direction of flow of the commodity is ... | direct |
| interharmonic | 0..1 ReadingInterharmonic |
Indication of a "harmonic" or "interharmonic" basis for the measurement | direct |
| macro_period | 0..1 MacroPeriodKind |
Time period of interest that reflects how the reading is viewed or captured o... | direct |
| measurement_kind | 0..1 MeasurementKind |
Identifies "what" is being measured, as refinement of 'commodity' | direct |
| measuring_period | 0..1 MeasuringPeriodKind |
Time attribute inherent or fundamental to the reading value (as opposed to 'm... | direct |
| multiplier | 0..1 UnitMultiplier |
Metering-specific multiplier | direct |
| phases | 0..1 PhaseCode |
Metering-specific phase code | direct |
| tou | 0..1 Integer |
Time of use (TOU) bucket the reading value is attributed to | direct |
| unit | 0..1 UnitSymbol |
Metering-specific unit | direct |
| channel | 0..1 Channel |
Channel reporting/collecting register values with this type information | direct |
| meter_read_schedule | 0..1 MeterReadSchedule |
Meter read schedule for which the reading type applies | direct |
| consumption_tariff_intervals | 0..* ConsumptionTariffInterval |
All tariff intervals with consumption described by this reading type | direct |
| pending_calculation | 0..1 PendingCalculation |
Pending calculation that produced this reading type | direct |
| interval_blocks | 0..* IntervalBlock |
All blocks containing interval reading values with this type information | direct |
| metrology_requirements | 0..* MetrologyRequirement |
All metrology requirements that require this reading type to be collected | direct |
| readings | 0..* Reading |
All reading values with this type information | 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 | reading_type | range | ReadingType |
| ConsumptionTariffInterval | reading_type | range | ReadingType |
| PendingCalculation | reading_type | range | ReadingType |
| IntervalBlock | reading_type | range | ReadingType |
| Reading | reading_type | range | ReadingType |
| Channel | reading_type | range | ReadingType |
| MetrologyRequirement | reading_types | range | ReadingType |
Identifier and Mapping Information
Schema Source
- from schema: https://cim.ucaiug.io/ns#TC57CIM
Mappings
| Mapping Type | Mapped Value |
|---|---|
| self | cim:ReadingType |
| native | cim:ReadingType |
LinkML Source
Direct
name: ReadingType
description: 'Detailed description for a type of a reading value. Values in attributes
allow for the creation of recommended codes to be used for identifying reading value
types as follows: <macroPeriod>.<aggregate>.<measuringPeriod>.<accumulation>.<flowDirection>.<commodity>.<measurementKind>.<interharmonic.numerator>.<interharmonic.denominator>.<argument.numerator>.<argument.denominator>.<tou>.<cpp>.<consumptionTier>.<phases>.<multiplier>.<unit>.<currency>.'
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
accumulation:
name: accumulation
description: Accumulation behaviour of a reading over time, usually 'measuringPeriod',
to be used with individual endpoints (as opposed to 'macroPeriod' and 'aggregate'
that are used to describe aggregations of data from individual endpoints).
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.accumulation
multivalued: false
domain_of:
- ReadingType
range: AccumulationKind
required: false
aggregate:
name: aggregate
description: Salient attribute of the reading data aggregated from individual
endpoints. This is mainly used to define a mathematical operation carried out
over 'macroPeriod', but may also be used to describe an attribute of the data
when the 'macroPeriod' is not defined.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ReadingType.aggregate
multivalued: false
domain_of:
- Equipment
- ReadingType
range: AggregateKind
required: false
argument:
name: argument
description: "Argument used to introduce numbers into the unit of measure description\
\ where they are needed (e.g., 4 where the measure needs an argument such as\
\ CEMI(n=4)). Most arguments used in practice however will be integers (i.e.,\
\ 'denominator'=1).\r\nValue 0 in 'numerator' and 'denominator' means not applicable.\r\
\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.argument
multivalued: false
domain_of:
- ReadingType
range: RationalNumber
required: false
commodity:
name: commodity
description: Commodity being measured.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.commodity
multivalued: false
domain_of:
- ReadingType
range: CommodityKind
required: false
consumption_tier:
name: consumption_tier
description: "In case of common flat-rate pricing for power, in which all purchases\
\ are at a given rate, 'consumptionTier'=0. Otherwise, the value indicates the\
\ consumption tier, which can be used in conjunction with TOU or CPP pricing.\r\
\nConsumption tier pricing refers to the method of billing in which a certain\
\ \"block\" of energy is purchased/sold at one price, after which the next block\
\ of energy is purchased at another price, and so on, all throughout a defined\
\ period. At the start of the defined period, consumption is initially zero,\
\ and any usage is measured against the first consumption tier ('consumptionTier'=1).\
\ If this block of energy is consumed before the end of the period, energy consumption\
\ moves to be reconed against the second consumption tier ('consumptionTier'=2),\
\ and so on. At the end of the defined period, the consumption accumulator is\
\ reset, and usage within the 'consumptionTier'=1 restarts.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.consumptionTier
multivalued: false
domain_of:
- ReadingType
range: integer
required: false
cpp:
name: cpp
description: "Critical peak period (CPP) bucket the reading value is attributed\
\ to. Value 0 means not applicable. Even though CPP is usually considered a\
\ specialised form of time of use 'tou', this attribute is defined explicitly\
\ for flexibility.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.cpp
multivalued: false
domain_of:
- ReadingType
range: integer
required: false
currency:
name: currency
description: Metering-specific currency.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ReadingType.currency
multivalued: false
domain_of:
- DecimalQuantity
- ReadingType
range: Currency
required: false
flow_direction:
name: flow_direction
description: Flow direction for a reading where the direction of flow of the commodity
is important (for electricity measurements this includes current, energy, power,
and demand).
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.flowDirection
multivalued: false
domain_of:
- ReadingType
- DERMonitorableParameter
- TimeSeries
- Point
range: FlowDirectionKind
required: false
interharmonic:
name: interharmonic
description: "Indication of a \"harmonic\" or \"interharmonic\" basis for the\
\ measurement. Value 0 in 'numerator' and 'denominator' means not applicable.\r\
\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.interharmonic
multivalued: false
domain_of:
- ReadingType
range: ReadingInterharmonic
required: false
macro_period:
name: macro_period
description: Time period of interest that reflects how the reading is viewed or
captured over a long period of time.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.macroPeriod
multivalued: false
domain_of:
- ReadingType
range: MacroPeriodKind
required: false
measurement_kind:
name: measurement_kind
description: 'Identifies "what" is being measured, as refinement of ''commodity''.
When combined with ''unit'', it provides detail to the unit of measure. For
example, ''energy'' with a unit of measure of ''kWh'' indicates to the user
that active energy is being measured, while with ''kVAh'' or ''kVArh'', it indicates
apparent energy and reactive energy, respectively. ''power'' can be combined
in a similar way with various power units of measure: Distortion power (''distortionVoltAmperes'')
with ''kVA'' is different from ''power'' with ''kVA''.'
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.measurementKind
multivalued: false
domain_of:
- ReadingType
range: MeasurementKind
required: false
measuring_period:
name: measuring_period
description: "Time attribute inherent or fundamental to the reading value (as\
\ opposed to 'macroPeriod' that supplies an \"adjective\" to describe aspects\
\ of a time period with regard to the measurement). It refers to the way the\
\ value was originally measured and not to the frequency at which it is reported\
\ or presented. For example, an hourly interval of consumption data would have\
\ value 'hourly' as an attribute. However in the case of an hourly sampled voltage\
\ value, the meterReadings schema would carry the 'hourly' interval size information.\r\
\nIt is common for meters to report demand in a form that is measured over the\
\ course of a portion of an hour, while enterprise applications however commonly\
\ assume the demand (in kW or kVAr) normalised to 1 hour. The system that receives\
\ readings directly from the meter therefore shall perform this transformation\
\ before publishing readings for use by the other enterprise systems. The scalar\
\ used is chosen based on the block size (not any sub-interval size)."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.measuringPeriod
multivalued: false
domain_of:
- ReadingType
range: MeasuringPeriodKind
required: false
multiplier:
name: multiplier
description: Metering-specific multiplier.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ReadingType.multiplier
multivalued: false
domain_of:
- VoltagePerReactivePower
- Length
- ConductancePerLength
- VolumeFlowRate
- Volume
- Voltage
- Temperature
- Admittance
- Impedance
- CostPerVolume
- SusceptancePerLength
- Money
- Minutes
- FloatQuantity
- CostPerEnergyUnit
- PerCent
- IntegerQuantity
- ApparentPower
- WaterLevel
- Displacement
- Damping
- Seconds
- ResistancePerLength
- Inductance
- AngleDegrees
- CostRate
- Speed
- Capacitance
- PU
- Pressure
- KiloActivePower
- ReactivePower
- StringQuantity
- ActivePowerChangeRate
- Hours
- Conductance
- RotationSpeed
- CurrentFlow
- Frequency
- AngleRadians
- ActivePower
- ReactancePerLength
- Resistance
- Reactance
- Susceptance
- RealEnergy
- Classification
- HeatRate
- Emission
- CostPerHeatUnit
- ActivePowerPerFrequency
- InductancePerLength
- CapacitancePerLength
- DecimalQuantity
- Area
- ActivePowerPerCurrentFlow
- Mass
- AccountingUnit
- ReadingType
- MagneticField
- ParticulateDensity
- Bearing
range: UnitMultiplier
required: false
phases:
name: phases
description: Metering-specific phase code.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ReadingType.phases
multivalued: false
domain_of:
- Terminal
- Measurement
- SwitchingAction
- Fault
- TransformerTankEnd
- ReadingType
range: PhaseCode
required: false
tou:
name: tou
description: "Time of use (TOU) bucket the reading value is attributed to. Value\
\ 0 means not applicable.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.tou
multivalued: false
domain_of:
- ReadingType
range: integer
required: false
unit:
name: unit
description: Metering-specific unit.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ReadingType.unit
multivalued: false
domain_of:
- VoltagePerReactivePower
- Length
- ConductancePerLength
- VolumeFlowRate
- Volume
- Voltage
- Temperature
- Admittance
- Impedance
- CostPerVolume
- SusceptancePerLength
- Money
- Minutes
- FloatQuantity
- CostPerEnergyUnit
- PerCent
- IntegerQuantity
- ApparentPower
- WaterLevel
- Displacement
- Damping
- Seconds
- ResistancePerLength
- Inductance
- AngleDegrees
- CostRate
- Speed
- Capacitance
- PU
- Pressure
- KiloActivePower
- ReactivePower
- StringQuantity
- ActivePowerChangeRate
- Hours
- Conductance
- RotationSpeed
- CurrentFlow
- Frequency
- AngleRadians
- ActivePower
- ReactancePerLength
- Resistance
- Reactance
- Susceptance
- RealEnergy
- Classification
- HeatRate
- Emission
- CostPerHeatUnit
- ActivePowerPerFrequency
- InductancePerLength
- CapacitancePerLength
- DecimalQuantity
- Area
- ActivePowerPerCurrentFlow
- Mass
- ReadingType
- TimeSeries
- AceTariffType
- MagneticField
- ParticulateDensity
- Bearing
range: UnitSymbol
required: false
channel:
name: channel
description: Channel reporting/collecting register values with this type information.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.Channel
multivalued: false
domain_of:
- ReadingType
range: Channel
required: false
meter_read_schedule:
name: meter_read_schedule
description: Meter read schedule for which the reading type applies
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ReadingType.MeterReadSchedule
multivalued: false
domain_of:
- TimeSchedule
- UsagePoint
- CustomerAgreement
- CustomerAccount
- ReadingType
- EndDevice
- EndDeviceGroup
- UsagePointGroup
range: MeterReadSchedule
required: false
consumption_tariff_intervals:
name: consumption_tariff_intervals
description: All tariff intervals with consumption described by this reading type.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ReadingType.ConsumptionTariffIntervals
multivalued: true
domain_of:
- Charge
- TimeTariffInterval
- TariffProfile
- ReadingType
range: ConsumptionTariffInterval
required: false
pending_calculation:
name: pending_calculation
description: Pending calculation that produced this reading type.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.PendingCalculation
multivalued: false
domain_of:
- ReadingType
- IntervalBlock
range: PendingCalculation
required: false
interval_blocks:
name: interval_blocks
description: All blocks containing interval reading values with this type information.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.IntervalBlocks
multivalued: true
domain_of:
- ReadingType
- PendingCalculation
- MeterReading
- IntervalReading
range: IntervalBlock
required: false
metrology_requirements:
name: metrology_requirements
description: All metrology requirements that require this reading type to be collected.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ReadingType.MetrologyRequirements
multivalued: true
domain_of:
- UsagePoint
- ReadingType
range: MetrologyRequirement
required: false
readings:
name: readings
description: All reading values with this type information.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.Readings
multivalued: true
domain_of:
- ReadingType
- MeterReading
range: Reading
required: false
class_uri: cim:ReadingType
Induced
name: ReadingType
description: 'Detailed description for a type of a reading value. Values in attributes
allow for the creation of recommended codes to be used for identifying reading value
types as follows: <macroPeriod>.<aggregate>.<measuringPeriod>.<accumulation>.<flowDirection>.<commodity>.<measurementKind>.<interharmonic.numerator>.<interharmonic.denominator>.<argument.numerator>.<argument.denominator>.<tou>.<cpp>.<consumptionTier>.<phases>.<multiplier>.<unit>.<currency>.'
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
accumulation:
name: accumulation
description: Accumulation behaviour of a reading over time, usually 'measuringPeriod',
to be used with individual endpoints (as opposed to 'macroPeriod' and 'aggregate'
that are used to describe aggregations of data from individual endpoints).
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.accumulation
multivalued: false
alias: accumulation
owner: ReadingType
domain_of:
- ReadingType
range: AccumulationKind
required: false
aggregate:
name: aggregate
description: Salient attribute of the reading data aggregated from individual
endpoints. This is mainly used to define a mathematical operation carried out
over 'macroPeriod', but may also be used to describe an attribute of the data
when the 'macroPeriod' is not defined.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ReadingType.aggregate
multivalued: false
alias: aggregate
owner: ReadingType
domain_of:
- Equipment
- ReadingType
range: AggregateKind
required: false
argument:
name: argument
description: "Argument used to introduce numbers into the unit of measure description\
\ where they are needed (e.g., 4 where the measure needs an argument such as\
\ CEMI(n=4)). Most arguments used in practice however will be integers (i.e.,\
\ 'denominator'=1).\r\nValue 0 in 'numerator' and 'denominator' means not applicable.\r\
\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.argument
multivalued: false
alias: argument
owner: ReadingType
domain_of:
- ReadingType
range: RationalNumber
required: false
commodity:
name: commodity
description: Commodity being measured.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.commodity
multivalued: false
alias: commodity
owner: ReadingType
domain_of:
- ReadingType
range: CommodityKind
required: false
consumption_tier:
name: consumption_tier
description: "In case of common flat-rate pricing for power, in which all purchases\
\ are at a given rate, 'consumptionTier'=0. Otherwise, the value indicates the\
\ consumption tier, which can be used in conjunction with TOU or CPP pricing.\r\
\nConsumption tier pricing refers to the method of billing in which a certain\
\ \"block\" of energy is purchased/sold at one price, after which the next block\
\ of energy is purchased at another price, and so on, all throughout a defined\
\ period. At the start of the defined period, consumption is initially zero,\
\ and any usage is measured against the first consumption tier ('consumptionTier'=1).\
\ If this block of energy is consumed before the end of the period, energy consumption\
\ moves to be reconed against the second consumption tier ('consumptionTier'=2),\
\ and so on. At the end of the defined period, the consumption accumulator is\
\ reset, and usage within the 'consumptionTier'=1 restarts.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.consumptionTier
multivalued: false
alias: consumption_tier
owner: ReadingType
domain_of:
- ReadingType
range: integer
required: false
cpp:
name: cpp
description: "Critical peak period (CPP) bucket the reading value is attributed\
\ to. Value 0 means not applicable. Even though CPP is usually considered a\
\ specialised form of time of use 'tou', this attribute is defined explicitly\
\ for flexibility.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.cpp
multivalued: false
alias: cpp
owner: ReadingType
domain_of:
- ReadingType
range: integer
required: false
currency:
name: currency
description: Metering-specific currency.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ReadingType.currency
multivalued: false
alias: currency
owner: ReadingType
domain_of:
- DecimalQuantity
- ReadingType
range: Currency
required: false
flow_direction:
name: flow_direction
description: Flow direction for a reading where the direction of flow of the commodity
is important (for electricity measurements this includes current, energy, power,
and demand).
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.flowDirection
multivalued: false
alias: flow_direction
owner: ReadingType
domain_of:
- ReadingType
- DERMonitorableParameter
- TimeSeries
- Point
range: FlowDirectionKind
required: false
interharmonic:
name: interharmonic
description: "Indication of a \"harmonic\" or \"interharmonic\" basis for the\
\ measurement. Value 0 in 'numerator' and 'denominator' means not applicable.\r\
\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.interharmonic
multivalued: false
alias: interharmonic
owner: ReadingType
domain_of:
- ReadingType
range: ReadingInterharmonic
required: false
macro_period:
name: macro_period
description: Time period of interest that reflects how the reading is viewed or
captured over a long period of time.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.macroPeriod
multivalued: false
alias: macro_period
owner: ReadingType
domain_of:
- ReadingType
range: MacroPeriodKind
required: false
measurement_kind:
name: measurement_kind
description: 'Identifies "what" is being measured, as refinement of ''commodity''.
When combined with ''unit'', it provides detail to the unit of measure. For
example, ''energy'' with a unit of measure of ''kWh'' indicates to the user
that active energy is being measured, while with ''kVAh'' or ''kVArh'', it indicates
apparent energy and reactive energy, respectively. ''power'' can be combined
in a similar way with various power units of measure: Distortion power (''distortionVoltAmperes'')
with ''kVA'' is different from ''power'' with ''kVA''.'
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.measurementKind
multivalued: false
alias: measurement_kind
owner: ReadingType
domain_of:
- ReadingType
range: MeasurementKind
required: false
measuring_period:
name: measuring_period
description: "Time attribute inherent or fundamental to the reading value (as\
\ opposed to 'macroPeriod' that supplies an \"adjective\" to describe aspects\
\ of a time period with regard to the measurement). It refers to the way the\
\ value was originally measured and not to the frequency at which it is reported\
\ or presented. For example, an hourly interval of consumption data would have\
\ value 'hourly' as an attribute. However in the case of an hourly sampled voltage\
\ value, the meterReadings schema would carry the 'hourly' interval size information.\r\
\nIt is common for meters to report demand in a form that is measured over the\
\ course of a portion of an hour, while enterprise applications however commonly\
\ assume the demand (in kW or kVAr) normalised to 1 hour. The system that receives\
\ readings directly from the meter therefore shall perform this transformation\
\ before publishing readings for use by the other enterprise systems. The scalar\
\ used is chosen based on the block size (not any sub-interval size)."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.measuringPeriod
multivalued: false
alias: measuring_period
owner: ReadingType
domain_of:
- ReadingType
range: MeasuringPeriodKind
required: false
multiplier:
name: multiplier
description: Metering-specific multiplier.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ReadingType.multiplier
multivalued: false
alias: multiplier
owner: ReadingType
domain_of:
- VoltagePerReactivePower
- Length
- ConductancePerLength
- VolumeFlowRate
- Volume
- Voltage
- Temperature
- Admittance
- Impedance
- CostPerVolume
- SusceptancePerLength
- Money
- Minutes
- FloatQuantity
- CostPerEnergyUnit
- PerCent
- IntegerQuantity
- ApparentPower
- WaterLevel
- Displacement
- Damping
- Seconds
- ResistancePerLength
- Inductance
- AngleDegrees
- CostRate
- Speed
- Capacitance
- PU
- Pressure
- KiloActivePower
- ReactivePower
- StringQuantity
- ActivePowerChangeRate
- Hours
- Conductance
- RotationSpeed
- CurrentFlow
- Frequency
- AngleRadians
- ActivePower
- ReactancePerLength
- Resistance
- Reactance
- Susceptance
- RealEnergy
- Classification
- HeatRate
- Emission
- CostPerHeatUnit
- ActivePowerPerFrequency
- InductancePerLength
- CapacitancePerLength
- DecimalQuantity
- Area
- ActivePowerPerCurrentFlow
- Mass
- AccountingUnit
- ReadingType
- MagneticField
- ParticulateDensity
- Bearing
range: UnitMultiplier
required: false
phases:
name: phases
description: Metering-specific phase code.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ReadingType.phases
multivalued: false
alias: phases
owner: ReadingType
domain_of:
- Terminal
- Measurement
- SwitchingAction
- Fault
- TransformerTankEnd
- ReadingType
range: PhaseCode
required: false
tou:
name: tou
description: "Time of use (TOU) bucket the reading value is attributed to. Value\
\ 0 means not applicable.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.tou
multivalued: false
alias: tou
owner: ReadingType
domain_of:
- ReadingType
range: integer
required: false
unit:
name: unit
description: Metering-specific unit.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ReadingType.unit
multivalued: false
alias: unit
owner: ReadingType
domain_of:
- VoltagePerReactivePower
- Length
- ConductancePerLength
- VolumeFlowRate
- Volume
- Voltage
- Temperature
- Admittance
- Impedance
- CostPerVolume
- SusceptancePerLength
- Money
- Minutes
- FloatQuantity
- CostPerEnergyUnit
- PerCent
- IntegerQuantity
- ApparentPower
- WaterLevel
- Displacement
- Damping
- Seconds
- ResistancePerLength
- Inductance
- AngleDegrees
- CostRate
- Speed
- Capacitance
- PU
- Pressure
- KiloActivePower
- ReactivePower
- StringQuantity
- ActivePowerChangeRate
- Hours
- Conductance
- RotationSpeed
- CurrentFlow
- Frequency
- AngleRadians
- ActivePower
- ReactancePerLength
- Resistance
- Reactance
- Susceptance
- RealEnergy
- Classification
- HeatRate
- Emission
- CostPerHeatUnit
- ActivePowerPerFrequency
- InductancePerLength
- CapacitancePerLength
- DecimalQuantity
- Area
- ActivePowerPerCurrentFlow
- Mass
- ReadingType
- TimeSeries
- AceTariffType
- MagneticField
- ParticulateDensity
- Bearing
range: UnitSymbol
required: false
channel:
name: channel
description: Channel reporting/collecting register values with this type information.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.Channel
multivalued: false
alias: channel
owner: ReadingType
domain_of:
- ReadingType
range: Channel
required: false
meter_read_schedule:
name: meter_read_schedule
description: Meter read schedule for which the reading type applies
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ReadingType.MeterReadSchedule
multivalued: false
alias: meter_read_schedule
owner: ReadingType
domain_of:
- TimeSchedule
- UsagePoint
- CustomerAgreement
- CustomerAccount
- ReadingType
- EndDevice
- EndDeviceGroup
- UsagePointGroup
range: MeterReadSchedule
required: false
consumption_tariff_intervals:
name: consumption_tariff_intervals
description: All tariff intervals with consumption described by this reading type.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ReadingType.ConsumptionTariffIntervals
multivalued: true
alias: consumption_tariff_intervals
owner: ReadingType
domain_of:
- Charge
- TimeTariffInterval
- TariffProfile
- ReadingType
range: ConsumptionTariffInterval
required: false
pending_calculation:
name: pending_calculation
description: Pending calculation that produced this reading type.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.PendingCalculation
multivalued: false
alias: pending_calculation
owner: ReadingType
domain_of:
- ReadingType
- IntervalBlock
range: PendingCalculation
required: false
interval_blocks:
name: interval_blocks
description: All blocks containing interval reading values with this type information.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.IntervalBlocks
multivalued: true
alias: interval_blocks
owner: ReadingType
domain_of:
- ReadingType
- PendingCalculation
- MeterReading
- IntervalReading
range: IntervalBlock
required: false
metrology_requirements:
name: metrology_requirements
description: All metrology requirements that require this reading type to be collected.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:ReadingType.MetrologyRequirements
multivalued: true
alias: metrology_requirements
owner: ReadingType
domain_of:
- UsagePoint
- ReadingType
range: MetrologyRequirement
required: false
readings:
name: readings
description: All reading values with this type information.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:ReadingType.Readings
multivalued: true
alias: readings
owner: ReadingType
domain_of:
- ReadingType
- MeterReading
range: Reading
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: ReadingType
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: ReadingType
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: ReadingType
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: ReadingType
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: ReadingType
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: ReadingType
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: ReadingType
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: ReadingType
domain_of:
- IdentifiedObject
range: ChangeSetMember
required: false
class_uri: cim:ReadingType