Home | Trees | Index | Help |
---|
Package SimPy :: Module SimulationTrace |
|
SimulationTrace 1.6.1 __version__ = '$Revision: 1.1.1.11 $ $Date: 2005/11/12 05:43:35 $ kgm' LICENSE: Copyright (C) 2002,2005 Klaus G. Muller, Tony Vignaux mailto: kgmuller@xs4all.nl and Tony.Vignaux@vuw.ac.nz This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA END OF LICENSE Implements a trace capability for SimPy. Based on generators (Python 2.2 and later) **Change history:** 9 May 03: SimulationTrace module based on SimPy 1.3 12/5/2003: Changed eventlist handling from dictionary to bisect 9/6/2003: - Changed eventlist handling from pure dictionary to bisect- sorted "timestamps" list of keys, resulting in greatly improved performance for models with large numbers of event notices with differing event times. ========================================================= This great change was suggested by Prof. Simon Frost. Thank you, Simon! This version 1.3 is dedicated to you! ========================================================= - Added import of Lister which supports well-structured printing of all attributes of Process and Resource instances. November 03: Brought up to Simulation 1.4alpha 13 Dec 2003: Merged in Monitor and Histogram 27 Feb 2004: Repaired bug in activeQ monitor of class Resource. Now actMon correctly records departures from activeQ. 19 May 2004: Added erroneously omitted Histogram class. 5 Sep 2004: Added SimEvents synchronization constructs 17 Sep 2004: Added waituntil synchronization construct 01 Dec 2004: SimPy version 1.5 Changes in this module: Repaired SimEvents bug re proc.eventsFired 12 Jan 2005: SimPy version 1.5.1 Changes in this module: Monitor objects now have a default name 'a_Monitor' 29 Mar 2005: Start SimPy 1.6: compound "yield request" statements 05 Jun 2005: Fixed bug in _request method -- waitMon did not work properly in preemption case 09 Jun 2005: Added test in 'activate' to see whether 'initialize()' was called first. 23 Aug 2005: - Added Tally data collection class - Adjusted Resource to work with Tally - Redid function allEventNotices() (returns prettyprinted string with event times and names of process instances - Added function allEventTimes (returns event times of all scheduled events)
Classes | |
---|---|
FIFO |
|
FireEvent |
Fires reneging event |
Histogram |
A histogram gathering and sampling class |
JobEvt |
Job class for testing event reneging |
JobEvtMulti |
Job class for testing event reneging with multi-event lists |
JobTO |
Job class for testing timeout reneging |
Monitor |
Monitored variables |
PriorityQ |
Queue is always ordered according to priority. |
Process |
Superclass of classes which may use generator functions |
Queue |
|
Resource |
Models shared, limited capacity resources with queuing; FIFO is default queuing discipline. |
SimEvent |
Supports one-shot signalling between processes. |
Tally |
|
Trace |
|
__Evlist |
Defines event list and operations on it |
_Action |
Structure (who=process owner, generator=process) |
Exceptions | |
---|---|
FatalSimerror |
|
Simerror |
Function Summary | |
---|---|
Application function to activate passive process. | |
Returns string with eventlist as t1: [procname,procname2] t2: [procname4,procname5, . | |
Returns list of all times for which events are scheduled. | |
holdfunc(a)
| |
initialize()
| |
now()
| |
passivatefunc(a)
| |
queueevfunc(a)
| |
Application function to reactivate a process which is active, suspended or passive. | |
releasefunc(a)
| |
Handles 'yield request,self,res' and 'yield (request,self,res),(<code>,self,par)'. | |
Schedules Processes/semi-coroutines until time 'till'. | |
Schedules Processes/semi-coroutines until time 'until' | |
Application function to stop simulation run | |
test_demo()
| |
test_interrupt()
| |
Test that processes acquire resource normally if no event fires | |
Test that resource gets acquired without timeout | |
testSimEvents()
| |
Test that timeout occurs when resource busy | |
Test that timeout occurs when resource has no capacity free | |
Test that signalled event leads to renege when resource busy | |
Test that renege-triggering event can be one of an event list | |
Demo of waitUntil capability. | |
waitevfunc(a)
| |
waituntilfunc(par)
| |
Application function to start stepping through simulation for waituntil construct. | |
Application function to stop stepping through simulation. | |
Gets called by simulate after every event, as long as there are processes waiting in condQ for a condition to be satisfied. | |
_waitUntilFunc(proc,
cond)
|
Variable Summary | |
---|---|
str |
__version__ = '1.6.1 Nov 2005'
|
list |
condQ = []
|
int |
False = 0 |
int |
hold = 1234 |
int |
passivate = 5678 |
int |
queueevent = 8765 |
int |
release = 246 |
int |
request = 135 |
int |
True = 1 |
int |
waitevent = 4321 |
int |
waituntil = 999 |
bool |
__TESTING = False
|
NoneType |
_e = None |
int |
_endtime = 0 |
bool |
_stop = True
|
int |
_t = 0 |
Function Details |
---|
activate(object, process, at='undefined', delay='undefined', prior=0)Application function to activate passive process. |
allEventNotices()Returns string with eventlist as t1: [procname,procname2] t2: [procname4,procname5, . . . ] . . . . |
allEventTimes()Returns list of all times for which events are scheduled. |
reactivate(object, at='undefined', delay='undefined', prior=0)Application function to reactivate a process which is active, suspended or passive. |
requestfunc(a)Handles 'yield request,self,res' and 'yield (request,self,res),(<code>,self,par)'. <code> can be 'hold' or 'waitevent'. |
scheduler(till=0)Schedules Processes/semi-coroutines until time 'till'. Deprecated since version 0.5. |
simulate(until=0)Schedules Processes/semi-coroutines until time 'until' |
stopSimulation()Application function to stop simulation run |
testNoEvent()Test that processes acquire resource normally if no event fires |
testNoTimeout()Test that resource gets acquired without timeout |
testTimeout1()Test that timeout occurs when resource busy |
testTimeout2()Test that timeout occurs when resource has no capacity free |
testWaitEvent1()Test that signalled event leads to renege when resource busy |
testWaitEvent2()Test that renege-triggering event can be one of an event list |
testwaituntil()Demo of waitUntil capability. Scenario: Three workers require sets of tools to do their jobs. Tools are shared, scarce resources for which they compete. |
_startWUStepping()Application function to start stepping through simulation for waituntil construct. |
_stopWUStepping()Application function to stop stepping through simulation. |
_test()Gets called by simulate after every event, as long as there are processes waiting in condQ for a condition to be satisfied. Tests the conditions for all waiting processes. Where condition satisfied, reactivates that process immediately and removes it from queue. |
Variable Details |
---|
__version__
|
condQ
|
False
|
hold
|
passivate
|
queueevent
|
release
|
request
|
True
|
waitevent
|
waituntil
|
__TESTING
|
_e
|
_endtime
|
_stop
|
_t
|
Home | Trees | Index | Help |
---|
Generated by Epydoc 2.1 on Wed Nov 16 12:02:42 2005 | http://epydoc.sf.net |