Package CIM14 :: Package IEC61968 :: Package Common :: Module TimeSchedule' :: Class TimeSchedule
[hide private]
[frames] | no frames]

Class TimeSchedule

                                  object --+            
                                           |            
                            Element'.Element --+        
                                               |        
IEC61970.Core.IdentifiedObject'.IdentifiedObject --+    
                                                   |    
                                  Document'.Document --+
                                                       |
                                                      TimeSchedule

Description of anything that changes through time. Time schedule is used to perform a single-valued function of time. Use inherited 'category' 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).

Instance Methods [hide private]
 
__init__(self, recurrencePeriod=0.0, disabled=False, offset=0.0, recurrencePattern='', TimePoints=None, scheduleInterval=None, *args, **kw_args)
Initialises a new 'TimeSchedule' instance.
 
addTimePoints(self, *TimePoints)
 
getTimePoints(self)
Sequence of time points belonging to this time schedule.
 
removeTimePoints(self, *TimePoints)
 
setTimePoints(self, value)

Inherited from Document'.Document: addActivityRecords, addMeasurements, getActivityRecords, getMeasurements, removeActivityRecords, removeMeasurements, setActivityRecords, setMeasurements

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: getModelingAuthoritySet, setModelingAuthoritySet

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]
  _attr_types = {'disabled': <type 'bool'>, 'offset': <type 'flo...
  _attrs = ['recurrencePeriod', 'disabled', 'offset', 'recurrenc...
  _defaults = {'disabled': False, 'offset': 0.0, 'recurrencePatt...
  _many_refs = ['TimePoints']
  _refs = ['TimePoints', 'scheduleInterval']
  scheduleInterval = None

Inherited from Document'.Document: docStatus, electronicAddress, status

Inherited from Element'.Element (private): _enums

Properties [hide private]
  TimePoints
Sequence of time points belonging to this time schedule.

Inherited from Document'.Document: ActivityRecords, Measurements

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: ModelingAuthoritySet

Inherited from object: __class__

Method Details [hide private]

__init__(self, recurrencePeriod=0.0, disabled=False, offset=0.0, recurrencePattern='', TimePoints=None, scheduleInterval=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'TimeSchedule' instance.

Parameters:
  • recurrencePeriod - 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).
  • disabled - True if this schedule is deactivated (disabled).
  • offset - 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.
  • recurrencePattern - Interval at which the scheduled action repeats (e.g., first Monday of every month, last day of the month, etc.).
  • TimePoints - Sequence of time points belonging to this time schedule.
  • scheduleInterval - Schedule date and time interval.
Overrides: object.__init__

Class Variable Details [hide private]

_attr_types

Value:
{'disabled': <type 'bool'>,
 'offset': <type 'float'>,
 'recurrencePattern': <type 'str'>,
 'recurrencePeriod': <type 'float'>}

_attrs

Value:
['recurrencePeriod', 'disabled', 'offset', 'recurrencePattern']

_defaults

Value:
{'disabled': False,
 'offset': 0.0,
 'recurrencePattern': '',
 'recurrencePeriod': 0.0}

Property Details [hide private]

TimePoints

Sequence of time points belonging to this time schedule.

Get Method:
getTimePoints(self) - Sequence of time points belonging to this time schedule.
Set Method:
setTimePoints(self, value)