grid.TimelineEvent Class Reference

TimelineEvent class. More...

Public Member Functions
def	__init__
	Get ranges bounds. More...
def	add_event (self, event)
	Add Event. More...
def	get_bounds (self)
	Get Bounds. More...
def	get_events (self, start, end)
	Get Events. More...
def	get_events_bounds (self, start, end)
	Get Events Bounds. More...
def	sort (self)
	Sort function. More...

Public Attributes
	events
	events More...
	name
	name More...

Private Member Functions
def	__search (self, key)
	Search function. More...

Detailed Description

TimelineEvent class.

Definition at line 188 of file grid.py.

Constructor & Destructor Documentation

def grid.TimelineEvent.__init__	(		self,
			name = ''
	)

Get ranges bounds.

Parameters

self	this object
name	name

Returns

none

Definition at line 193 of file grid.py.

Member Function Documentation

def grid.TimelineEvent.__search (   self,   key  )

private

Search function.

Parameters

self	this object
key	the key

Returns

event index

Definition at line 201 of file grid.py.

References grid.TimelineEvent.events.

Referenced by grid.TimelineEvent.get_events(), and grid.TimelineEvent.get_events_bounds().

Here is the caller graph for this function:

def grid.TimelineEvent.add_event	(		self,
			event
	)

Add Event.

Parameters

self	this object
event	event to add

Returns

none

Definition at line 219 of file grid.py.

def grid.TimelineEvent.get_bounds

(

self

)

Get Bounds.

Parameters

self	this object

Returns

the bounds

Definition at line 252 of file grid.py.

References grid.TimelineEvent.events, and return.

def grid.TimelineEvent.get_events	(		self,
			start,
			end
	)

Get Events.

Parameters

self	this object
start	starting event
end	ending event

Returns

the events

Definition at line 226 of file grid.py.

References grid.TimelineDataRange.__search(), grid.TimelineEvent.__search(), and grid.TimelineEvent.events.

Here is the call graph for this function:

def grid.TimelineEvent.get_events_bounds	(		self,
			start,
			end
	)

Get Events Bounds.

Parameters

self	this object
start	starting event
end	ending event

Returns

event bounds

Definition at line 236 of file grid.py.

References grid.TimelineDataRange.__search(), grid.TimelineEvent.__search(), and return.

Here is the call graph for this function:

def grid.TimelineEvent.sort

(

self

)

Sort function.

Parameters

self	this object

Returns

none

Definition at line 246 of file grid.py.

Member Data Documentation

grid.TimelineEvent.events

events

Definition at line 200 of file grid.py.

Referenced by grid.TimelineEvent.__search(), grid.TimelineEvent.get_bounds(), and grid.TimelineEvent.get_events().

grid.TimelineEvent.name

name

Definition at line 199 of file grid.py.

---

The documentation for this class was generated from the following file:

• utils/grid.py