#include <cnullenvir.h>

Description

A do-nothing cEnvir implementation.

This class defines cEnvir's pure virtual methods with an empty body, with a trivial implementation, or to throw an exception with an "unsupported method" message.

This class is not used by OMNeT++, it is provided for convenience of writing standalone programs that embed the simulation kernel as a library.

You may want to subclass from cNullEnvir, and redefine some the following methods:

log() to print log messages instead of discarding them;
readParameter() to set module parameters, or at least apply the NED default value;
the RNG methods (getNumRNGs(), getRNG()) to provide more than one random number generator
recordScalar() and other statistics recording methods to store simulation results instead of discarding them

Inheritance diagram for cNullEnvir:

Public Member Functions
virtual void	objectDeleted (cObject *object) override

virtual void	simulationEvent (cEvent *event) override

virtual void	messageScheduled (cMessage *msg) override

virtual void	messageCancelled (cMessage *msg) override

virtual void	beginSend (cMessage *msg) override

virtual void	messageSendDirect (cMessage msg, cGate toGate, simtime_t propagationDelay, simtime_t transmissionDelay) override

virtual void	messageSendHop (cMessage msg, cGate srcGate) override

virtual void	messageSendHop (cMessage msg, cGate srcGate, simtime_t propagationDelay, simtime_t transmissionDelay, bool discard) override

virtual void	endSend (cMessage *msg) override

virtual void	messageCreated (cMessage *msg) override

virtual void	messageCloned (cMessage msg, cMessage clone) override

virtual void	messageDeleted (cMessage *msg) override

virtual void	moduleReparented (cModule module, cModule oldparent, int oldId) override

virtual void	componentMethodBegin (cComponent from, cComponent to, const char *methodFmt, va_list va, bool silent) override

virtual void	componentMethodEnd () override

virtual void	moduleCreated (cModule *newmodule) override

virtual void	moduleDeleted (cModule *module) override

virtual void	gateCreated (cGate *newgate) override

virtual void	gateDeleted (cGate *gate) override

virtual void	connectionCreated (cGate *srcgate) override

virtual void	connectionDeleted (cGate *srcgate) override

virtual void	displayStringChanged (cComponent *component) override

virtual void	undisposedObject (cObject *obj) override

virtual void	log (cLogEntry *entry) override

virtual void	preconfigure (cComponent *component) override

virtual void	configure (cComponent *component) override

virtual void	readParameter (cPar *par) override

virtual bool	isModuleLocal (cModule parentmod, const char modname, int index) override

virtual cXMLElement *	getXMLDocument (const char filename, const char xpath=nullptr) override

virtual cXMLElement *	getParsedXMLString (const char content, const char xpath=nullptr) override

virtual void	forgetXMLDocument (const char *filename) override

virtual void	forgetParsedXMLString (const char *content) override

virtual void	flushXMLDocumentCache () override

virtual void	flushXMLParsedContentCache () override

virtual unsigned	getExtraStackForEnvir () const override

virtual cConfiguration *	getConfig () override

virtual std::string	resolveResourcePath (const char fileName, cComponentType context) override

virtual bool	isGUI () const override

virtual bool	isExpressMode () const override

virtual void	getImageSize (const char *imageName, double &outWidth, double &outHeight) override

virtual void	getTextExtent (const cFigure::Font &font, const char *text, double &outWidth, double &outHeight, double &outAscent) override

virtual void	appendToImagePath (const char *directory) override

virtual void	loadImage (const char fileName, const char imageName=nullptr) override

virtual cFigure::Rectangle	getSubmoduleBounds (const cModule *submodule) override

virtual double	getZoomLevel (const cModule *module) override

virtual double	getAnimationTime () const override

virtual double	getAnimationSpeed () const override

virtual double	getRemainingAnimationHoldTime () const override

virtual void	bubble (cComponent component, const char text) override

virtual std::string	gets (const char prompt, const char defaultreply=nullptr) override

virtual int	getNumRNGs () const override

virtual cRNG *	getRNG (int k) override

virtual void *	registerOutputVector (const char modulename, const char vectorname) override

virtual void	deregisterOutputVector (void *vechandle) override

virtual void	setVectorAttribute (void vechandle, const char name, const char *value) override

virtual bool	recordInOutputVector (void *vechandle, simtime_t t, double value) override

