Class: UsagePoint
Logical or physical point in the network to which readings or events may be attributed. Used at the place where a physical or virtual meter may be located; however, it is not required that a meter be present.
URI: cim:UsagePoint
classDiagram
class UsagePoint
IdentifiedObject <|-- UsagePoint
UsagePoint <|-- MarketEvaluationPoint
UsagePoint : alias_name
UsagePoint : ami_billing_ready
UsagePoint --> AmiBillingReadyKind : ami_billing_ready
UsagePoint : check_billing
UsagePoint : configuration_events
UsagePoint --> ConfigurationEvent : configuration_events
UsagePoint : connection_category
UsagePoint : connection_state
UsagePoint --> UsagePointConnectedKind : connection_state
UsagePoint : customer_agreement
UsagePoint --> CustomerAgreement : customer_agreement
UsagePoint : description
UsagePoint : diagram_objects
UsagePoint --> DiagramObject : diagram_objects
UsagePoint : disconnection_method
UsagePoint : end_device_controls
UsagePoint --> EndDeviceControl : end_device_controls
UsagePoint : end_device_events
UsagePoint --> EndDeviceEvent : end_device_events
UsagePoint : end_devices
UsagePoint --> EndDevice : end_devices
UsagePoint : environmental_monitoring_station
UsagePoint --> EnvironmentalMonitoringStation : environmental_monitoring_station
UsagePoint : equipments
UsagePoint --> Equipment : equipments
UsagePoint : estimated_load
UsagePoint --> CurrentFlow : estimated_load
UsagePoint : grounded
UsagePoint : instance_set
UsagePoint --> InstanceSet : instance_set
UsagePoint : is_sdp
UsagePoint : is_virtual
UsagePoint : m_rid
UsagePoint : meter_read_schedule
UsagePoint --> MeterReadSchedule : meter_read_schedule
UsagePoint : meter_readings
UsagePoint --> MeterReading : meter_readings
UsagePoint : meter_service_work_tasks
UsagePoint --> MeterWorkTask : meter_service_work_tasks
UsagePoint : metrology_requirements
UsagePoint --> MetrologyRequirement : metrology_requirements
UsagePoint : minimal_usage_expected
UsagePoint : names
UsagePoint --> Name : names
UsagePoint : nominal_service_voltage
UsagePoint --> Voltage : nominal_service_voltage
UsagePoint : outage
UsagePoint --> Outage : outage
UsagePoint : outage_region
UsagePoint : phase_code
UsagePoint --> PhaseCode : phase_code
UsagePoint : phase_count
UsagePoint : physical_connection_capacity
UsagePoint --> DecimalQuantity : physical_connection_capacity
UsagePoint : planned_outage_notification
UsagePoint --> PlannedOutageNotification : planned_outage_notification
UsagePoint : pricing_structures
UsagePoint --> PricingStructure : pricing_structures
UsagePoint : properties_cimdata_object
UsagePoint --> ChangeSetMember : properties_cimdata_object
UsagePoint : rated_current
UsagePoint --> CurrentFlow : rated_current
UsagePoint : rated_power
UsagePoint --> ActivePower : rated_power
UsagePoint : read_cycle
UsagePoint : read_route
UsagePoint : register
UsagePoint --> Register : register
UsagePoint : service_category
UsagePoint --> ServiceCategory : service_category
UsagePoint : service_delivery_remark
UsagePoint : service_location
UsagePoint --> ServiceLocation : service_location
UsagePoint : service_multipliers
UsagePoint --> ServiceMultiplier : service_multipliers
UsagePoint : service_priority
UsagePoint : service_supplier
UsagePoint --> ServiceSupplier : service_supplier
UsagePoint : targeting_cimdata_object
UsagePoint --> ChangeSetMember : targeting_cimdata_object
UsagePoint : usage_point_groups
UsagePoint --> UsagePointGroup : usage_point_groups
UsagePoint : usage_point_location
UsagePoint --> UsagePointLocation : usage_point_location
Inheritance
- IdentifiedObject
- UsagePoint
Slots
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| ami_billing_ready | 0..1 AmiBillingReadyKind |
Tracks the lifecycle of the metering installation at a usage point with respe... | direct |
| check_billing | 0..1 Boolean |
True if as a result of an inspection or otherwise, there is a reason to suspe... | direct |
| connection_category | 0..1 String |
A code used to specify the connection category, e | direct |
| connection_state | 0..1 UsagePointConnectedKind |
State of the usage point with respect to connection to the network | direct |
| disconnection_method | 0..1 String |
Is an indication of how the usage point is physically connected or disconnect... | direct |
| estimated_load | 0..1 CurrentFlow |
Estimated load | direct |
| grounded | 0..1 Boolean |
True if grounded | direct |
| is_sdp | 0..1 Boolean |
If true, this usage point is a service delivery point, i | direct |
| is_virtual | 0..1 Boolean |
If true, this usage point is virtual, i | direct |
| minimal_usage_expected | 0..1 Boolean |
If true, minimal or zero usage is expected at this usage point for situations... | direct |
| nominal_service_voltage | 0..1 Voltage |
Nominal service voltage | direct |
| outage_region | 0..1 String |
Outage region in which this usage point is located | direct |
| phase_code | 0..1 PhaseCode |
Phase code | direct |
| phase_count | 0..1 Integer |
Number of potential phases the Usage Point supports, typically 0, 1 or 3 | direct |
| physical_connection_capacity | 0..1 DecimalQuantity |
Quantitative information about the maximum physical capacity of the connectio... | direct |
| rated_current | 0..1 CurrentFlow |
Current flow that this usage point is configured to deliver | direct |
| rated_power | 0..1 ActivePower |
Active power that this usage point is configured to deliver | direct |
| read_cycle | 0..1 String |
Cycle day on which the meter for this usage point will normally be read | direct |
| read_route | 0..1 String |
Identifier of the route to which this usage point is assigned for purposes of... | direct |
| service_delivery_remark | 0..1 String |
Remarks about this usage point, for example the reason for it being rated wit... | direct |
| service_priority | 0..1 String |
Priority of service for this usage point | direct |
| register | 0..* Register |
All registers for quantities metered at this Usage Point | direct |
| equipments | 0..* Equipment |
All equipment connecting this usage point to the electrical grid | direct |
| end_devices | 0..* EndDevice |
All end devices at this usage point | direct |
| service_multipliers | 0..* ServiceMultiplier |
All multipliers applied at this usage point | direct |
| configuration_events | 0..* ConfigurationEvent |
All configuration events created for this usage point | direct |
| service_category | 0..1 ServiceCategory |
Service category delivered by this usage point | direct |
| meter_read_schedule | 0..1 MeterReadSchedule |
Meter read schedule that applies to the usage point | direct |
| customer_agreement | 0..1 CustomerAgreement |
Customer agreement regulating this service delivery point | direct |
| outage | 0..* Outage |
All outages at this Usage Point | direct |
| planned_outage_notification | 0..* PlannedOutageNotification |
The planned outage notification for the specified Usage Point | direct |
| metrology_requirements | 0..* MetrologyRequirement |
All metrology requirements for this usage point | direct |
| meter_service_work_tasks | 0..* MeterWorkTask |
All meter service work tasks at this usage point | direct |
| usage_point_groups | 0..* UsagePointGroup |
All groups to which this usage point belongs | direct |
| service_supplier | 0..1 ServiceSupplier |
ServiceSupplier (utility) utilising this usage point to deliver a service | direct |
| end_device_controls | 0..* EndDeviceControl |
All end device controls sending commands to this usage point | direct |
| end_device_events | 0..* EndDeviceEvent |
All end device events reported for this usage point | direct |
| service_location | 0..1 ServiceLocation |
Service location where the service delivered by this usage point is consumed | direct |
| usage_point_location | 0..1 UsagePointLocation |
Location of this usage point | direct |
| pricing_structures | 0..* PricingStructure |
All pricing structures applicable to this service delivery point (with prepay... | direct |
| meter_readings | 0..* MeterReading |
All meter readings obtained from this usage point | direct |
| environmental_monitoring_station | 0..1 EnvironmentalMonitoringStation |
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
Identifier and Mapping Information
Schema Source
- from schema: https://cim.ucaiug.io/ns#TC57CIM
Mappings
| Mapping Type | Mapped Value |
|---|---|
| self | cim:UsagePoint |
| native | cim:UsagePoint |
LinkML Source
Direct
name: UsagePoint
description: Logical or physical point in the network to which readings or events
may be attributed. Used at the place where a physical or virtual meter may be located;
however, it is not required that a meter be present.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
ami_billing_ready:
name: ami_billing_ready
description: "Tracks the lifecycle of the metering installation at a usage point\
\ with respect to readiness for billing via advanced metering infrastructure\
\ reads.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.amiBillingReady
multivalued: false
domain_of:
- UsagePoint
range: AmiBillingReadyKind
required: false
check_billing:
name: check_billing
description: True if as a result of an inspection or otherwise, there is a reason
to suspect that a previous billing may have been performed with erroneous data.
Value should be reset once this potential discrepancy has been resolved.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.checkBilling
multivalued: false
domain_of:
- UsagePoint
range: boolean
required: false
connection_category:
name: connection_category
description: A code used to specify the connection category, e.g., low voltage
or low pressure, where the usage point is defined.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.connectionCategory
multivalued: false
domain_of:
- UsagePoint
- Meter
range: string
required: false
connection_state:
name: connection_state
description: "State of the usage point with respect to connection to the network.\r\
\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.connectionState
multivalued: false
domain_of:
- UsagePoint
range: UsagePointConnectedKind
required: false
disconnection_method:
name: disconnection_method
description: Is an indication of how the usage point is physically connected or
disconnected.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.disconnectionMethod
multivalued: false
domain_of:
- UsagePoint
range: string
required: false
estimated_load:
name: estimated_load
description: Estimated load.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.estimatedLoad
multivalued: false
domain_of:
- UsagePoint
range: CurrentFlow
required: false
grounded:
name: grounded
description: True if grounded.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:UsagePoint.grounded
multivalued: false
domain_of:
- TransformerEnd
- UsagePoint
- ShuntCompensator
- EnergyConsumer
range: boolean
required: false
is_sdp:
name: is_sdp
description: "If true, this usage point is a service delivery point, i.e., a usage\
\ point where the ownership of the service changes hands.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.isSdp
multivalued: false
domain_of:
- UsagePoint
range: boolean
required: false
is_virtual:
name: is_virtual
description: If true, this usage point is virtual, i.e., no physical location
exists in the network where a meter could be located to collect the meter readings.
For example, one may define a virtual usage point to serve as an aggregation
of usage for all of a company's premises distributed widely across the distribution
territory. Otherwise, the usage point is physical, i.e., there is a logical
point in the network where a meter could be located to collect meter readings.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.isVirtual
multivalued: false
domain_of:
- UsagePoint
- EndDevice
- Register
- Channel
range: boolean
required: false
minimal_usage_expected:
name: minimal_usage_expected
description: If true, minimal or zero usage is expected at this usage point for
situations such as premises vacancy, logical or physical disconnect. It is used
for readings validation and estimation.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.minimalUsageExpected
multivalued: false
domain_of:
- UsagePoint
range: boolean
required: false
nominal_service_voltage:
name: nominal_service_voltage
description: "Nominal service voltage.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.nominalServiceVoltage
multivalued: false
domain_of:
- UsagePoint
range: Voltage
required: false
outage_region:
name: outage_region
description: "Outage region in which this usage point is located.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.outageRegion
multivalued: false
domain_of:
- UsagePoint
range: string
required: false
phase_code:
name: phase_code
description: "Phase code. Number of wires and specific nominal phases can be deduced\
\ from enumeration literal values. For example, ABCN is three-phase, four-wire,\
\ s12n (splitSecondary12N) is single-phase, three-wire, and s1n and s2n are\
\ single-phase, two-wire.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.phaseCode
multivalued: false
domain_of:
- UsagePoint
- CompositeSwitchInfo
- DiagnosisDataSet
range: PhaseCode
required: false
phase_count:
name: phase_count
description: "Number of potential phases the Usage Point supports, typically 0,\
\ 1 or 3.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.phaseCount
multivalued: false
domain_of:
- UsagePoint
- EndDeviceInfo
- CompositeSwitchInfo
range: integer
required: false
physical_connection_capacity:
name: physical_connection_capacity
description: Quantitative information about the maximum physical capacity of the
connection for the usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.physicalConnectionCapacity
multivalued: false
domain_of:
- UsagePoint
range: DecimalQuantity
required: false
rated_current:
name: rated_current
description: "Current flow that this usage point is configured to deliver.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.ratedCurrent
multivalued: false
domain_of:
- UsagePoint
- Switch
- EndDeviceInfo
- WireInfo
- SwitchPhase
- CurrentTransformerInfo
- SwitchInfo
- ShuntCompensatorInfo
- BushingInfo
- TapChangerInfo
- BusbarSectionInfo
range: CurrentFlow
required: false
rated_power:
name: rated_power
description: "Active power that this usage point is configured to deliver.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.ratedPower
multivalued: false
domain_of:
- UsagePoint
range: ActivePower
required: false
read_cycle:
name: read_cycle
description: "Cycle day on which the meter for this usage point will normally\
\ be read. Usually correlated with the billing cycle.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.readCycle
multivalued: false
domain_of:
- UsagePoint
range: string
required: false
read_route:
name: read_route
description: "Identifier of the route to which this usage point is assigned for\
\ purposes of meter reading. Typically used to configure hand held meter reading\
\ systems prior to collection of reads.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.readRoute
multivalued: false
domain_of:
- UsagePoint
range: string
required: false
service_delivery_remark:
name: service_delivery_remark
description: "Remarks about this usage point, for example the reason for it being\
\ rated with a non-nominal priority.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.serviceDeliveryRemark
multivalued: false
domain_of:
- UsagePoint
range: string
required: false
service_priority:
name: service_priority
description: "Priority of service for this usage point. Note that usage points\
\ at the same service location can have different priorities.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.servicePriority
multivalued: false
domain_of:
- UsagePoint
range: string
required: false
register:
name: register
description: All registers for quantities metered at this Usage Point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.Register
multivalued: true
domain_of:
- UsagePoint
- Channel
range: Register
required: false
equipments:
name: equipments
description: All equipment connecting this usage point to the electrical grid.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:UsagePoint.Equipments
multivalued: true
domain_of:
- EquipmentContainer
- UsagePoint
- OperationalRestriction
- Outage
range: Equipment
required: false
end_devices:
name: end_devices
description: All end devices at this usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:UsagePoint.EndDevices
multivalued: true
domain_of:
- Customer
- UsagePoint
- EndDeviceControl
- EndDeviceGroup
- ServiceLocation
- EndDeviceInfo
range: EndDevice
required: false
service_multipliers:
name: service_multipliers
description: All multipliers applied at this usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.ServiceMultipliers
multivalued: true
domain_of:
- UsagePoint
range: ServiceMultiplier
required: false
configuration_events:
name: configuration_events
description: All configuration events created for this usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:UsagePoint.ConfigurationEvents
multivalued: true
domain_of:
- Asset
- Document
- PersonRole
- OrganisationRole
- Location
- UsagePoint
- ServiceCategory
range: ConfigurationEvent
required: false
service_category:
name: service_category
description: Service category delivered by this usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.ServiceCategory
multivalued: false
domain_of:
- UsagePoint
- CustomerAgreement
- PricingStructure
range: ServiceCategory
required: false
meter_read_schedule:
name: meter_read_schedule
description: Meter read schedule that applies to the usage point
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:UsagePoint.MeterReadSchedule
multivalued: false
domain_of:
- TimeSchedule
- UsagePoint
- CustomerAgreement
- CustomerAccount
- ReadingType
- EndDevice
- EndDeviceGroup
- UsagePointGroup
range: MeterReadSchedule
required: false
customer_agreement:
name: customer_agreement
description: Customer agreement regulating this service delivery point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:UsagePoint.CustomerAgreement
multivalued: false
domain_of:
- MeterReadSchedule
- UsagePoint
- AuxiliaryAgreement
- MeterReading
range: CustomerAgreement
required: false
outage:
name: outage
description: All outages at this Usage Point
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:UsagePoint.Outage
multivalued: true
domain_of:
- Incident
- SwitchingPlan
- UsagePoint
- ConductingEquipment
- Crew
- EstimatedRestorationTime
- OutageArea
- Fault
range: Outage
required: false
planned_outage_notification:
name: planned_outage_notification
description: The planned outage notification for the specified Usage Point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:UsagePoint.PlannedOutageNotification
multivalued: true
domain_of:
- Customer
- SwitchingPlan
- UsagePoint
range: PlannedOutageNotification
required: false
metrology_requirements:
name: metrology_requirements
description: All metrology requirements for this usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.MetrologyRequirements
multivalued: true
domain_of:
- UsagePoint
- ReadingType
range: MetrologyRequirement
required: false
meter_service_work_tasks:
name: meter_service_work_tasks
description: All meter service work tasks at this usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.MeterServiceWorkTasks
multivalued: true
domain_of:
- UsagePoint
range: MeterWorkTask
required: false
usage_point_groups:
name: usage_point_groups
description: All groups to which this usage point belongs.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.UsagePointGroups
multivalued: true
domain_of:
- UsagePoint
- EndDeviceControl
- DemandResponseProgram
range: UsagePointGroup
required: false
service_supplier:
name: service_supplier
description: ServiceSupplier (utility) utilising this usage point to deliver a
service.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.ServiceSupplier
multivalued: false
domain_of:
- UsagePoint
- CustomerAgreement
- BankAccount
range: ServiceSupplier
required: false
end_device_controls:
name: end_device_controls
description: All end device controls sending commands to this usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.EndDeviceControls
multivalued: true
domain_of:
- UsagePoint
- EndDevice
- EndDeviceGroup
- UsagePointGroup
- EndDeviceControlType
range: EndDeviceControl
required: false
end_device_events:
name: end_device_events
description: All end device events reported for this usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.EndDeviceEvents
multivalued: true
domain_of:
- UsagePoint
- MeterReading
- EndDevice
- EndDeviceEventType
range: EndDeviceEvent
required: false
service_location:
name: service_location
description: Service location where the service delivered by this usage point
is consumed.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:UsagePoint.ServiceLocation
multivalued: false
domain_of:
- Asset
- UsagePoint
- EndDevice
- ServiceRequest
- TroubleTicket
range: ServiceLocation
required: false
usage_point_location:
name: usage_point_location
description: Location of this usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.UsagePointLocation
multivalued: false
domain_of:
- UsagePoint
range: UsagePointLocation
required: false
pricing_structures:
name: pricing_structures
description: All pricing structures applicable to this service delivery point
(with prepayment meter running as a stand-alone device, with no CustomerAgreement
or Customer).
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.PricingStructures
multivalued: true
domain_of:
- UsagePoint
- CustomerAgreement
- ServiceCategory
- Tariff
range: PricingStructure
required: false
meter_readings:
name: meter_readings
description: All meter readings obtained from this usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.MeterReadings
multivalued: true
domain_of:
- UsagePoint
- CustomerAgreement
- Reading
- Meter
range: MeterReading
required: false
environmental_monitoring_station:
name: environmental_monitoring_station
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:UsagePoint.EnvironmentalMonitoringStation
multivalued: false
domain_of:
- Location
- UsagePoint
- TimeSeries
- ReportingCapability
- EnvironmentalAnalog
range: EnvironmentalMonitoringStation
required: false
class_uri: cim:UsagePoint
Induced
name: UsagePoint
description: Logical or physical point in the network to which readings or events
may be attributed. Used at the place where a physical or virtual meter may be located;
however, it is not required that a meter be present.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
ami_billing_ready:
name: ami_billing_ready
description: "Tracks the lifecycle of the metering installation at a usage point\
\ with respect to readiness for billing via advanced metering infrastructure\
\ reads.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.amiBillingReady
multivalued: false
alias: ami_billing_ready
owner: UsagePoint
domain_of:
- UsagePoint
range: AmiBillingReadyKind
required: false
check_billing:
name: check_billing
description: True if as a result of an inspection or otherwise, there is a reason
to suspect that a previous billing may have been performed with erroneous data.
Value should be reset once this potential discrepancy has been resolved.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.checkBilling
multivalued: false
alias: check_billing
owner: UsagePoint
domain_of:
- UsagePoint
range: boolean
required: false
connection_category:
name: connection_category
description: A code used to specify the connection category, e.g., low voltage
or low pressure, where the usage point is defined.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.connectionCategory
multivalued: false
alias: connection_category
owner: UsagePoint
domain_of:
- UsagePoint
- Meter
range: string
required: false
connection_state:
name: connection_state
description: "State of the usage point with respect to connection to the network.\r\
\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.connectionState
multivalued: false
alias: connection_state
owner: UsagePoint
domain_of:
- UsagePoint
range: UsagePointConnectedKind
required: false
disconnection_method:
name: disconnection_method
description: Is an indication of how the usage point is physically connected or
disconnected.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.disconnectionMethod
multivalued: false
alias: disconnection_method
owner: UsagePoint
domain_of:
- UsagePoint
range: string
required: false
estimated_load:
name: estimated_load
description: Estimated load.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.estimatedLoad
multivalued: false
alias: estimated_load
owner: UsagePoint
domain_of:
- UsagePoint
range: CurrentFlow
required: false
grounded:
name: grounded
description: True if grounded.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:UsagePoint.grounded
multivalued: false
alias: grounded
owner: UsagePoint
domain_of:
- TransformerEnd
- UsagePoint
- ShuntCompensator
- EnergyConsumer
range: boolean
required: false
is_sdp:
name: is_sdp
description: "If true, this usage point is a service delivery point, i.e., a usage\
\ point where the ownership of the service changes hands.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.isSdp
multivalued: false
alias: is_sdp
owner: UsagePoint
domain_of:
- UsagePoint
range: boolean
required: false
is_virtual:
name: is_virtual
description: If true, this usage point is virtual, i.e., no physical location
exists in the network where a meter could be located to collect the meter readings.
For example, one may define a virtual usage point to serve as an aggregation
of usage for all of a company's premises distributed widely across the distribution
territory. Otherwise, the usage point is physical, i.e., there is a logical
point in the network where a meter could be located to collect meter readings.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.isVirtual
multivalued: false
alias: is_virtual
owner: UsagePoint
domain_of:
- UsagePoint
- EndDevice
- Register
- Channel
range: boolean
required: false
minimal_usage_expected:
name: minimal_usage_expected
description: If true, minimal or zero usage is expected at this usage point for
situations such as premises vacancy, logical or physical disconnect. It is used
for readings validation and estimation.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.minimalUsageExpected
multivalued: false
alias: minimal_usage_expected
owner: UsagePoint
domain_of:
- UsagePoint
range: boolean
required: false
nominal_service_voltage:
name: nominal_service_voltage
description: "Nominal service voltage.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.nominalServiceVoltage
multivalued: false
alias: nominal_service_voltage
owner: UsagePoint
domain_of:
- UsagePoint
range: Voltage
required: false
outage_region:
name: outage_region
description: "Outage region in which this usage point is located.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.outageRegion
multivalued: false
alias: outage_region
owner: UsagePoint
domain_of:
- UsagePoint
range: string
required: false
phase_code:
name: phase_code
description: "Phase code. Number of wires and specific nominal phases can be deduced\
\ from enumeration literal values. For example, ABCN is three-phase, four-wire,\
\ s12n (splitSecondary12N) is single-phase, three-wire, and s1n and s2n are\
\ single-phase, two-wire.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.phaseCode
multivalued: false
alias: phase_code
owner: UsagePoint
domain_of:
- UsagePoint
- CompositeSwitchInfo
- DiagnosisDataSet
range: PhaseCode
required: false
phase_count:
name: phase_count
description: "Number of potential phases the Usage Point supports, typically 0,\
\ 1 or 3.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.phaseCount
multivalued: false
alias: phase_count
owner: UsagePoint
domain_of:
- UsagePoint
- EndDeviceInfo
- CompositeSwitchInfo
range: integer
required: false
physical_connection_capacity:
name: physical_connection_capacity
description: Quantitative information about the maximum physical capacity of the
connection for the usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.physicalConnectionCapacity
multivalued: false
alias: physical_connection_capacity
owner: UsagePoint
domain_of:
- UsagePoint
range: DecimalQuantity
required: false
rated_current:
name: rated_current
description: "Current flow that this usage point is configured to deliver.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.ratedCurrent
multivalued: false
alias: rated_current
owner: UsagePoint
domain_of:
- UsagePoint
- Switch
- EndDeviceInfo
- WireInfo
- SwitchPhase
- CurrentTransformerInfo
- SwitchInfo
- ShuntCompensatorInfo
- BushingInfo
- TapChangerInfo
- BusbarSectionInfo
range: CurrentFlow
required: false
rated_power:
name: rated_power
description: "Active power that this usage point is configured to deliver.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.ratedPower
multivalued: false
alias: rated_power
owner: UsagePoint
domain_of:
- UsagePoint
range: ActivePower
required: false
read_cycle:
name: read_cycle
description: "Cycle day on which the meter for this usage point will normally\
\ be read. Usually correlated with the billing cycle.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.readCycle
multivalued: false
alias: read_cycle
owner: UsagePoint
domain_of:
- UsagePoint
range: string
required: false
read_route:
name: read_route
description: "Identifier of the route to which this usage point is assigned for\
\ purposes of meter reading. Typically used to configure hand held meter reading\
\ systems prior to collection of reads.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.readRoute
multivalued: false
alias: read_route
owner: UsagePoint
domain_of:
- UsagePoint
range: string
required: false
service_delivery_remark:
name: service_delivery_remark
description: "Remarks about this usage point, for example the reason for it being\
\ rated with a non-nominal priority.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.serviceDeliveryRemark
multivalued: false
alias: service_delivery_remark
owner: UsagePoint
domain_of:
- UsagePoint
range: string
required: false
service_priority:
name: service_priority
description: "Priority of service for this usage point. Note that usage points\
\ at the same service location can have different priorities.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.servicePriority
multivalued: false
alias: service_priority
owner: UsagePoint
domain_of:
- UsagePoint
range: string
required: false
register:
name: register
description: All registers for quantities metered at this Usage Point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.Register
multivalued: true
alias: register
owner: UsagePoint
domain_of:
- UsagePoint
- Channel
range: Register
required: false
equipments:
name: equipments
description: All equipment connecting this usage point to the electrical grid.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:UsagePoint.Equipments
multivalued: true
alias: equipments
owner: UsagePoint
domain_of:
- EquipmentContainer
- UsagePoint
- OperationalRestriction
- Outage
range: Equipment
required: false
end_devices:
name: end_devices
description: All end devices at this usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:UsagePoint.EndDevices
multivalued: true
alias: end_devices
owner: UsagePoint
domain_of:
- Customer
- UsagePoint
- EndDeviceControl
- EndDeviceGroup
- ServiceLocation
- EndDeviceInfo
range: EndDevice
required: false
service_multipliers:
name: service_multipliers
description: All multipliers applied at this usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.ServiceMultipliers
multivalued: true
alias: service_multipliers
owner: UsagePoint
domain_of:
- UsagePoint
range: ServiceMultiplier
required: false
configuration_events:
name: configuration_events
description: All configuration events created for this usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:UsagePoint.ConfigurationEvents
multivalued: true
alias: configuration_events
owner: UsagePoint
domain_of:
- Asset
- Document
- PersonRole
- OrganisationRole
- Location
- UsagePoint
- ServiceCategory
range: ConfigurationEvent
required: false
service_category:
name: service_category
description: Service category delivered by this usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.ServiceCategory
multivalued: false
alias: service_category
owner: UsagePoint
domain_of:
- UsagePoint
- CustomerAgreement
- PricingStructure
range: ServiceCategory
required: false
meter_read_schedule:
name: meter_read_schedule
description: Meter read schedule that applies to the usage point
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:UsagePoint.MeterReadSchedule
multivalued: false
alias: meter_read_schedule
owner: UsagePoint
domain_of:
- TimeSchedule
- UsagePoint
- CustomerAgreement
- CustomerAccount
- ReadingType
- EndDevice
- EndDeviceGroup
- UsagePointGroup
range: MeterReadSchedule
required: false
customer_agreement:
name: customer_agreement
description: Customer agreement regulating this service delivery point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:UsagePoint.CustomerAgreement
multivalued: false
alias: customer_agreement
owner: UsagePoint
domain_of:
- MeterReadSchedule
- UsagePoint
- AuxiliaryAgreement
- MeterReading
range: CustomerAgreement
required: false
outage:
name: outage
description: All outages at this Usage Point
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:UsagePoint.Outage
multivalued: true
alias: outage
owner: UsagePoint
domain_of:
- Incident
- SwitchingPlan
- UsagePoint
- ConductingEquipment
- Crew
- EstimatedRestorationTime
- OutageArea
- Fault
range: Outage
required: false
planned_outage_notification:
name: planned_outage_notification
description: The planned outage notification for the specified Usage Point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:UsagePoint.PlannedOutageNotification
multivalued: true
alias: planned_outage_notification
owner: UsagePoint
domain_of:
- Customer
- SwitchingPlan
- UsagePoint
range: PlannedOutageNotification
required: false
metrology_requirements:
name: metrology_requirements
description: All metrology requirements for this usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.MetrologyRequirements
multivalued: true
alias: metrology_requirements
owner: UsagePoint
domain_of:
- UsagePoint
- ReadingType
range: MetrologyRequirement
required: false
meter_service_work_tasks:
name: meter_service_work_tasks
description: All meter service work tasks at this usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.MeterServiceWorkTasks
multivalued: true
alias: meter_service_work_tasks
owner: UsagePoint
domain_of:
- UsagePoint
range: MeterWorkTask
required: false
usage_point_groups:
name: usage_point_groups
description: All groups to which this usage point belongs.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.UsagePointGroups
multivalued: true
alias: usage_point_groups
owner: UsagePoint
domain_of:
- UsagePoint
- EndDeviceControl
- DemandResponseProgram
range: UsagePointGroup
required: false
service_supplier:
name: service_supplier
description: ServiceSupplier (utility) utilising this usage point to deliver a
service.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.ServiceSupplier
multivalued: false
alias: service_supplier
owner: UsagePoint
domain_of:
- UsagePoint
- CustomerAgreement
- BankAccount
range: ServiceSupplier
required: false
end_device_controls:
name: end_device_controls
description: All end device controls sending commands to this usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.EndDeviceControls
multivalued: true
alias: end_device_controls
owner: UsagePoint
domain_of:
- UsagePoint
- EndDevice
- EndDeviceGroup
- UsagePointGroup
- EndDeviceControlType
range: EndDeviceControl
required: false
end_device_events:
name: end_device_events
description: All end device events reported for this usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.EndDeviceEvents
multivalued: true
alias: end_device_events
owner: UsagePoint
domain_of:
- UsagePoint
- MeterReading
- EndDevice
- EndDeviceEventType
range: EndDeviceEvent
required: false
service_location:
name: service_location
description: Service location where the service delivered by this usage point
is consumed.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:UsagePoint.ServiceLocation
multivalued: false
alias: service_location
owner: UsagePoint
domain_of:
- Asset
- UsagePoint
- EndDevice
- ServiceRequest
- TroubleTicket
range: ServiceLocation
required: false
usage_point_location:
name: usage_point_location
description: Location of this usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.UsagePointLocation
multivalued: false
alias: usage_point_location
owner: UsagePoint
domain_of:
- UsagePoint
range: UsagePointLocation
required: false
pricing_structures:
name: pricing_structures
description: All pricing structures applicable to this service delivery point
(with prepayment meter running as a stand-alone device, with no CustomerAgreement
or Customer).
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.PricingStructures
multivalued: true
alias: pricing_structures
owner: UsagePoint
domain_of:
- UsagePoint
- CustomerAgreement
- ServiceCategory
- Tariff
range: PricingStructure
required: false
meter_readings:
name: meter_readings
description: All meter readings obtained from this usage point.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:UsagePoint.MeterReadings
multivalued: true
alias: meter_readings
owner: UsagePoint
domain_of:
- UsagePoint
- CustomerAgreement
- Reading
- Meter
range: MeterReading
required: false
environmental_monitoring_station:
name: environmental_monitoring_station
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:UsagePoint.EnvironmentalMonitoringStation
multivalued: false
alias: environmental_monitoring_station
owner: UsagePoint
domain_of:
- Location
- UsagePoint
- TimeSeries
- ReportingCapability
- EnvironmentalAnalog
range: EnvironmentalMonitoringStation
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: UsagePoint
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: UsagePoint
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: UsagePoint
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: UsagePoint
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: UsagePoint
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: UsagePoint
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: UsagePoint
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: UsagePoint
domain_of:
- IdentifiedObject
range: ChangeSetMember
required: false
class_uri: cim:UsagePoint