Package CIM15 :: Package IEC61968 :: Package Common :: Module TimePoint' :: Class TimePoint

Class TimePoint

                                  object --+        
                                           |        
                            Element'.Element --+    
                                               |    
IEC61970.Core.IdentifiedObject'.IdentifiedObject --+
                                                   |
                                                  TimePoint

A point in time within a sequence of points in time relative to a TimeSchedule.A point in time within a sequence of points in time relative to a TimeSchedule.

Instance Methods

[hide private]

__init__(self, dateTime='', sequenceNumber=0, relativeTimeInterval=0.0, status=None, window=None, TimeSchedule=None, ScheduledEvents=None, *args, **kw_args)
Initialises a new 'TimePoint' instance.

addScheduledEvents(self, *ScheduledEvents)

getScheduledEvents(self)

getTimeSchedule(self)
Time schedule owning this time point.

removeScheduledEvents(self, *ScheduledEvents)

setScheduledEvents(self, value)

setTimeSchedule(self, value)

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: addDiagramObjects, addNames, getDiagramObjects, getModelingAuthoritySet, getNames, removeDiagramObjects, removeNames, setDiagramObjects, setModelingAuthoritySet, setNames

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

Class Variables

[hide private]

_attr_types = {'dateTime': <type 'str'>, 'relativeTimeInterval...

_attrs = ['dateTime', 'sequenceNumber', 'relativeTimeInterval']

_defaults = {'dateTime': '', 'relativeTimeInterval': 0.0, 'seq...

_many_refs = ['ScheduledEvents']

_refs = ['status', 'window', 'TimeSchedule', 'ScheduledEvents']

status = None

window = None

Inherited from Element'.Element (private): _enums

Properties

[hide private]

ScheduledEvents

TimeSchedule
Time schedule owning this time point.

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: DiagramObjects, ModelingAuthoritySet, Names

Inherited from object: __class__

Method Details

[hide private]

init(self, dateTime=`''`, sequenceNumber=0, relativeTimeInterval=0.0, status=None, window=None, TimeSchedule=None, ScheduledEvents=None, *args, **kw_args)
(Constructor)

Initialises a new 'TimePoint' instance.

Parameters:

dateTime - Absolute date and time for this time point. For calendar-based time point, it is typically manually entered, while for interval-based or sequence-based time point it is derived.
sequenceNumber - (if sequence-based) Relative sequence number for this time point.
relativeTimeInterval - (if interval-based) A point in time relative to scheduled start time in 'TimeSchedule.scheduleInterval.start'.
status - Status of this time point.
window - Interval defining the window of time that this time point is valid (for example, seasonal, only on weekends, not on weekends, only 8:00 to 5:00, etc.).
TimeSchedule - Time schedule owning this time point.
ScheduledEvents

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'dateTime': <type 'str'>,
 'relativeTimeInterval': <type 'float'>,
 'sequenceNumber': <type 'int'>}

_defaults

Value:

{'dateTime': '', 'relativeTimeInterval': 0.0, 'sequenceNumber': 0}

Property Details

[hide private]

ScheduledEvents

Get Method:: getScheduledEvents(self)
Set Method:: setScheduledEvents(self, value)

TimeSchedule

Time schedule owning this time point.

Get Method:: getTimeSchedule(self) - Time schedule owning this time point.
Set Method:: setTimeSchedule(self, value)

Class TimePoint

__init__(self, dateTime='', sequenceNumber=0, relativeTimeInterval=0.0, status=None, window=None, TimeSchedule=None, ScheduledEvents=None, *args, **kw_args) (Constructor)

_attr_types

_defaults

ScheduledEvents

TimeSchedule

init(self, dateTime=`''`, sequenceNumber=0, relativeTimeInterval=0.0, status=None, window=None, TimeSchedule=None, ScheduledEvents=None, *args, **kw_args)
(Constructor)