virtual void	recordScalar (cComponent component, const char name, double value, opp_string_map *attributes=nullptr) override

virtual void	recordStatistic (cComponent component, const char name, cStatistic statistic, opp_string_map attributes=nullptr) override

virtual void	addResultRecorders (cComponent component, simsignal_t signal, const char statisticName, cProperty *statisticTemplateProperty) override

virtual std::ostream *	getStreamForSnapshot () override

virtual void	releaseStreamForSnapshot (std::ostream *os) override

virtual int	getArgCount () const override

virtual char **	getArgVector () const override

virtual int	getParsimProcId () const override

virtual int	getParsimNumPartitions () const override

virtual unsigned long	getUniqueNumber () override

virtual void	refOsgNode (osg::Node *scene) override

virtual void	unrefOsgNode (osg::Node *scene) override

virtual bool	idle () override

virtual bool	ensureDebugger (cRuntimeError *) override

virtual void	addLifecycleListener (cISimulationLifecycleListener *listener) override

virtual void	removeLifecycleListener (cISimulationLifecycleListener *listener) override

Public Member Functions inherited from cEnvir
	cEnvir ()

virtual	~cEnvir ()

virtual void	componentInitBegin (cComponent *component, int stage)

virtual const char *	getCurrentEventName ()

virtual const char *	getCurrentEventClassName ()

virtual cModule *	getCurrentEventModule ()

virtual cConfigurationEx *	getConfigEx ()

bool	isLoggingEnabled () const

virtual void	printfmsg (const char *fmt,...)

Protected Member Functions
virtual void	alert (const char *msg) override

virtual bool	askYesNo (const char *prompt) override

Member Function Documentation

◆ alert()

virtual void alert ( const char * msg )

inlineoverrideprotectedvirtual

Displays the given alert text in a conspicuous way, e.g. in a dialog box. This function should be used sparingly from models, if ever.

Implements cEnvir.

◆ askYesNo()

virtual bool askYesNo ( const char * prompt )

inlineoverrideprotectedvirtual

Asks the user a yes/no question with the given prompt. The return value is true for "yes", and false for "no". This function should be used sparingly from models, if ever.

Implements cEnvir.

◆ objectDeleted()

virtual void objectDeleted ( cObject * object )

inlineoverridevirtual

Notifies the environment that the object no longer exists. The user interface should close all inspector windows for the object and remove it from object lists currently displayed. cObject's destructor automatically calls this function.

Reimplemented from cEnvir.

◆ simulationEvent()

virtual void simulationEvent ( cEvent * event )

inlineoverridevirtual

Notifies the environment that a message was delivered to its destination module, that is, a message arrival event occurred. Details can be extracted from the message object itself. The user interface implementation may use the notification to animate the message on a network diagram, to write a log entry, etc.

Implements cEnvir.

◆ messageScheduled()

virtual void messageScheduled ( cMessage * msg )

inlineoverridevirtual

Notifies the environment that a message was scheduled.

See also: cSimpleModule::scheduleAt()

Implements cEnvir.

◆ messageCancelled()

virtual void messageCancelled ( cMessage * msg )

inlineoverridevirtual

Notifies the environment that a scheduled message was cancelled.

See also: cSimpleModule::cancelEvent()

Implements cEnvir.

◆ beginSend()

virtual void beginSend ( cMessage * msg )

inlineoverridevirtual

Notifies the environment that a message is being sent from a simple module. beginSend() will be followed by a messageSendDirect() (optional, only present when cSimpleModule::sendDirect() was called), several messageSendHop() calls (one for each connection in the path), and finally an endSend(). At least one call to either messageSendDirect() or messageSendHop() must occur between corresponding beginSend()/endSend() pairs.

Implements cEnvir.

◆ messageSendDirect()

virtual void messageSendDirect	(	cMessage *	msg,
		cGate *	toGate,
		simtime_t	propagationDelay,
		simtime_t	transmissionDelay
	)

inlineoverridevirtual

Part of the beginSend() sequence.

See also: beginSend()

Implements cEnvir.

◆ messageSendHop() [1/2]

virtual void messageSendHop	(	cMessage *	msg,
		cGate *	srcGate
	)

inlineoverridevirtual

Part of the beginSend() sequence.

See also: beginSend()

