Swpu

class Swpu : public genNamedObj<Swpu*>, public Pu

Proxy class for a generic SoftwareProcessUnit

Inheritance:

Public Classes
enum eSwpuStartModes: Enum for determining whether it is start at Init,download or startrun

Public Methods
Swpu(const char *name, const char *design, const char *host, const char *exec, int eStartMode = eStartAtStartRun ): Constructor with the name, type, host and executable to run
~Swpu(): Destructor

Public

accessors

void setAllArgv( int argc, const char **pccArgv ): To set all arguments with which the process is started
int setArgv( int iarg, const char *argv ): To set the iarg-th argument
inline const char* getHost(): Returns the host where it is running
inline const char* getExecFile(): Returns the executable file
inline long getStartMode(): Returns the start mode (i
inline long getPid(): Returns the PID of the process

enum eSwpuStartModes

Enum for determining whether it is start at Init,download or startrun

Misc member functions: (dump, identify, RTTI)

static void listAll( ostream &os = cout ): Iterates over all objects and calls identify
static void dump_all( ostream &os = cout ): Iterates over all objects and calls dump
void identify( ostream &os = cout ): Prints a one-line summary about the object
virtual void dump( ostream &os = cout ): Dumps information about the object to ostream os
Swpu* castToSwpu(): Poor man's RTTI

Overloaded member functions from PU

int initialise(): Initialise - see above for details
int download(): Download - see above for details
int start_run(): StartRun - see above for details
int end_run(): Endrun - see above for details

Protected Methods
int killProcess(): Stops the process
int spawnProcess(): Starts the process

Inherited from genNamedObj:

Public Methods
static void add( const char *name, X x )
inline static X begin()
inline static X end()
static bool exists( const char *name )
static X get( const char *name )
int getLocation()
inline static int getNbElements()
static X getObject( const char *name )
static int getObjects( const char *name, list<X> &theList )
inline const char* getObjName()
inline static X next()
static void remove( const char *name )

Private Fields
static map < const char*, X, cstring_ordering_t > ::iterator m_It
static map < const char*, X, cstring_ordering_t > m_Map
char* m_Name

Inherited from Pu:

Public
Accessors common to all PU

const char* getPudName()
Returns the name of the Process Unit Design
const char* getPrstName()
Return the name of the process stage, which controls this PU
Prst* getPrst()
Return a pointer to the process stage, which controls this PU
inline void enable()
To set the enable flag of the PU to true
inline void disable()
To set the disable flag of the PU to false
virtual bool isEnabled( const char* pccTransition = NULL )
To find out whether a process unit is enabled
void setSimulate( bool bValue )
To set the simulate mode
void setDebug( bool aBool )
To set the debug mode
bool getDebug()
Returns true if we are in debug mode
Architectural common member functions for all PU

Pu(const char *name, const char *pud_name )
constructor with the name and design as input
virtual ~Pu()
virtual destructor for handling dtor of subtypes
static mapPu_t mapPu
The PUs are organized in a global STL map
static bool exists( const char *name )
Returns true if a PU of this name exists
static mapPu_t::iterator locate( const char *name )
given the name of the PU return an STL map iterator to it
static Pu* get( char *name )
given the name return a pointer to the object itself
static int getPuByTag( const char* pcTag, list<Pu*> &theList )
To get a whole bunch of Pu that start with a given name
virtual void identify( ostream &os = cout )
To print out a one-line identifing message to the ostream os
virtual void dump( ostream &os = cout )
To print out a detailed summary of the Pu to ostream os
static void dump_all( ostream &os = cout )
To print out a detailed summary for all PU to ostream os
static void listAll( ostream &os = cout )
To print out a one-line summary for all PU to ostream os
Simple implementation of RTTI (see note above)

virtual Rdev* castToRdev()
virtual casts to Rdev
virtual Rout* castToRout()
virtual casts to Rout
virtual EvPool* castToEvPool()
virtual casts to EvPool
virtual Swpu* castToSwpu()
virtual casts to Swpu
virtual rcGTM* castToGTM()
virtual casts to GTM
virtual FEM* castToFEM()
virtual casts to FEM
virtual DCM* castToDCM()
virtual casts to DCM
virtual DDsocket* castToDDsocket()
virtual casts to DDsocket
virtual ROobject* castToROobject()
virtual casts to ROobject
virtual ddEventServer* castToddEventServer()
virtual casts to ddEventServer
virtual DataLogger* castToDataLogger()
virtual casts to DataLogger
virtual rcDataLogger* castToRcDataLogger()
virtual casts to rcDataLogger
virtual DummyDevice* castToDummyDevice()
virtual casts to Dummy device
virtual Par* castToPar()
virtual casts to Par
virtual EvbComponent* castToEvbComponent()
virtual casts to EvbComponent
State transitions

enum states
enum with the different possible states - these are common to all PU!!!
static const char* pcStates[]
the names of the state transitions as static const char*
int setState(int state )
Sets the state to the new state given by the enum int
int setState( const char *pcState )
Sets the state to the new state given by the name of the state
int getState()
Returns the state to the new state as enum int
const char* getcState()
Returns the state to the new state as a string
static int setStateAndUpdateStage( const char *pcPuGroup, const char *pcNewState )
Function that searches for a named PU (or group of PUs), sets its STT to the pcNewState and updates the ProcessStage at the same time
virtual functions for generic configuring, starting/updating/continuing a state transition

virtual int configure( const char* config_req, const char* value, const char *param = NULL )
To configure a PU
virtual int connect()
Connect is called once at initialisation time
virtual int initialise()
To initialise the PU
virtual int download()
To download the PU
virtual int start_run()
To start a new run
virtual int end_run()
To stop a run in progress
virtual bool updatePu( int iStatus, int eState_on_success )
Whenever a PU reports to the prst that is has done a state transition, the prst calls this virtual function
virtual bool checkReady( int iLevel )
Returns true if the process unit is in a ready state

Protected Fields
bool bDebug
bool bEnabled
bool bIgnoreErrorOnTransition[ eNStates ]
bool bSimulate
int eState
char* pcName
char* pcPud_name
const char* pcState

Protected Methods
int sendEventPuDone( int eState_on_success )
int updateStateAfterConfigReq( int eNewState = eInitialised )

Private Methods
int setIgnoreErrorOnTransition( const char* pcTransition, bool bValue )

Documentation

Proxy class for a generic SoftwareProcessUnit. A software process unit is any process running on a UNIX host. Currently it is not really used, but is rather a placeholder (but tested!). A typical use for the Swpu is to control a monitor process that monitors the data as it is taken.
The process unit can either be forked off at initialisation,download or startrun time.
Currently we only support processes running on the same host as the run control. With a little more work one could interface it to the launcher and gain the capability of having Swpus on any host in the galaxy (well... sort of).
Last update: Feb 5, 2000, CW

enum eSwpuStartModes

Enum for determining whether it is start at Init,download or startrun

Swpu(const char *name, const char *design, const char *host, const char *exec, int eStartMode = eStartAtStartRun )

Constructor with the name, type, host and executable to run. A optional parameter is the start mode. By default the swpu is started at startRun time.

~Swpu()