Skip to content

Class: BaseReading

_Common representation for reading values. Note that a reading value may have multiple qualities, as produced by various systems ('ReadingQuality.source'). _

__

URI: cim:BaseReading

 classDiagram
    class BaseReading
      MeasurementValue <|-- BaseReading


      BaseReading <|-- Reading
      BaseReading <|-- IntervalReading


      BaseReading : alias_name

      BaseReading : bilateral_to_iopoint

          BaseReading --> ProvidedBilateralPoint : bilateral_to_iopoint

      BaseReading : calculation_method_hierarchy

          BaseReading --> CalculationMethodHierarchy : calculation_method_hierarchy

      BaseReading : description

      BaseReading : diagram_objects

          BaseReading --> DiagramObject : diagram_objects

      BaseReading : erp_person

          BaseReading --> OldPerson : erp_person

      BaseReading : instance_set

          BaseReading --> InstanceSet : instance_set

      BaseReading : iopoint_source

          BaseReading --> IOPointSource : iopoint_source

      BaseReading : m_rid

      BaseReading : measurement_value_quality

          BaseReading --> MeasurementValueQuality : measurement_value_quality

      BaseReading : measurement_value_source

          BaseReading --> MeasurementValueSource : measurement_value_source

      BaseReading : names

          BaseReading --> Name : names

      BaseReading : procedure_data_set

          BaseReading --> ProcedureDataSet : procedure_data_set

      BaseReading : properties_cimdata_object

          BaseReading --> ChangeSetMember : properties_cimdata_object

      BaseReading : reading_qualities

          BaseReading --> ReadingQuality : reading_qualities

      BaseReading : remote_source

          BaseReading --> RemoteSource : remote_source

      BaseReading : reported_date_time

      BaseReading : sensor_accuracy

          BaseReading --> PerCent : sensor_accuracy

      BaseReading : source

      BaseReading : targeting_cimdata_object

          BaseReading --> ChangeSetMember : targeting_cimdata_object

      BaseReading : time_period

          BaseReading --> DateTimeInterval : time_period

      BaseReading : time_stamp

      BaseReading : value

Inheritance

Slots