Implements cEnvir.

◆ messageSendHop() [2/2]

virtual void messageSendHop	(	cMessage *	msg,
		cGate *	srcGate,
		simtime_t	propagationDelay,
		simtime_t	transmissionDelay,
		bool	discard
	)

inlineoverridevirtual

Part of the beginSend() sequence.

See also: beginSend()

Implements cEnvir.

◆ endSend()

virtual void endSend ( cMessage * msg )

inlineoverridevirtual

Closes a beginSend() sequence.

See also: beginSend()

Implements cEnvir.

◆ messageCreated()

virtual void messageCreated ( cMessage * msg )

inlineoverridevirtual

Notifies the environment that a message object is being created. This is called from the cMessage constructor.

Implements cEnvir.

◆ messageCloned()

virtual void messageCloned	(	cMessage *	msg,
		cMessage *	clone
	)

inlineoverridevirtual

Notifies the environment that a message object is being cloned. This is called from the cMessage copy constructor.

Implements cEnvir.

◆ messageDeleted()

virtual void messageDeleted ( cMessage * msg )

inlineoverridevirtual

Notifies the environment that a message object is being deleted. This is called from the cMessage destructor, so any information added to cMessage via subclassing is already lost at the time of the call.

Implements cEnvir.

◆ moduleReparented()

virtual void moduleReparented	(	cModule *	module,
		cModule *	oldparent,
		int	oldId
	)

inlineoverridevirtual

Notifies the environment that a module changed parent.

Implements cEnvir.

◆ componentMethodBegin()

virtual void componentMethodBegin	(	cComponent *	from,
		cComponent *	to,
		const char *	methodFmt,
		va_list	va,
		bool	silent
	)

inlineoverridevirtual

Notifies the environment that one component (module) called a member function of another component. This hook enables a graphical user interface to animate the method call in the network diagram. Pass methodFmt==nullptr for Enter_Method_Silent.

Implements cEnvir.

◆ componentMethodEnd()

virtual void componentMethodEnd ( )

inlineoverridevirtual

Notifies the environment that the method entered in the last componentMethodBegin() call has exited.

Implements cEnvir.

◆ moduleCreated()

virtual void moduleCreated ( cModule * newmodule )

inlineoverridevirtual

Notifies the environment that a module was created. This method is called from cModuleType::create(), when the module has already been created but buildInside() has not been invoked yet.

Implements cEnvir.

◆ moduleDeleted()

virtual void moduleDeleted ( cModule * module )

inlineoverridevirtual

Notifies the environment that a module was (more precisely: is being) deleted. This method is called from cModule destructor, so the "real" type (getClassName() and everything from the actual subclass) is already lost at this point, however getName(), getFullName(), getFullPath(), gates, parameters (everything that comes from cModule) are still valid.

If a compound module (or a module with dynamically created submodules) is deleted, one should not assume anything about the relative order moduleDeleted() is called for the module and its submodules.

Implements cEnvir.

◆ gateCreated()

virtual void gateCreated ( cGate * newgate )

inlineoverridevirtual

Notifies the environment that a gates was created.

Implements cEnvir.

◆ gateDeleted()

virtual void gateDeleted ( cGate * gate )

inlineoverridevirtual

Notifies the environment that a gates was (more precisely: is being) deleted.

Implements cEnvir.

◆ connectionCreated()

virtual void connectionCreated ( cGate * srcgate )

inlineoverridevirtual

Notifies the environment that a connection has been created using srcgate->connectTo().

Implements cEnvir.

◆ connectionDeleted()

virtual void connectionDeleted ( cGate * srcgate )

inlineoverridevirtual

Notifies the environment that a connection has been deleted using srcgate->disconnect().

Implements cEnvir.

◆ displayStringChanged()

virtual void displayStringChanged ( cComponent * component )

inlineoverridevirtual

Notifies the environment that a module or channel display string has changed.

Implements cEnvir.

◆ undisposedObject()

virtual void undisposedObject ( cObject * obj )

inlineoverridevirtual

Called from module destructors, to notify the environment about objects that the user did not delete in the module destructor.

Reimplemented from cEnvir.

◆ log()

virtual void log ( cLogEntry * entry )

inlineoverridevirtual

Log a line described by the entry.

Implements cEnvir.

◆ preconfigure()

