Home       Trees       Indices       Help   
S3
Package s3 :: Module s3timeplot :: Class S3TimeSeriesEvent
[frames] | no frames]

Class S3TimeSeriesEvent

source code

object --+
         |
        S3TimeSeriesEvent

Class representing an event

Instance Methods
 
__init__(self, event_id, start=None, end=None, values=None, row=DEFAULT, col=DEFAULT)
Constructor		 source code
 
rows(self)
Get the set of row axis keys for this event		 source code
 
cols(self)
Get the set of column axis keys for this event		 source code
 
__getitem__(self, field)
Access attribute values of this event		 source code
 
__lt__(self, other)
Comparison method to allow sorting of events		 source code

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

Static Methods
 
series(value)
Convert a field value into a set of series keys		 source code
Properties

Inherited from object: __class__

Method Details

__init__(self, event_id, start=None, end=None, values=None, row=DEFAULT, col=DEFAULT)
(Constructor)

source code 

Constructor

Parameters:
  • event_id - a unique identifier for the event (e.g. record ID)
  • start - start time of the event (datetime.datetime)
  • end - end time of the event (datetime.datetime)
  • values - a dict of key-value pairs with the attribute values for the event
  • row - the series row for this event
  • col - the series column for this event
Overrides: object.__init__

rows(self)

source code 

Get the set of row axis keys for this event

Decorators:
  • @property

cols(self)

source code 

Get the set of column axis keys for this event

Decorators:
  • @property

series(value)
Static Method

source code 

Convert a field value into a set of series keys

Parameters:
  • value - the field value

__getitem__(self, field)
(Indexing operator)

source code 

Access attribute values of this event

Parameters:
  • field - the attribute field name

__lt__(self, other)
(Less-than operator)

source code 

Comparison method to allow sorting of events

Parameters:
  • other - the event to compare to

   Home       Trees       Indices       Help   
S3
Generated by Epydoc 3.0.1 on Fri Mar 15 08:51:50 2019 http://epydoc.sourceforge.net