Internal classes

The classes described here are used internally by the simulation kernel. More...

Classes
class	cBoolParImpl
	A cParImpl subclass that stores a module/channel parameter of the type bool. More...
class	cClassDescriptor
	Abstract base class for structure description classes, used mainly with message subclassing. More...
class	cComponentType
	Common base class for cModuleType and cChannelType. More...
class	cModuleType
	Abstract class for creating a module of a specific type. More...
class	cChannelType
	Abstract base class for creating a channel of a given type. More...
class	cConfigOption
	Describes a configuration option. More...
class	cCoroutine
	Low-level coroutine library. More...
class	cDefaultList
	Internal class, used as a base class for modules and channels. More...
class	cDoubleParImpl
	A cParImpl subclass that stores a module/channel parameter of the type double. More...
class	cEnum
	Provides string representation for enums. More...
class	cTerminationException
	Thrown when the simulation is completed. More...
class	cRuntimeError
	Thrown when the simulation kernel or other components detect a runtime error. More...
class	cDeleteModuleException
	This exception is only thrown from cSimpleModule::deleteModule() if the current module is to be deleted, in order to exit that module immediately. More...
class	cStackCleanupException
	Used internally when deleting an activity() simple module. More...
class	cLongParImpl
	A cParImpl subclass that stores a module/channel parameter of the type long. More...
class	cMessageHeap
	Stores the future event set. More...
class	cNEDFunction
	Registration class for extending NED with new functions. More...
class	cNEDMathFunction
	Registration class for extending NED with new functions. More...
class	cObjectFactory
	The class behind the createOne() function and the Register_Class() macro. More...
class	cParImpl
	Internal class that stores parameter values. More...
class	cProperties
	Stores properties. More...
class	cProperty
	Stores a property with its value. More...
class	cGlobalRegistrationList
	Singleton class, used for registration lists. More...
class	cResultFilterDescriptor
	Registers a cResultFilter. More...
class	cResultRecorderDescriptor
	Registers a cResultRecorder. More...
class	cScheduler
	Abstract class to encapsulate event scheduling. More...
class	cSequentialScheduler
	Event scheduler for sequential simulation. More...
class	cRealTimeScheduler
	Real-time scheduler class. More...
class	cSimulation
	Simulation manager class. More...
class	cStringParImpl
	A cParImpl subclass that stores a module/channel parameter of the type string. More...
class	cWatchBase
	Utility class to make primitive types and non-cOwnedObject objects inspectable in Tkenv. More...
class	cGenericReadonlyWatch< T >
	Template Watch class, for any type that supports operator<<. More...
class	cGenericAssignableWatch< T >
	Template Watch class, for any type that supports operator<<, and operator>> for assignment. More...
class	cWatch_bool
	Watch class, specifically for bool. More...
class	cWatch_char
	Watch class, specifically for char. More...
class	cWatch_uchar
	Watch class, specifically for unsigned char. More...
class	cWatch_stdstring
	Watch class, specifically for std::string. More...
class	cWatch_cObject
	Watch class, specifically for objects subclassed from cObject. More...
class	cWatch_cObjectPtr
	Watch class, specifically for pointers to objects subclassed from cObject. More...
class	cXMLParImpl
	A cParImpl subclass that stores a module/channel parameter of type XML. More...
class	cErrorMessages
	Provides error messages for error codes. More...
class	CodeFragments
	Supporting class for the EXECUTE_ON_STARTUP and EXECUTE_ON_SHUTDOWN macros. More...
class	opp_string
	Lightweight string class, used internally in some parts of OMNeT++. More...
class	opp_string_vector
	Lightweight string vector, used internally in some parts of OMNeT++. More...
class	opp_string_map
	Lightweight string vector, used internally in some parts of OMNeT++. More...
class	cContextSwitcher
	The constructor switches the context to the given component, and the destructor restores the original context. More...
class	cMethodCallContextSwitcher
	Internal class. More...
class	cContextTypeSwitcher
	The constructor switches the context type, and the destructor restores the original context type. More...

---

Detailed Description

The classes described here are used internally by the simulation kernel.

They are normally of very little interest to the simulation programmer. Note that although these internal classes do have a documented API, they may change more often than other classes, simply because they are not used in simulation models and thus backwards compatibility is less important.

Classes associated with simulation execution:

• cSimulation has a single instance. It stores the network and manages simulation runs.
• cScheduler is a base class for schedulers (see in Extension interfaces as well)
• cMessageHeap is used internally by cSimulation as FES (Future Event Set)
• cCoroutine is the engine behind activity()-based simple modules
• cWatch is the class behind the WATCH() and LWATCH() macros

Registration classes are listed below. They play the role of a central registry in OMNeT++ -- each instance holds some specific piece of (static) information or serves as a factory object for other objects.

Registration objects play an important role at network build time (they store information about available module, channel, etc. types and can instantiate them), and for inspectors in graphical user interfaces like Tkenv.

• cModuleType can instantiate a module type
• cChannelType can instantiate a channel type
• cNEDMathFunction stores a pointer to a math function accessible from NED
• cObjectFactory can instantiate a class, given the class name as string
• cClassDescriptor provides a generic way to access data in a struct or class (somewhat analogous to Java reflection)
• cEnum maps enum values to their string representations and vica versa

Some other classes, closely related to the above ones are not listed here explicitly, but you can find them via 'See also' links from their main classes.