Package s3 :: Module s3timeplot :: Class S3TimeSeriesEventFrame

Class S3TimeSeriesEventFrame

object --+
         |
        S3TimeSeriesEventFrame

Class representing the whole time frame of a time plot

Instance Methods

__init__(self, start, end, slots=None)
Constructor

source code

get_rule(self)
Get the recurrence rule for the periods

source code

extend(self, events)
Extend this time frame with events

source code

__iter__(self)
Iterate over all periods within this event frame

source code

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

Properties
Inherited from `object`: `__class__`

Method Details

init(self, start, end, slots=None)
(Constructor)

source code

Constructor

Parameters:

start - start of the time frame (datetime.datetime)
end - end of the time frame (datetime.datetime)
slot - length of time slots within the event frame, format: "{n }[hour|day|week|month|year]{s}", examples: "1 week", "3 months", "years"

Overrides: object.__init__

get_rule(self)

source code

Get the recurrence rule for the periods

extend(self, events)

source code

Extend this time frame with events

Parameters:

events - iterable of events

To Do:

integrate in constructor
handle self.rule == None

iter(self)

source code

Iterate over all periods within this event frame

Class S3TimeSeriesEventFrame

__init__(self, start, end, slots=None) (Constructor)

get_rule(self)

extend(self, events)

__iter__(self)

init(self, start, end, slots=None)
(Constructor)

iter(self)