Class: TimeSchedule

name: TimeSchedule
description: "Description of anything that changes through time. Time schedule is\
  \ used to perform a single-valued function of time. Use inherited 'type' attribute\
  \ to give additional information on this schedule, such as: periodic (hourly, daily,\
  \ weekly, monthly, etc.), day of the month, by date, calendar (specific times and\
  \ dates).\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Document
attributes:
  disabled:
    name: disabled
    description: True if this schedule is deactivated (disabled).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TimeSchedule.disabled
    multivalued: false
    domain_of:
    - TimeSchedule
    range: boolean
    required: false
  offset:
    name: offset
    description: The offset from midnight (i.e., 0 h, 0 min, 0 s) for the periodic
      time points to begin. For example, for an interval meter that is set up for
      five minute intervals ('recurrencePeriod'=300=5 min), setting 'offset'=120=2
      min would result in scheduled events to read the meter executing at 2 min, 7
      min, 12 min, 17 min, 22 min, 27 min, 32 min, 37 min, 42 min, 47 min, 52 min,
      and 57 min past each hour.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TimeSchedule.offset
    multivalued: false
    domain_of:
    - TimeSchedule
    - PendingCalculation
    - BillDeterminant
    range: Seconds
    required: false
  recurrence_pattern:
    name: recurrence_pattern
    description: Interval at which the scheduled action repeats (e.g., first Monday
      of every month, last day of the month, etc.).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TimeSchedule.recurrencePattern
    multivalued: false
    domain_of:
    - TimeSchedule
    range: string
    required: false
  recurrence_period:
    name: recurrence_period
    description: Duration between time points, from the beginning of one period to
      the beginning of the next period. Note that a device like a meter may have multiple
      interval periods (e.g., 1 min, 5 min, 15 min, 30 min, or 60 min).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TimeSchedule.recurrencePeriod
    multivalued: false
    domain_of:
    - TimeSchedule
    range: Seconds
    required: false
  schedule_interval:
    name: schedule_interval
    description: Schedule date and time interval.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TimeSchedule.scheduleInterval
    multivalued: false
    domain_of:
    - TimeSchedule
    range: DateTimeInterval
    required: false
  time_points:
    name: time_points
    description: Sequence of time points belonging to this time schedule.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TimeSchedule.TimePoints
    multivalued: true
    domain_of:
    - TimeSchedule
    - RegularIntervalSchedule
    - IrregularIntervalSchedule
    range: TimePoint
    required: false
  meter_read_schedule:
    name: meter_read_schedule
    description: Meter read schedule for which the time schedule applies
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TimeSchedule.MeterReadSchedule
    multivalued: false
    domain_of:
    - TimeSchedule
    - UsagePoint
    - CustomerAgreement
    - CustomerAccount
    - ReadingType
    - EndDevice
    - EndDeviceGroup
    - UsagePointGroup
    range: MeterReadSchedule
    required: false
class_uri: cim:TimeSchedule

name: TimeSchedule
description: "Description of anything that changes through time. Time schedule is\
  \ used to perform a single-valued function of time. Use inherited 'type' attribute\
  \ to give additional information on this schedule, such as: periodic (hourly, daily,\
  \ weekly, monthly, etc.), day of the month, by date, calendar (specific times and\
  \ dates).\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: Document
attributes:
  disabled:
    name: disabled
    description: True if this schedule is deactivated (disabled).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TimeSchedule.disabled
    multivalued: false
    alias: disabled
    owner: TimeSchedule
    domain_of:
    - TimeSchedule
    range: boolean
    required: false
  offset:
    name: offset
    description: The offset from midnight (i.e., 0 h, 0 min, 0 s) for the periodic
      time points to begin. For example, for an interval meter that is set up for
      five minute intervals ('recurrencePeriod'=300=5 min), setting 'offset'=120=2
      min would result in scheduled events to read the meter executing at 2 min, 7
      min, 12 min, 17 min, 22 min, 27 min, 32 min, 37 min, 42 min, 47 min, 52 min,
      and 57 min past each hour.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TimeSchedule.offset
    multivalued: false
    alias: offset
    owner: TimeSchedule
    domain_of:
    - TimeSchedule
    - PendingCalculation
    - BillDeterminant
    range: Seconds
    required: false
  recurrence_pattern:
    name: recurrence_pattern
    description: Interval at which the scheduled action repeats (e.g., first Monday
      of every month, last day of the month, etc.).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TimeSchedule.recurrencePattern
    multivalued: false
    alias: recurrence_pattern
    owner: TimeSchedule
    domain_of:
    - TimeSchedule
    range: string
    required: false
  recurrence_period:
    name: recurrence_period
    description: Duration between time points, from the beginning of one period to
      the beginning of the next period. Note that a device like a meter may have multiple
      interval periods (e.g., 1 min, 5 min, 15 min, 30 min, or 60 min).
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TimeSchedule.recurrencePeriod
    multivalued: false
    alias: recurrence_period
    owner: TimeSchedule
    domain_of:
    - TimeSchedule
    range: Seconds
    required: false
  schedule_interval:
    name: schedule_interval
    description: Schedule date and time interval.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TimeSchedule.scheduleInterval
    multivalued: false
    alias: schedule_interval
    owner: TimeSchedule
    domain_of:
    - TimeSchedule
    range: DateTimeInterval
    required: false
  time_points:
    name: time_points
    description: Sequence of time points belonging to this time schedule.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TimeSchedule.TimePoints
    multivalued: true
    alias: time_points
    owner: TimeSchedule
    domain_of:
    - TimeSchedule
    - RegularIntervalSchedule
    - IrregularIntervalSchedule
    range: TimePoint
    required: false
  meter_read_schedule:
    name: meter_read_schedule
    description: Meter read schedule for which the time schedule applies
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:TimeSchedule.MeterReadSchedule
    multivalued: false
    alias: meter_read_schedule
    owner: TimeSchedule
    domain_of:
    - TimeSchedule
    - UsagePoint
    - CustomerAgreement
    - CustomerAccount
    - ReadingType
    - EndDevice
    - EndDeviceGroup
    - UsagePointGroup
    range: MeterReadSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    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: TimeSchedule
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:TimeSchedule