Class RegularTimePoint

      object --+    
               |    
Element'.Element --+
                   |
                  RegularTimePoint

TimePoints for a schedule where the time between the points is constant.- The RegularTimePoint class is used to represent points for various schedules that derive from the RegularIntervalSchedule class. The schedules defined in this profile are: ConformLoadSchedule NonConformLoadSchedule RegulationSchedule - The first SequenceNumber for a schedule is 1. 0 is not an allowed value. The first time point is defined with SequenceNumber = 1.

Instance Methods

[hide private]

__init__(self, sequenceNumber=0, value1=0.0, value2=0.0, IntervalSchedule=None, *args, **kw_args)
Initialises a new 'RegularTimePoint' instance.

getIntervalSchedule(self)
A RegularTimePoint belongs to a RegularIntervalSchedule.

setIntervalSchedule(self, value)

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

Class Variables

[hide private]

_attr_types = {'sequenceNumber': <type 'int'>, 'value1': <type...

_attrs = ['sequenceNumber', 'value1', 'value2']

_defaults = {'sequenceNumber': 0, 'value1': 0.0, 'value2': 0.0}

_refs = ['IntervalSchedule']

Inherited from Element'.Element (private): _enums, _many_refs

Properties

[hide private]

IntervalSchedule
A RegularTimePoint belongs to a RegularIntervalSchedule.

Inherited from object: __class__

Method Details

[hide private]

init(self, sequenceNumber=0, value1=0.0, value2=0.0, IntervalSchedule=None, *args, **kw_args)
(Constructor)

Initialises a new 'RegularTimePoint' instance.

Parameters:

sequenceNumber - The position of the RegularTimePoint in the sequence. Note that time points don't have to be sequential, i.e. time points may be omitted. The actual time for a RegularTimePoint is computed by multiplying the RegularIntervalSchedule.timeStep with the RegularTimePoint.sequenceNumber and add the BasicIntervalSchedule.startTime.
value1 - The first value at the time. The meaning of the value is defined by the class inhering the RegularIntervalSchedule.
value2 - The second value at the time. The meaning of the value is defined by the class inhering the RegularIntervalSchedule.
IntervalSchedule - A RegularTimePoint belongs to a RegularIntervalSchedule.

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'sequenceNumber': <type 'int'>,
 'value1': <type 'float'>,
 'value2': <type 'float'>}

Property Details

[hide private]

IntervalSchedule

A RegularTimePoint belongs to a RegularIntervalSchedule.

Get Method:: getIntervalSchedule(self) - A RegularTimePoint belongs to a RegularIntervalSchedule.
Set Method:: setIntervalSchedule(self, value)

Class RegularTimePoint

__init__(self, sequenceNumber=0, value1=0.0, value2=0.0, IntervalSchedule=None, *args, **kw_args) (Constructor)

_attr_types

IntervalSchedule

init(self, sequenceNumber=0, value1=0.0, value2=0.0, IntervalSchedule=None, *args, **kw_args)
(Constructor)