virtual void preconfigure ( cComponent * component )

inlineoverridevirtual

Called when a module or channel object has been created and added to the model, but no parameters or gates have been set up yet. It allows the environment perform extra configuration. One use is to set up RNG mapping.

Implements cEnvir.

◆ configure()

virtual void configure ( cComponent * component )

inlineoverridevirtual

Called when a module or channel has been created and installed in the model, after parameters and gates have been set up, but before submodules and internal connections are added. This method lets the environment perform extra configuration.

Implements cEnvir.

◆ readParameter()

virtual void readParameter ( cPar * parameter )

inlineoverridevirtual

Assigns the module or channel parameter from the configuration, or by asking the user.

Implements cEnvir.

◆ isModuleLocal()

virtual bool isModuleLocal	(	cModule *	parentmod,
		const char *	modname,
		int	index
	)

inlineoverridevirtual

Used for parallel distributed simulation. Returns true if the named future submodule of parentmod is (or will have any submodule) in the local partition, and false otherwise. index should be -1 if the submodule is not in a module vector.

Note that for compound modules that contain simple modules in several partitions, this function will return true on all those partitions.

Implements cEnvir.

◆ getXMLDocument()

virtual cXMLElement* getXMLDocument	(	const char *	filename,
		const char *	xpath = `nullptr`
	)

inlineoverridevirtual

Resolves reference to an XML model configuration file. First argument is the file name of the XML document. The optional second argument may contain an XPath-like expression to denote an element within the XML document. If path is not present, the root element is returned.

See documentation of cXMLElement::getElementByPath() for path syntax. There is a difference however: paths starting with "." are not accepted, and the first path component must name the root element of the document (with getElementByPath() it would match a child element of the current element). That is, a leading "/" is always assumed at the beginning of the path expression, even if it is not explicitly there.

The method throws an exception if the document cannot be found, there was a parse error, or the given path expression is invalid. It returns nullptr if the element denoted by the path expression does not exist in the document.

The returned object tree should not be modified because cEnvir may cache the file and return the same pointer to several callers.

Implements cEnvir.

◆ getParsedXMLString()

virtual cXMLElement* getParsedXMLString	(	const char *	content,
		const char *	xpath = `nullptr`
	)

inlineoverridevirtual

Returns the parsed form of an XML content string. The first argument is the XML content string. The optional second argument may contain an XPath-like expression to denote an element within the XML document. If path is not present, the root element is returned.

See documentation of cXMLElement::getElementByPath() for path syntax. There is a difference however: paths starting with "." are not accepted, and the first path component must name the root element of the document (with getElementByPath() it would match a child element of the current element). That is, a leading "/" is always assumed at the beginning of the path expression, even if it is not explicitly there.

The method throws an exception if there was a parse error or if the given path expression is invalid. It returns nullptr if the element denoted by the path expression does not exist in the document.

The returned object tree should not be modified because cEnvir may cache the tree and return the same pointer to several callers.

Implements cEnvir.

◆ forgetXMLDocument()

virtual void forgetXMLDocument ( const char * filename )

inlineoverridevirtual

Removes the given document from the XML document cache (if cached), and deletes the object tree from memory. Further getXMLDocument() calls will reload the file from the disk. After forgetXMLDocument(), cXMLElement objects returned for the same document by getXMLDocument() should no longer be referenced. The call has no effect if the given file does not exist or has not yet been loaded.

CAUTION: As of version 4.1, this is not a safe operation! Module parameters (cPar) of type "xml" hold pointers to the element trees returned by getXMLDocument(), and this method makes those pointers invalid.

Implements cEnvir.

◆ forgetParsedXMLString()

virtual void forgetParsedXMLString ( const char * content )

inlineoverridevirtual

Removes the given document from the XML document cache (if cached), and deletes the object tree from memory. After forgetXMLDocument(), cXMLElement objects returned for the same content string by getParsedXMLString() should no longer be referenced. The call has no effect if the given string has not yet been parsed.

CAUTION: As of version 4.1, this is not a safe operation! Module parameters (cPar) of type "xml" hold pointers to the element trees returned by getXMLDocument(), and this method makes those pointers invalid.

Implements cEnvir.

◆ flushXMLDocumentCache()

virtual void flushXMLDocumentCache ( )

inlineoverridevirtual