Name Cardinality and Range Description Inheritance
reported_date_time 0..1
date		 (used only when there are detailed auditing requirements) Date and time at wh... direct
source 0..1
String		 System that originally supplied the reading (e direct
time_period 0..1
DateTimeInterval		 Start and end of the period for those readings whose type has a time attribut... direct
value 0..1
String		 Value of this reading direct
reading_qualities 0..*
ReadingQuality		 All qualities of this reading direct
sensor_accuracy 0..1
PerCent		 The limit, expressed as a percentage of the sensor maximum, that errors will ... MeasurementValue
time_stamp 0..1
date		 The time when the value was last updated MeasurementValue
remote_source 0..1
RemoteSource		 Link to the physical telemetered point associated with this measurement MeasurementValue
measurement_value_quality 0..1
MeasurementValueQuality		 A MeasurementValue has a MeasurementValueQuality associated with it MeasurementValue
measurement_value_source 1..1
MeasurementValueSource		 A reference to the type of source that updates the MeasurementValue, e MeasurementValue
calculation_method_hierarchy 0..1
CalculationMethodHierarchy		 MeasurementValue
procedure_data_set 0..*
ProcedureDataSet		 Procedure data set that applies to this mesurement value MeasurementValue
erp_person 0..1
OldPerson		 MeasurementValue
bilateral_to_iopoint 0..*
ProvidedBilateralPoint		 Bilateral ICCP point for the measurement or control IOPoint
iopoint_source 0..1
IOPointSource		 Local merasurement value source for an ICCP point IOPoint
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
ReadingQuality reading range BaseReading

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: BaseReading
description: "Common representation for reading values. Note that a reading value\
  \ may have multiple qualities, as produced by various systems ('ReadingQuality.source').\r\
  \n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: MeasurementValue
attributes:
  reported_date_time:
    name: reported_date_time
    description: "(used only when there are detailed auditing requirements) Date and\
      \ time at which the reading was first delivered to the metering system.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BaseReading.reportedDateTime
    multivalued: false
    domain_of:
    - BaseReading
    range: date
    required: false
  source:
    name: source
    description: "System that originally supplied the reading (e.g., customer, AMI\
      \ system, handheld reading system, another enterprise system, etc.).\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:BaseReading.source
    multivalued: false
    domain_of:
    - Quality61850
    - BaseReading
    - ReadingQuality
    - TransmissionReservation
    - CRRSegment
    - BillDeterminant
    range: string
    required: false
  time_period:
    name: time_period
    description: "Start and end of the period for those readings whose type has a\
      \ time attribute such as 'billing', seasonal' or 'forTheSpecifiedPeriod'.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BaseReading.timePeriod
    multivalued: false
    domain_of:
    - BaseReading
    range: DateTimeInterval
    required: false
  value:
    name: value
    description: "Value of this reading.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:BaseReading.value
    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
    - Status
    - UserAttribute
    - AccountingUnit
    - BaseReading
    - EndDeviceEventDetail
    - MeterMultiplier
    - RegularTimePoint
    - AnalogValue
    - AnalogLimit
    - CommodityPrice
    - ChargeProfileData
    - StringMeasurementValue
    - Command
    - DiscreteValue
    - ValueToAlias
    - ServiceMultiplier
    - AnalyticScore
    - IrregularTimePoint
    - ActivePowerLimit
    - ApparentPowerLimit
    - CurrentLimit
    - VoltageLimit
    - AccumulatorValue
    - AccumulatorLimit
    - SetPoint
    - ScheduledActivePowerLimitValue
    - ScheduledApparentPowerLimitValue
    - ScheduledCurrentLimitValue
    - ScheduledVoltageLimitValue
    - MagneticField
    - ParticulateDensity
    - Bearing
    - PumpingShutDownCostSchedule
    - PumpingLevelSchedule
    - HourlyPreDispatchSchedule
    - PumpingCostSchedule
    - OpenTieSchedule
    - WheelingReferenceSchedule
    range: string
    required: false
  reading_qualities:
    name: reading_qualities
    description: All qualities of this reading.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BaseReading.ReadingQualities
    multivalued: true
    domain_of:
    - BaseReading
    - ReadingQualityType
    range: ReadingQuality
    required: false
class_uri: cim:BaseReading

Induced

name: BaseReading
description: "Common representation for reading values. Note that a reading value\
  \ may have multiple qualities, as produced by various systems ('ReadingQuality.source').\r\
  \n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: MeasurementValue
attributes:
  reported_date_time:
    name: reported_date_time
    description: "(used only when there are detailed auditing requirements) Date and\
      \ time at which the reading was first delivered to the metering system.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BaseReading.reportedDateTime
    multivalued: false
    alias: reported_date_time
    owner: BaseReading
    domain_of:
    - BaseReading
    range: date
    required: false
  source:
    name: source
    description: "System that originally supplied the reading (e.g., customer, AMI\
      \ system, handheld reading system, another enterprise system, etc.).\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:BaseReading.source
    multivalued: false
    alias: source
    owner: BaseReading
    domain_of:
    - Quality61850
    - BaseReading
    - ReadingQuality
    - TransmissionReservation
    - CRRSegment
    - BillDeterminant
    range: string
    required: false
  time_period:
    name: time_period
    description: "Start and end of the period for those readings whose type has a\
      \ time attribute such as 'billing', seasonal' or 'forTheSpecifiedPeriod'.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BaseReading.timePeriod
    multivalued: false
    alias: time_period
    owner: BaseReading
    domain_of:
    - BaseReading
    range: DateTimeInterval
    required: false
  value:
    name: value
    description: "Value of this reading.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:BaseReading.value
    multivalued: false
    alias: value
    owner: BaseReading
    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
    - Status
    - UserAttribute
    - AccountingUnit
    - BaseReading
    - EndDeviceEventDetail
    - MeterMultiplier
    - RegularTimePoint
    - AnalogValue
    - AnalogLimit
    - CommodityPrice
    - ChargeProfileData
    - StringMeasurementValue
    - Command
    - DiscreteValue
    - ValueToAlias
    - ServiceMultiplier
    - AnalyticScore
    - IrregularTimePoint
    - ActivePowerLimit
    - ApparentPowerLimit
    - CurrentLimit
    - VoltageLimit
    - AccumulatorValue
    - AccumulatorLimit
    - SetPoint
    - ScheduledActivePowerLimitValue
    - ScheduledApparentPowerLimitValue
    - ScheduledCurrentLimitValue
    - ScheduledVoltageLimitValue
    - MagneticField
    - ParticulateDensity
    - Bearing
    - PumpingShutDownCostSchedule
    - PumpingLevelSchedule
    - HourlyPreDispatchSchedule
    - PumpingCostSchedule
    - OpenTieSchedule
    - WheelingReferenceSchedule
    range: string
    required: false
  reading_qualities:
    name: reading_qualities
    description: All qualities of this reading.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:BaseReading.ReadingQualities
    multivalued: true
    alias: reading_qualities
    owner: BaseReading
    domain_of:
    - BaseReading
    - ReadingQualityType
    range: ReadingQuality
    required: false
  sensor_accuracy:
    name: sensor_accuracy
    description: The limit, expressed as a percentage of the sensor maximum, that
      errors will not exceed when the sensor is used under  reference conditions.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MeasurementValue.sensorAccuracy
    multivalued: false
    alias: sensor_accuracy
    owner: BaseReading
    domain_of:
    - MeasurementValue
    range: PerCent
    required: false
  time_stamp:
    name: time_stamp
    description: The time when the value was last updated.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MeasurementValue.timeStamp
    multivalued: false
    alias: time_stamp
    owner: BaseReading
    domain_of:
    - NetworkModelProjectChangeVersion
    - MeasurementValue
    - ReadingQuality
    - DERCurveData
    - Control
    - ChargeProfileData
    - SCADAInformation
    range: date
    required: false
  remote_source:
    name: remote_source
    description: Link to the physical telemetered point associated with this measurement.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MeasurementValue.RemoteSource
    multivalued: false
    alias: remote_source
    owner: BaseReading
    domain_of:
    - MeasurementValue
    range: RemoteSource
    required: false
  measurement_value_quality:
    name: measurement_value_quality
    description: A MeasurementValue has a MeasurementValueQuality associated with
      it.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MeasurementValue.MeasurementValueQuality
    multivalued: false
    alias: measurement_value_quality
    owner: BaseReading
    domain_of:
    - MeasurementValue
    range: MeasurementValueQuality
    required: false
  measurement_value_source:
    name: measurement_value_source
    description: A reference to the type of source that updates the MeasurementValue,
      e.g. SCADA, CCLink, manual, etc. User conventions for the names of sources are
      contained in the introduction to IEC 61970-301.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MeasurementValue.MeasurementValueSource
    multivalued: false
    alias: measurement_value_source
    owner: BaseReading
    domain_of:
    - MeasurementValue
    range: MeasurementValueSource
    required: true
  calculation_method_hierarchy:
    name: calculation_method_hierarchy
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:MeasurementValue.CalculationMethodHierarchy
    multivalued: false
    alias: calculation_method_hierarchy
    owner: BaseReading
    domain_of:
    - MeasurementValue
    - CalculationMethodOrder
    - Measurement
    range: CalculationMethodHierarchy
    required: false
  procedure_data_set:
    name: procedure_data_set
    description: Procedure data set that applies to this mesurement value.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MeasurementValue.ProcedureDataSet
    multivalued: true
    alias: procedure_data_set
    owner: BaseReading
    domain_of:
    - Asset
    - WorkTask
    - MeasurementValue
    range: ProcedureDataSet
    required: false
  erp_person:
    name: erp_person
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MeasurementValue.ErpPerson
    multivalued: false
    alias: erp_person
    owner: BaseReading
    domain_of:
    - Skill
    - PersonOrganisationRole
    - MeasurementValue
    range: OldPerson
    required: false
  bilateral_to_iopoint:
    name: bilateral_to_iopoint
    description: Bilateral ICCP point for the measurement or control.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IOPoint.BilateralToIOPoint
    multivalued: true
    alias: bilateral_to_iopoint
    owner: BaseReading
    domain_of:
    - IOPoint
    range: ProvidedBilateralPoint
    required: false
  iopoint_source:
    name: iopoint_source
    description: Local merasurement value source for an ICCP point.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IOPoint.IOPointSource
    multivalued: false
    alias: iopoint_source
    owner: BaseReading
    domain_of:
    - IOPoint
    range: IOPointSource
    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: BaseReading
    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: BaseReading
    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: BaseReading
    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: BaseReading
    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: BaseReading
    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: BaseReading
    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: BaseReading
    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: BaseReading
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:BaseReading