cStackCleanupException Class Reference

API: cStackCleanupException Class Reference
API
cStackCleanupException Class Reference
Inheritance diagram for cStackCleanupException:
[legend]

Public Member Functions

 cStackCleanupException ()
 cStackCleanupException (const cStackCleanupException &e)=default
virtual cStackCleanupExceptiondup () const override
virtual bool isError () const override
Public Member Functions inherited from cException
 cException (ErrorCodeInt errcode,...)
 cException (const char *msg,...)
 cException (const cObject *where, ErrorCodeInt errcode,...)
 cException (const cObject *where, const char *msg,...)
 cException (const cException &)=default
virtual ~cException () throw ()
virtual void setMessage (const char *txt)
virtual void prependMessage (const char *fmt,...)
virtual void appendMessage (const char *fmt,...)
virtual int getErrorCode () const
virtual const char * what () const override throw ()
virtual std::string getFormattedMessage () const
virtual int getSimulationStage () const
virtual eventnumber_t getEventNumber () const
virtual simtime_t getSimtime () const
virtual bool hasContext () const
virtual const char * getContextClassName () const
virtual const char * getContextFullPath () const
virtual int getContextComponentId () const
virtual int getContextComponentKind () const

Additional Inherited Members

Protected Member Functions inherited from cException
void init (const cObject *obj, ErrorCode errorcode, const std::string &msg)

Description

Used internally when deleting an activity() simple module.

Then, the coroutine running activity() is "asked" to throw a cStackCleanupException to achieve stack unwinding, a side effect of exceptions, in order to properly clean up activity()'s local variables.

Constructor & Destructor Documentation

◆ cStackCleanupException() [1/2]

Default ctor.

Referenced by cStackCleanupException(), and dup().

◆ cStackCleanupException() [2/2]

Copy constructor. We unfortunately need to copy exception objects when handing them back from an activity() method.

References cStackCleanupException().

Member Function Documentation

◆ dup()

virtual cStackCleanupException * dup ( ) const
inlineoverridevirtual

Creates and returns an exact copy of this object. We unfortunately need to copy exception objects when handing them back from an activity() method.

Reimplemented from cException.

References cStackCleanupException().

◆ isError()

virtual bool isError ( ) const
inlineoverridevirtual

This exception type does not represent an error condition.

Reimplemented from cException.