Clears the cache of loaded XML documents, and deletes the corresponding cXMLElement trees.

CAUTION: As of version 4.1, this is not a safe operation, as module parameters (cPar) of type "xml" hold pointers to the element trees returned by getXMLDocument(), and this method makes those pointers invalid.

Implements cEnvir.

◆ flushXMLParsedContentCache()

virtual void flushXMLParsedContentCache ( )

inlineoverridevirtual

Clears the cache of parsed XML content strings, and deletes the corresponding cXMLElement trees.

CAUTION: As of version 4.1, this is not a safe operation, as module parameters (cPar) of type "xml" hold pointers to the element trees returned by getXMLDocument(), and this method makes those pointers invalid.

Implements cEnvir.

◆ getExtraStackForEnvir()

virtual unsigned getExtraStackForEnvir ( ) const

inlineoverridevirtual

Called from cSimpleModule, it returns how much extra stack space the user interface recommends for activity() simple modules.

Implements cEnvir.

◆ getConfig()

virtual cConfiguration* getConfig ( )

inlineoverridevirtual

Access to the configuration (by default, omnetpp.ini). This method is provided here for the benefit of schedulers, parallel simulation algorithms and other simulation kernel extensions. Models (simple modules) should NOT directly access the configuration – they should rely on module parameters to get input.

Implements cEnvir.

◆ resolveResourcePath()

virtual std::string resolveResourcePath	(	const char *	fileName,
		cComponentType *	context
	)

inlineoverridevirtual

Searches a number of folders for a resource given with its file name or relative path, and returns the path for the first match. If the resource is not found, the empty string is returned.

The list of the search folders includes the current working directory, the folder of the main ini file, the folder that the NED file of the given "context" type was loaded from, folders in the NED path, and folders in the image path (OMNETPP_IMAGE_PATH).

Implements cEnvir.

◆ isGUI()

virtual bool isGUI ( ) const

inlineoverridevirtual

