A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
grid.TimelineEvent Class Reference

TimelineEvent class. More...

Public Member Functions

 __init__ (self, name="")
 Get ranges bounds.
 
 add_event (self, event)
 Add Event.
 
 get_bounds (self)
 Get Bounds.
 
 get_events (self, start, end)
 Get Events.
 
 get_events_bounds (self, start, end)
 Get Events Bounds.
 
 sort (self)
 Sort function.
 

Public Attributes

 events
 events
 
 name
 name
 

Private Member Functions

 __search (self, key)
 Search function.
 

Detailed Description

TimelineEvent class.

Definition at line 204 of file grid.py.

Constructor & Destructor Documentation

◆ __init__()

grid.TimelineEvent.__init__ ( self,
name = "" )

Get ranges bounds.

Parameters
selfthis object
namename

Definition at line 209 of file grid.py.

Member Function Documentation

◆ __search()

grid.TimelineEvent.__search ( self,
key )
private

Search function.

Parameters
selfthis object
keythe key
Returns
event index

Definition at line 217 of file grid.py.

References Bench::Result.events, and grid.TimelineEvent.events.

Referenced by grid.TimelineEvent.get_events(), grid.TimelineEvent.get_events_bounds(), grid.TimelineDataRange.get_ranges(), and grid.TimelineDataRange.get_ranges_bounds().

+ Here is the caller graph for this function:

◆ add_event()

grid.TimelineEvent.add_event ( self,
event )

Add Event.

Parameters
selfthis object
eventevent to add
Returns
none

Definition at line 236 of file grid.py.

References Bench::Result.events, and grid.TimelineEvent.events.

◆ get_bounds()

grid.TimelineEvent.get_bounds ( self)

Get Bounds.

Parameters
selfthis object
Returns
the bounds

Definition at line 273 of file grid.py.

References Bench::Result.events, and grid.TimelineEvent.events.

◆ get_events()

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

Get Events.

Parameters
selfthis object
startstarting event
endending event
Returns
the events

Definition at line 244 of file grid.py.

References grid.TimelineDataRange.__search(), grid.TimelineEvent.__search(), Bench::Result.events, and grid.TimelineEvent.events.

+ Here is the call graph for this function:

◆ get_events_bounds()

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

Get Events Bounds.

Parameters
selfthis object
startstarting event
endending event
Returns
event bounds

Definition at line 255 of file grid.py.

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

+ Here is the call graph for this function:

◆ sort()

grid.TimelineEvent.sort ( self)

Sort function.

Parameters
selfthis object
Returns
none

Definition at line 266 of file grid.py.

References Bench::Result.events, grid.TimelineEvent.events, and grid.TimelineEvent.sort().

Referenced by grid.TimelineEvent.sort().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ events

◆ name

grid.TimelineEvent.name

name

Definition at line 214 of file grid.py.


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