A Discrete-Event Network Simulator
API
Public Member Functions | Public Attributes | List of all members
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 265 of file grid.py.

Constructor & Destructor Documentation

◆ __init__()

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

Initializer.

Parameters
selfthis object
namename
Returns
none

Definition at line 274 of file grid.py.

Member Function Documentation

◆ get_bounds()

def grid.Timeline.get_bounds (   self)

Get Bounds.

Parameters
selfthis object
Returns
the bounds

Definition at line 349 of file grid.py.

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

◆ get_event_int()

def grid.Timeline.get_event_int (   self,
  name 
)

Get Event Int.

Parameters
selfthis object
namename
Returns
eevent int

Definition at line 308 of file grid.py.

References grid.Timeline.event_int.

◆ get_event_str()

def grid.Timeline.get_event_str (   self,
  name 
)

Get Event String.

Parameters
selfthis object
namename
Returns
the event string

Definition at line 296 of file grid.py.

References grid.Timeline.event_str.

◆ get_events_int()

def grid.Timeline.get_events_int (   self)

Get Events int.

Parameters
selfthis object
Returns
evrnt int

Definition at line 332 of file grid.py.

References grid.Timeline.event_int.

◆ get_events_str()

def grid.Timeline.get_events_str (   self)

Get Events string.

Parameters
selfthis object
Returns
event string

Definition at line 326 of file grid.py.

References grid.Timeline.event_str.

◆ get_range()

def grid.Timeline.get_range (   self,
  name 
)

Get range.

Parameters
selfthis object
namename
Returns
the range

Definition at line 284 of file grid.py.

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

◆ get_ranges()

def grid.Timeline.get_ranges (   self)

Get Ranges.

Parameters
selfthis object
Returns
the ranges

Definition at line 320 of file grid.py.

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

◆ sort()

def grid.Timeline.sort (   self)

Sort the ranges and events.

Parameters
selfthis object
Returns
none

Definition at line 338 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_str

grid.Timeline.event_str

◆ name

grid.Timeline.name

name

Definition at line 283 of file grid.py.

◆ ranges

grid.Timeline.ranges

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