cRunnableEnvir Class Reference

#include <cenvir.h>

Description

A cEnvir that can be instantiated as a user interface, like Cmdenv and Tkenv.

Inheritance diagram for cRunnableEnvir:

Public Member Functions
virtual int	run (int argc, char *argv[], cConfiguration *cfg)=0
Public Member Functions inherited from cEnvir
	cEnvir ()
virtual	~cEnvir ()
virtual void	objectDeleted (cObject *object)
virtual void	componentInitBegin (cComponent *component, int stage)
virtual void	simulationEvent (cEvent *event)=0
virtual void	messageScheduled (cMessage *msg)=0
virtual void	messageCancelled (cMessage *msg)=0
virtual void	beginSend (cMessage *msg, const SendOptions &options)=0
virtual void	messageSendDirect (cMessage *msg, cGate *toGate, const ChannelResult &result)=0
virtual void	messageSendHop (cMessage *msg, cGate *srcGate)=0
virtual void	messageSendHop (cMessage *msg, cGate *srcGate, const ChannelResult &result)=0
virtual void	endSend (cMessage *msg)=0
virtual void	messageCreated (cMessage *msg)=0
virtual void	messageCloned (cMessage *msg, cMessage *clone)=0
virtual void	messageDeleted (cMessage *msg)=0
virtual void	moduleReparented (cModule *module, cModule *oldparent, int oldId)=0
virtual void	componentMethodBegin (cComponent *from, cComponent *to, const char *methodFmt, va_list va, bool silent)=0
virtual void	componentMethodEnd ()=0
virtual void	moduleCreated (cModule *newmodule)=0
virtual void	moduleDeleted (cModule *module)=0
virtual void	gateCreated (cGate *newgate)=0
virtual void	gateDeleted (cGate *gate)=0
virtual void	connectionCreated (cGate *srcgate)=0
virtual void	connectionDeleted (cGate *srcgate)=0
virtual void	displayStringChanged (cComponent *component)=0
virtual void	undisposedObject (cObject *obj)
virtual const char *	getCurrentEventName ()
virtual const char *	getCurrentEventClassName ()
virtual cModule *	getCurrentEventModule ()
virtual void	preconfigure (cComponent *component)=0
virtual void	configure (cComponent *component)=0
virtual void	readParameter (cPar *parameter)=0
virtual bool	isModuleLocal (cModule *parentmod, const char *modname, int index)=0
virtual cXMLElement *	getXMLDocument (const char *filename, const char *xpath=nullptr)=0
virtual cXMLElement *	getParsedXMLString (const char *content, const char *xpath=nullptr)=0
virtual void	forgetXMLDocument (const char *filename)=0
virtual void	forgetParsedXMLString (const char *content)=0
virtual void	flushXMLDocumentCache ()=0
virtual void	flushXMLParsedContentCache ()=0
virtual unsigned	getExtraStackForEnvir () const =0
virtual cConfiguration *	getConfig ()=0
virtual cConfigurationEx *	getConfigEx ()
virtual std::string	resolveResourcePath (const char *fileName, cComponentType *context=nullptr)=0
virtual bool	isGUI () const =0
bool	isLoggingEnabled () const
virtual bool	isExpressMode () const =0
virtual void	bubble (cComponent *component, const char *text)=0
virtual void	log (cLogEntry *entry)=0
virtual void	alert (const char *msg)=0
virtual void	printfmsg (const char *fmt,...)
virtual std::string	gets (const char *prompt, const char *defaultReply=nullptr)=0
virtual bool	askYesNo (const char *prompt)=0
virtual void	getImageSize (const char *imageName, double &outWidth, double &outHeight)=0
virtual void	getTextExtent (const cFigure::Font &font, const char *text, double &outWidth, double &outHeight, double &outAscent)=0
virtual void	appendToImagePath (const char *directory)=0
virtual void	loadImage (const char *fileName, const char *imageName=nullptr)=0
virtual cFigure::Rectangle	getSubmoduleBounds (const cModule *submodule)=0
virtual std::vector< cFigure::Point >	getConnectionLine (const cGate *sourceGate)=0
virtual double	getZoomLevel (const cModule *module)=0
virtual double	getAnimationTime () const =0
virtual double	getAnimationSpeed () const =0
virtual double	getRemainingAnimationHoldTime () const =0
virtual int	getNumRNGs () const =0
virtual cRNG *	getRNG (int k)=0
virtual void *	registerOutputVector (const char *modulename, const char *vectorname)=0
virtual void	deregisterOutputVector (void *vechandle)=0
virtual void	setVectorAttribute (void *vechandle, const char *name, const char *value)=0
virtual bool	recordInOutputVector (void *vechandle, simtime_t t, double value)=0
virtual void	recordScalar (cComponent *component, const char *name, double value, opp_string_map *attributes=nullptr)=0
virtual void	recordStatistic (cComponent *component, const char *name, cStatistic *statistic, opp_string_map *attributes=nullptr)=0
virtual void	recordParameter (cPar *par)=0
virtual void	recordComponentType (cComponent *component)=0
virtual void	addResultRecorders (cComponent *component, simsignal_t signal, const char *statisticName, cProperty *statisticTemplateProperty)=0
virtual std::ostream *	getStreamForSnapshot ()=0
virtual void	releaseStreamForSnapshot (std::ostream *os)=0
virtual int	getArgCount () const =0
virtual char **	getArgVector () const =0
virtual int	getParsimProcId () const =0
virtual int	getParsimNumPartitions () const =0
virtual unsigned long	getUniqueNumber ()=0
virtual void	refOsgNode (osg::Node *scene)=0
virtual void	unrefOsgNode (osg::Node *scene)=0
virtual bool	idle ()=0
virtual void	pausePoint ()=0
virtual bool	ensureDebugger (cRuntimeError *error=nullptr)=0
virtual void	addLifecycleListener (cISimulationLifecycleListener *listener)
virtual void	removeLifecycleListener (cISimulationLifecycleListener *listener)
virtual std::vector< cISimulationLifecycleListener * >	getLifecycleListeners () const
virtual void	notifyLifecycleListeners (SimulationLifecycleEventType eventType, cObject *details=nullptr)

Member Function Documentation

run()

virtual int run ( int  argc, char *  argv[], cConfiguration *  cfg  )

pure virtual

Runs the user interface. The return value will become the exit code of the simulation program.

---

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

• cenvir.h