grid.Timeline Class Reference

Timeline class. More...

Public Member Functions
def	__init__ (self, name='')
	Initializer. More...
def	get_bounds (self)
	Get Bounds. More...
def	get_event_int (self, name)
	Get Event Int. More...
def	get_event_str (self, name)
	Get Event String. More...
def	get_events_int (self)
	Get Events int. More...
def	get_events_str (self)
	Get Events string. More...
def	get_range (self, name)
	Get range. More...
def	get_ranges (self)
	Get Ranges. More...
def	sort (self)
	Sort the ranges and events. More...

Public Attributes
	event_int
	event int More...
	event_str
	event string More...
	name
	name More...
	ranges
	ranges More...

Detailed Description

Timeline class.

Definition at line 259 of file grid.py.

Constructor & Destructor Documentation

__init__()

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

Initializer.

Parameters

self	this object
name	name

Definition at line 268 of file grid.py.

Member Function Documentation

get_bounds()

def grid.Timeline.get_bounds

(

self

)

Get Bounds.

Parameters

self	this object

Returns

the bounds

Definition at line 342 of file grid.py.

References grid.Timeline.event_int, grid.Timeline.event_str, grid.TimelineDataRange.ranges, and grid.Timeline.ranges.

get_event_int()

def grid.Timeline.get_event_int	(		self,
			name
	)

Get Event Int.

Parameters

self	this object
name	name

Returns

eevent int

Definition at line 301 of file grid.py.

References grid.Timeline.event_int.

get_event_str()

def grid.Timeline.get_event_str	(		self,
			name
	)

Get Event String.

Parameters

self	this object
name	name

Returns

the event string

Definition at line 289 of file grid.py.

References grid.Timeline.event_str.

get_events_int()

def grid.Timeline.get_events_int

(

self

)

Get Events int.

Parameters

self	this object

Returns

evrnt int

Definition at line 325 of file grid.py.

References grid.Timeline.event_int.

get_events_str()

def grid.Timeline.get_events_str

(

self

)

Get Events string.

Parameters

self	this object

Returns

event string

Definition at line 319 of file grid.py.

References grid.Timeline.event_str.

get_range()

def grid.Timeline.get_range	(		self,
			name
	)

Get range.

Parameters

self	this object
name	name

Returns

the range

Definition at line 277 of file grid.py.

References grid.TimelineDataRange.ranges, and grid.Timeline.ranges.

get_ranges()

def grid.Timeline.get_ranges

(

self

)

Get Ranges.

Parameters

self	this object

Returns

the ranges

Definition at line 313 of file grid.py.

References grid.TimelineDataRange.ranges, and grid.Timeline.ranges.

sort()

def grid.Timeline.sort

(

self

)

Sort the ranges and events.

Parameters

self	this object

Returns

none

Definition at line 331 of file grid.py.

References grid.Timeline.event_int, grid.Timeline.event_str, grid.TimelineDataRange.ranges, and grid.Timeline.ranges.

Member Data Documentation

event_int

grid.Timeline.event_int

event int

Definition at line 275 of file grid.py.

Referenced by grid.Timeline.get_bounds(), grid.Timeline.get_event_int(), grid.Timeline.get_events_int(), and grid.Timeline.sort().

event_str

grid.Timeline.event_str

event string

Definition at line 274 of file grid.py.

Referenced by grid.Timeline.get_bounds(), grid.Timeline.get_event_str(), grid.Timeline.get_events_str(), and grid.Timeline.sort().

name

grid.Timeline.name

name

Definition at line 276 of file grid.py.

ranges

grid.Timeline.ranges

ranges

Definition at line 273 of file grid.py.

Referenced by grid.TimelineDataRange.__search(), grid.TimelineDataRange.add_range(), grid.TimelineDataRange.get_all(), grid.TimelineDataRange.get_bounds(), grid.Timeline.get_bounds(), grid.Timeline.get_range(), grid.Timeline.get_ranges(), grid.TimelineDataRange.get_ranges(), grid.TimelineDataRange.get_ranges_bounds(), grid.TimelineDataRange.sort(), and grid.Timeline.sort().

---

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

• utils/grid.py