Class: TariffProfile
A schedule of charges; structure associated with Tariff that allows the definition of complex tarif structures such as step and time of use when used in conjunction with TimeTariffInterval and Charge. Inherited 'status.value' is defined in the context of the utility's business rules, for example: active, inactive, etc.
URI: cim:TariffProfile
classDiagram
class TariffProfile
Document <|-- TariffProfile
TariffProfile : activity_record
TariffProfile --> ActivityRecord : activity_record
TariffProfile : alias_name
TariffProfile : approver
TariffProfile --> Approver : approver
TariffProfile : author
TariffProfile --> Author : author
TariffProfile : author_name
TariffProfile : comment
TariffProfile : configuration_events
TariffProfile --> ConfigurationEvent : configuration_events
TariffProfile : consumption_tariff_intervals
TariffProfile --> ConsumptionTariffInterval : consumption_tariff_intervals
TariffProfile : created_date_time
TariffProfile : description
TariffProfile : diagram_objects
TariffProfile --> DiagramObject : diagram_objects
TariffProfile : doc_status
TariffProfile --> Status : doc_status
TariffProfile : editor
TariffProfile --> Editor : editor
TariffProfile : electronic_address
TariffProfile --> ElectronicAddress : electronic_address
TariffProfile : instance_set
TariffProfile --> InstanceSet : instance_set
TariffProfile : issuer
TariffProfile --> Issuer : issuer
TariffProfile : last_modified_date_time
TariffProfile : m_rid
TariffProfile : names
TariffProfile --> Name : names
TariffProfile : properties_cimdata_object
TariffProfile --> ChangeSetMember : properties_cimdata_object
TariffProfile : revision_number
TariffProfile : status
TariffProfile --> Status : status
TariffProfile : subject
TariffProfile : targeting_cimdata_object
TariffProfile --> ChangeSetMember : targeting_cimdata_object
TariffProfile : tariff_cycle
TariffProfile : tariffs
TariffProfile --> Tariff : tariffs
TariffProfile : time_tariff_intervals
TariffProfile --> TimeTariffInterval : time_tariff_intervals
TariffProfile : title
TariffProfile : type
Inheritance
- IdentifiedObject
- Document
- TariffProfile
- Document
Slots
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| tariff_cycle | 0..1 String |
The frequency at which the tariff charge schedule is repeated | direct |
| time_tariff_intervals | 0..* TimeTariffInterval |
All time tariff intervals used to define this tariff profile | direct |
| consumption_tariff_intervals | 0..* ConsumptionTariffInterval |
All consumption tariff intervals used to define this tariff profile | direct |
| tariffs | 0..* Tariff |
All tariffs defined by this tariff profile | direct |
| author_name | 0..1 String |
Name of the author of this document | Document |
| comment | 0..1 String |
Free text comment | Document |
| created_date_time | 0..1 date |
Date and time that this document was created | Document |
| doc_status | 0..1 Status |
Status of this document | Document |
| electronic_address | 0..1 ElectronicAddress |
Electronic address | Document |
| last_modified_date_time | 0..1 date |
Date and time this document was last modified | Document |
| revision_number | 0..1 String |
Revision number for this document | Document |
| status | 0..1 Status |
Status of subject matter (e | Document |
| subject | 0..1 String |
Document subject | Document |
| title | 0..1 String |
Document title | Document |
| type | 0..1 String |
Utility-specific classification of this document, according to its corporate ... | Document |
| activity_record | 0..* ActivityRecord |
The activity record for a document | Document |
| configuration_events | 0..* ConfigurationEvent |
All configuration events created for this document | Document |
| author | 0..1 Author |
Author of this document | Document |
| editor | 0..1 Editor |
Editor of this document | Document |
| approver | 0..1 Approver |
Approver of this document | Document |
| issuer | 0..1 Issuer |
Issuer of this document | Document |
| 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 |
|---|---|---|---|
| TimeTariffInterval | tariff_profiles | range | TariffProfile |
| Tariff | tariff_profiles | range | TariffProfile |
| ConsumptionTariffInterval | tariff_profiles | range | TariffProfile |
Identifier and Mapping Information
Schema Source
- from schema: https://cim.ucaiug.io/ns#TC57CIM
Mappings
| Mapping Type | Mapped Value |
|---|---|
| self | cim:TariffProfile |
| native | cim:TariffProfile |
LinkML Source
Direct
name: TariffProfile
description: 'A schedule of charges; structure associated with Tariff that allows
the definition of complex tarif structures such as step and time of use when used
in conjunction with TimeTariffInterval and Charge. Inherited ''status.value'' is
defined in the context of the utility''s business rules, for example: active, inactive,
etc.'
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Document
attributes:
tariff_cycle:
name: tariff_cycle
description: 'The frequency at which the tariff charge schedule is repeated. Examples
are: once off on a specified date and time; hourly; daily; weekly; monthly;
3-monthly; 6-monthly; 12-monthly; etc. At the end of each cycle, the business
rules are reset to start from the beginning again.'
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:TariffProfile.tariffCycle
multivalued: false
domain_of:
- TariffProfile
range: string
required: false
time_tariff_intervals:
name: time_tariff_intervals
description: All time tariff intervals used to define this tariff profile.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:TariffProfile.TimeTariffIntervals
multivalued: true
domain_of:
- Charge
- TariffProfile
range: TimeTariffInterval
required: false
consumption_tariff_intervals:
name: consumption_tariff_intervals
description: All consumption tariff intervals used to define this tariff profile.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:TariffProfile.ConsumptionTariffIntervals
multivalued: true
domain_of:
- Charge
- TimeTariffInterval
- TariffProfile
- ReadingType
range: ConsumptionTariffInterval
required: false
tariffs:
name: tariffs
description: All tariffs defined by this tariff profile.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:TariffProfile.Tariffs
multivalued: true
domain_of:
- PricingStructure
- TariffProfile
range: Tariff
required: false
class_uri: cim:TariffProfile
Induced
name: TariffProfile
description: 'A schedule of charges; structure associated with Tariff that allows
the definition of complex tarif structures such as step and time of use when used
in conjunction with TimeTariffInterval and Charge. Inherited ''status.value'' is
defined in the context of the utility''s business rules, for example: active, inactive,
etc.'
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Document
attributes:
tariff_cycle:
name: tariff_cycle
description: 'The frequency at which the tariff charge schedule is repeated. Examples
are: once off on a specified date and time; hourly; daily; weekly; monthly;
3-monthly; 6-monthly; 12-monthly; etc. At the end of each cycle, the business
rules are reset to start from the beginning again.'
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:TariffProfile.tariffCycle
multivalued: false
alias: tariff_cycle
owner: TariffProfile
domain_of:
- TariffProfile
range: string
required: false
time_tariff_intervals:
name: time_tariff_intervals
description: All time tariff intervals used to define this tariff profile.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:TariffProfile.TimeTariffIntervals
multivalued: true
alias: time_tariff_intervals
owner: TariffProfile
domain_of:
- Charge
- TariffProfile
range: TimeTariffInterval
required: false
consumption_tariff_intervals:
name: consumption_tariff_intervals
description: All consumption tariff intervals used to define this tariff profile.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:TariffProfile.ConsumptionTariffIntervals
multivalued: true
alias: consumption_tariff_intervals
owner: TariffProfile
domain_of:
- Charge
- TimeTariffInterval
- TariffProfile
- ReadingType
range: ConsumptionTariffInterval
required: false
tariffs:
name: tariffs
description: All tariffs defined by this tariff profile.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:TariffProfile.Tariffs
multivalued: true
alias: tariffs
owner: TariffProfile
domain_of:
- PricingStructure
- TariffProfile
range: Tariff
required: false
author_name:
name: author_name
description: Name of the author of this document.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.authorName
multivalued: false
alias: author_name
owner: TariffProfile
domain_of:
- Document
range: string
required: false
comment:
name: comment
description: Free text comment.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Document.comment
multivalued: false
alias: comment
owner: TariffProfile
domain_of:
- NetworkModelProjectChangeVersion
- Document
- SwitchingPlanRequest
- SwitchingOrder
- TroubleOrder
- ReadingQuality
- TroubleTicket
- OutageOrder
range: string
required: false
created_date_time:
name: created_date_time
description: "Date and time that this document was created.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.createdDateTime
multivalued: false
alias: created_date_time
owner: TariffProfile
domain_of:
- Document
- ActivityRecord
range: date
required: false
doc_status:
name: doc_status
description: "Status of this document. For status of subject matter this document\
\ represents (e.g., Agreement, Work), use 'status' attribute.\r\nExample values\
\ for 'docStatus.status' are draft, approved, cancelled, etc."
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.docStatus
multivalued: false
alias: doc_status
owner: TariffProfile
domain_of:
- Document
range: Status
required: false
electronic_address:
name: electronic_address
description: Electronic address.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Document.electronicAddress
multivalued: false
alias: electronic_address
owner: TariffProfile
domain_of:
- Asset
- Document
- Person
- Organisation
- Location
- Cashier
range: ElectronicAddress
required: false
last_modified_date_time:
name: last_modified_date_time
description: "Date and time this document was last modified. Documents may potentially\
\ be modified many times during their lifetime.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.lastModifiedDateTime
multivalued: false
alias: last_modified_date_time
owner: TariffProfile
domain_of:
- Document
range: date
required: false
revision_number:
name: revision_number
description: Revision number for this document.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.revisionNumber
multivalued: false
alias: revision_number
owner: TariffProfile
domain_of:
- Document
- MajorChargeGroup
range: string
required: false
status:
name: status
description: Status of subject matter (e.g., Agreement, Work) this document represents.
For status of the document itself, use 'docStatus' attribute.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Document.status
multivalued: false
alias: status
owner: TariffProfile
domain_of:
- Asset
- Document
- Customer
- StreetAddress
- Location
- ErpQuoteLineItem
- CostType
- ErpJournalEntry
- ErpRecLineItem
- ErpPayableLineItem
- ContractorItem
- Capability
- Craft
- OldPerson
- ErpPersonnel
- LaborItem
- DesignLocationCU
- DesignLocation
- ConditionFactor
- MiscCostItem
- CUGroup
- WorkFlowStep
- ErpTimeEntry
- OverheadCost
- PropertyUnit
- CUMaterialItem
- ErpIssueInventory
- ErpReqLineItem
- ErpRecDelvLineItem
- Role
- LandProperty
- ErpSiteLevelData
- Crew
- ActivityRecord
- ErpLedgerEntry
- ErpLedBudLineItem
- TransformerObservation
- BushingInsulationPF
- WindingInsulation
- CULaborItem
- CULaborCode
- EndDeviceGroup
- Hazard
- CUWorkEquipmentItem
- ShiftPattern
- Route
- Usage
- CUContractorItem
- CUAllowableAction
- TypeAssetCatalogue
- AssetModelCatalogue
- Market
- CRROrgRole
- MarketScheduledEvent
- MarketLedgerEntry
- MarketPerson
- MarketQualificationRequirement
- ResourceGroup
- ResourceAwardInstruction
- ExPostResourceResults
- MarketObjectStatus
- TimePoint
- ErpItemMaster
- ScheduledEvent
- ScheduledEventData
- ErpInventory
- ErpInventoryCount
- RedLine
- BusinessRole
- BidTimeSeries
range: Status
required: false
subject:
name: subject
description: Document subject.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.subject
multivalued: false
alias: subject
owner: TariffProfile
domain_of:
- Document
range: string
required: false
title:
name: title
description: Document title.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.title
multivalued: false
alias: title
owner: TariffProfile
domain_of:
- Document
range: string
required: false
type:
name: type
description: Utility-specific classification of this document, according to its
corporate standards, practices, and existing IT systems (e.g., for management
of assets, maintenance, work, outage, customers, etc.).
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Document.type
multivalued: false
alias: type
owner: TariffProfile
domain_of:
- Asset
- AcceptanceTest
- Document
- StreetDetail
- Location
- Priority
- CatalogAssetType
- Capability
- Craft
- OldPerson
- Role
- ActivityRecord
- EndDeviceEventType
- EndDeviceGroup
- DemandResponseProgram
- UsagePointGroup
- EndDeviceControlType
- Hazard
- OldCrew
- Route
- ConstraintDuration
- AceTariffType
- ControlArea
- SynchronousMachine
- ChargeProfile
- ChargeComponent
- MarketRole
- ResourceGroup
- Quantity
- ResourceCertification
- Auction
- ScheduledEvent
- PotentialTransformer
- BusinessRole
range: string
required: false
activity_record:
name: activity_record
description: The activity record for a document
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.ActivityRecord
multivalued: true
alias: activity_record
owner: TariffProfile
domain_of:
- Document
range: ActivityRecord
required: false
configuration_events:
name: configuration_events
description: All configuration events created for this document.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
slot_uri: cim:Document.ConfigurationEvents
multivalued: true
alias: configuration_events
owner: TariffProfile
domain_of:
- Asset
- Document
- PersonRole
- OrganisationRole
- Location
- UsagePoint
- ServiceCategory
range: ConfigurationEvent
required: false
author:
name: author
description: Author of this document.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.Author
multivalued: false
alias: author
owner: TariffProfile
domain_of:
- Document
- ActivityRecord
range: Author
required: false
editor:
name: editor
description: Editor of this document.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.Editor
multivalued: false
alias: editor
owner: TariffProfile
domain_of:
- Document
range: Editor
required: false
approver:
name: approver
description: Approver of this document.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.Approver
multivalued: false
alias: approver
owner: TariffProfile
domain_of:
- Document
range: Approver
required: false
issuer:
name: issuer
description: Issuer of this document.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
slot_uri: cim:Document.Issuer
multivalued: false
alias: issuer
owner: TariffProfile
domain_of:
- Document
range: Issuer
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: TariffProfile
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: TariffProfile
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: TariffProfile
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: TariffProfile
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: TariffProfile
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: TariffProfile
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: TariffProfile
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: TariffProfile
domain_of:
- IdentifiedObject
range: ChangeSetMember
required: false
class_uri: cim:TariffProfile