Returns true if the current environment is a graphical user interface. (For example, it returns true if the simulation is running over Tkenv or Qtenv, and false if it's running over Cmdenv.) Modules can examine this flag to decide whether or not they need to bother with visualization, e.g. dynamically updating display strings or drawing on canvases.

Implements cEnvir.

◆ isExpressMode()

virtual bool isExpressMode ( ) const

inlineoverridevirtual

Returns true if the simulation is running under a GUI in Express mode. Visualization code (e.g. inside module refreshDisplay() methods) may check this flag and adapt the visualization accordingly.

Implements cEnvir.

◆ getImageSize()

virtual void getImageSize	(	const char *	imageName,
		double &	outWidth,
		double &	outHeight
	)

inlineoverridevirtual

Returns the size of the image with the given name (e.g. "block/switch_l") in pixels. If the image does not exist, it returns the size of the "unknown" icon (as that is the image actually displayed). Non-GUI environments like Cmdenv may return made-up (but not completely unrealistic) numbers.

This method is used by some methods of cImageFigure, e.g. getBounds().

Implements cEnvir.

◆ getTextExtent()

virtual void getTextExtent	(	const cFigure::Font &	font,
		const char *	text,
		double &	outWidth,
		double &	outHeight,
		double &	outAscent
	)

inlineoverridevirtual

Returns the size and ascent of the bounding box of the text when rendered with the given font in the GUI. Non-GUI environments like Cmdenv may return made-up (but not completely unrealistic) numbers.

This method is used by some methods of cTextFigure, e.g. getBounds().

Implements cEnvir.

◆ appendToImagePath()

virtual void appendToImagePath ( const char * directory )

inlineoverridevirtual

Tells the user interface to load the images from the given directory, as if the directory was part of the the OMNeT++ image path. The loaded images can then be used in display strings and with cImageFigure/cIconFigure.

An error is thrown if the given directory does not exist or cannot be accessed. This method is idempotent: the second and further invocations with the same parameter have no effect. The method may have no effect if the simulation is running under Cmdenv or another non-graphical user interface.

Implements cEnvir.

◆ loadImage()

virtual void loadImage	(	const char *	fileName,
		const char *	imageName = `nullptr`
	)

inlineoverridevirtual

Tells the user interface to load the image from the given image file. The loaded image can then be used in display strings and with cImageFigure/cIconFigure, by referencing it with the image name. If the location of the image file is not known or cannot be easily determined, resolveResourcePath() may be used to find it prior to loadImage().

The image name may be specified explicitly (in the imageName argument), or if it is missing (is nullptr or empty string), the base file name will be used (fileName with directories and extension stripped). Note that if an image with the given name has already been loaded, this method will do nothing, i.e. already loaded images are NOT replaced. This also means that the method is idempotent: the second and further invocations with the same parameter have no effect.

An error is thrown if the given file does not exist or cannot be loaded as a supported image format. The method may have no effect if the simulation is running under Cmdenv or another non-graphical user interface.

See also: resolveResourcePath()

Implements cEnvir.

◆ getSubmoduleBounds()

virtual cFigure::Rectangle getSubmoduleBounds ( const cModule * submodule )

inlineoverridevirtual

Returns the effective bounding rectangle of the given module when it is visualized in the graphical inspector of its containing compound module, or (NAN,NAN,NAN,NAN) if such a rectangle is not available. This method is the only way to access positions of "floating" modules, i.e. those placed by a layouting algorithm that runs as part of the UI. The method may unconditionally return (NAN,NAN,NAN,NAN) if the simulation is running under Cmdenv or another non-graphical user interface.

Also note that this method may return different values at different times, e.g. as a result of the user opening and closing inspectors, hitting the "Relayout" button, or even changing the zoom level or icon size of graphical module inspectors displaying the parent module. Visualization code relying on this method is advised to re-read coordinates in every refreshDisplay() call, and check whether they changed since last time.

Implements cEnvir.

◆ getZoomLevel()

virtual double getZoomLevel ( const cModule * module )

inlineoverridevirtual

Returns the current zoom level of a graphical module inspector displaying the given module (its contents from the inside, not as a submodule icon), or NAN if not available. A value of 1.0 means 100% zoom (actual size), 0.5 means 50% (half size), and so on. The method may unconditionally return NAN if the simulation is running under Cmdenv or another non-graphical user interface.

Also note that this method may return different values at different times, e.g. as a result of the user changing the zoom level, or even opening and closing inspectors. Visualization code relying on this method is advised to re-read the value in every refreshDisplay() call, and check whether it changed since last time.

Implements cEnvir.

◆ getAnimationTime()

virtual double getAnimationTime ( ) const

inlineoverridevirtual

Returns the current animation time. Animation time starts from zero, and monotonically increases with simulation time and also during zero-simtime animations a.k.a. "holds". The method may return 0 if the simulation is running under Cmdenv or another non-graphical user interface.

Implements cEnvir.

◆ getAnimationSpeed()

virtual double getAnimationSpeed ( ) const

inlineoverridevirtual

Returns the current animation speed. It is usually computed as the minimum of the animation speeds of visible canvases, unless the user interactively overrides it in the UI, for example imposes a lower limit. The method returns 0 if there is currently no animation speed, or the simulation is running under Cmdenv or another non-graphical user interface.

See also: cCanvas::setAnimationSpeed()

Implements cEnvir.

◆ getRemainingAnimationHoldTime()

virtual double getRemainingAnimationHoldTime ( ) const

inlineoverridevirtual

Returns the remaining animation "hold" time. This is the maximum of the animation times remaining from the holds times requested by visible canvases.

See also: cCanvas::holdSimulationFor()

Implements cEnvir.

◆ bubble()

virtual void bubble	(	cComponent *	component,
		const char *	text
	)

inlineoverridevirtual

In graphical user interfaces (Tkenv/Qtenv), it pops up a transient "bubble" over the module icon.

Implements cEnvir.

◆ gets()

virtual std::string gets	(	const char *	prompt,
		const char *	defaultReply = `nullptr`
	)

inlineoverridevirtual

Interactively prompts the user to enter a string. This function should be used sparingly from models, if ever.

Implements cEnvir.

◆ getNumRNGs()

virtual int getNumRNGs ( ) const

inlineoverridevirtual

Returns the number of RNGs available for the simulation ("num-rngs=" omnetpp.ini setting).

Implements cEnvir.

◆ getRNG()

virtual cRNG* getRNG ( int k )

inlineoverridevirtual

Returns pointer to "physical" RNG k (0 <= k < getNumRNGs()).

Implements cEnvir.

◆ registerOutputVector()

virtual void* registerOutputVector	(	const char *	modulename,
		const char *	vectorname
	)

inlineoverridevirtual

This method is intended to be called by cOutVector objects to register themselves. The returned value is a handle that identifies the vector in subsequent recordInOutputVector() and deregisterOutputVector() calls. The handle may have any value (it does not have to be a valid pointer), but it should NOT be nullptr.

Implements cEnvir.

◆ deregisterOutputVector()

virtual void deregisterOutputVector ( void * vechandle )

inlineoverridevirtual

cOutVector objects must deregister themselves when they are no longer needed.

Implements cEnvir.

◆ setVectorAttribute()

virtual void setVectorAttribute	(	void *	vechandle,
		const char *	name,
		const char *	value
	)

inlineoverridevirtual

This method is called when an attribute of the output vector is set.

Implements cEnvir.

◆ recordInOutputVector()

virtual bool recordInOutputVector	(	void *	vechandle,
		simtime_t	t,
		double	value
	)

inlineoverridevirtual

This method is intended to be called by cOutVector objects to write a value into the output vector. The return value is true if the data was actually recorded, and false if it was not recorded (because of filtering, etc.)

Implements cEnvir.

◆ recordScalar()

virtual void recordScalar	(	cComponent *	component,
		const char *	name,
		double	value,
		opp_string_map *	attributes = `nullptr`
	)

inlineoverridevirtual

Records a double scalar result, in a default configuration into the scalar result file.

Implements cEnvir.

◆ recordStatistic()

virtual void recordStatistic	(	cComponent *	component,
		const char *	name,
		cStatistic *	statistic,
		opp_string_map *	attributes = `nullptr`
	)

inlineoverridevirtual

Records a statistic object (histogram, etc) into the scalar result file. This operation may invoke the setUpBins() method on the histogram object.

Implements cEnvir.

◆ addResultRecorders()

virtual void addResultRecorders	(	cComponent *	component,
		simsignal_t	signal,
		const char *	statisticName,
		cProperty *	statisticTemplateProperty
	)

inlineoverridevirtual

Adds result recording listeners for the given signal on the given component. The result will be recorded to the the given component, with a name equal to or derived from the given statisticName. The statisticTemplateProperty parameter is expected to point to a @statisticTemplate NED property with content similar to @statistic properties. The computation and result type (scalar, vector, etc) will be taken from the 'record' key of statisticTemplateProperty in the same way as with @statistic. Also similar to @statistic, key-value pairs of statisticTemplateProperty will be recorded as result attributes.

In statisticTemplateProperty, the 'source' key will be ignored (because the signal given as parameter will be used as source). The actual name and index of statisticTemplateProperty will also be ignored. (With @statistic, the index holds the result name, but here the name is explicitly specified in the statisticName parameter.)

The purpose of this function is to allow setting up signal-based result recording dynamically when static configuration via @statistic properties is not possible, e.g. because the set of signals to record is only known at runtime.

Implements cEnvir.

◆ getStreamForSnapshot()

virtual std::ostream* getStreamForSnapshot ( )

inlineoverridevirtual

Returns a stream where a snapshot can be written. Called from cSimulation::snapshot().

Implements cEnvir.

◆ releaseStreamForSnapshot()

virtual void releaseStreamForSnapshot ( std::ostream * os )

inlineoverridevirtual

Releases a stream after a snapshot was written.

Implements cEnvir.

◆ getArgCount()

virtual int getArgCount ( ) const

inlineoverridevirtual

Access to original command-line arguments.

Implements cEnvir.

◆ getArgVector()

virtual char** getArgVector ( ) const

inlineoverridevirtual

Access to original command-line arguments.

Implements cEnvir.

◆ getParsimProcId()

virtual int getParsimProcId ( ) const

inlineoverridevirtual

Returns the partitionID when parallel simulation is active.

Implements cEnvir.

◆ getParsimNumPartitions()

virtual int getParsimNumPartitions ( ) const

inlineoverridevirtual

Returns the number of partitions when parallel simulation is active; otherwise it returns 0.

Implements cEnvir.

◆ getUniqueNumber()

virtual unsigned long getUniqueNumber ( )

inlineoverridevirtual

The function underlying cSimulation::getUniqueNumber().

Implements cEnvir.

◆ refOsgNode()

virtual void refOsgNode ( osg::Node * scene )

inlineoverridevirtual

Used by cOsgCanvas to increase the reference count of an osg::Node. Should delegate to node->ref() when OSG support is available.

Implements cEnvir.

◆ unrefOsgNode()

virtual void unrefOsgNode ( osg::Node * scene )

inlineoverridevirtual

Used by cOsgCanvas to increase the reference count of an osg::Node. Should delegate to node->unref() when OSG support is available.

Implements cEnvir.

◆ idle()

virtual bool idle ( )

inlineoverridevirtual

May be called from the simulation while actively waiting for some external condition to occur – for example from blocking receive in parallel simulation, or during wait in real-time simulation.

In a graphical user interface, this method may take care of display redraw and handling user interaction (including handling of the Stop button).

Normally returns false. A true value means the user wants to abort waiting (e.g. pushed the Stop button).

Implements cEnvir.

◆ ensureDebugger()

virtual bool ensureDebugger ( cRuntimeError * error )

inlineoverridevirtual

Starts an external debugger program and attaches it to this process, if no already attached debugger is detected. The command line to start the debugger can be configured.

The error parameter points to the exception that is the reason a debugger is needed. If there is no error, just a simple request for debugging, it is nullptr.

Returns true if a debugger was already attached, or one could be started and attached successfully. Returns false if a debugger was not already attached and could not be started, or the user chose not to start and attach one.

Implements cEnvir.

◆ addLifecycleListener()

virtual void addLifecycleListener ( cISimulationLifecycleListener * listener )

overridevirtual

Adds a listener that will be notified about simulation lifecycle events. It has no effect if the listener is already subscribed. NOTE: The listeners will NOT be deleted when the program exits.

Implements cEnvir.

◆ removeLifecycleListener()

virtual void removeLifecycleListener ( cISimulationLifecycleListener * listener )

overridevirtual

Removes the given listener. This method has no effect if the listener is not currently subscribed.

Implements cEnvir.

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

cnullenvir.h

Description

Public Member Functions

Protected Member Functions

Member Function Documentation

◆ alert()

◆ askYesNo()

◆ objectDeleted()

◆ simulationEvent()

◆ messageScheduled()

◆ messageCancelled()

◆ beginSend()

◆ messageSendDirect()

◆ messageSendHop() [1/2]

◆ messageSendHop() [2/2]

◆ endSend()

◆ messageCreated()

◆ messageCloned()

◆ messageDeleted()

◆ moduleReparented()

◆ componentMethodBegin()

◆ componentMethodEnd()

◆ moduleCreated()

◆ moduleDeleted()

◆ gateCreated()

◆ gateDeleted()

◆ connectionCreated()

◆ connectionDeleted()

◆ displayStringChanged()

◆ undisposedObject()

◆ log()

◆ preconfigure()

◆ configure()

◆ readParameter()

◆ isModuleLocal()

◆ getXMLDocument()

◆ getParsedXMLString()

◆ forgetXMLDocument()

◆ forgetParsedXMLString()

◆ flushXMLDocumentCache()

◆ flushXMLParsedContentCache()

◆ getExtraStackForEnvir()

◆ getConfig()

◆ resolveResourcePath()

◆ isGUI()

◆ isExpressMode()

◆ getImageSize()

◆ getTextExtent()

◆ appendToImagePath()

◆ loadImage()

◆ getSubmoduleBounds()

◆ getZoomLevel()

◆ getAnimationTime()

◆ getAnimationSpeed()

◆ getRemainingAnimationHoldTime()

◆ bubble()

◆ gets()

◆ getNumRNGs()

◆ getRNG()

◆ registerOutputVector()

◆ deregisterOutputVector()

◆ setVectorAttribute()

◆ recordInOutputVector()

◆ recordScalar()

◆ recordStatistic()

◆ addResultRecorders()

◆ getStreamForSnapshot()

◆ releaseStreamForSnapshot()

◆ getArgCount()

◆ getArgVector()

◆ getParsimProcId()

◆ getParsimNumPartitions()

◆ getUniqueNumber()

◆ refOsgNode()

◆ unrefOsgNode()

◆ idle()

◆ ensureDebugger()

◆ addLifecycleListener()

◆ removeLifecycleListener()