Internal Classes¶

API: Internal Classes

API

Classes
class	cBoolParImpl
	A cParImpl subclass that stores a module/channel parameter of the type bool. 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	cContextSwitcher
	The constructor switches the context to the given component, and the destructor restores the original context. More...
class	cMethodCallContextSwitcher
	Internal class. May only be used via the Enter_Method() and Enter_Method_Silent() macros! More...
class	cContextTypeSwitcher
	The constructor switches the context type, and the destructor restores the original context type. More...
class	cDoubleParImpl
	A cParImpl subclass that stores a module/channel parameter of the type double. More...
class	cDynamicDescriptor
	Base class for dynamically created descriptors. Provides defaults for all pure virtual methods of cClassDescriptor (zero fields, empty properties). More...
class	cPrimitiveTypeDescriptor< T >
	Descriptor for primitive/simple types that support operator<< and/or operator>>. Has no fields; provides getValueAsString()/setValueAsString() via stream operators. More...
class	cStdVectorDescriptor< E >
	Descriptor for std::vector<E>. Pretends to have a single "elements[]" array field of type E. More...
class	cStdListDescriptor< E >
	Descriptor for std::list<E>. Pretends to have a single "elements[]" array field of type E. Uses iterator-based access. More...
class	cStdSetDescriptor< E >
	Descriptor for std::set<E>. Pretends to have a single "elements[]" array field of type E. Elements are read-only. More...
class	cStdMapDescriptor< MapType >
	Descriptor for std::map<K,V> and std::unordered_map<K,V>. Pretends to have a single "elements[]" array field of type V. Element values are shown as "key => value" format. More...
class	cStdPairDescriptor< F, S >
	Descriptor for std::pair<F,S>. Has two fields: "first" and "second". More...
class	cDeleteModuleException
	Thrown from deleteModule() when the active activity() module is about to be deleted, in order to exit that module immediately. More...
class	cStackCleanupException
	Used internally when deleting an activity() simple module. More...
class	cIntParImpl
	A cParImpl subclass that stores an integer module/channel parameter. More...
class	cLogEntry
	This class holds various data that is captured when a particular log statement executes. It also contains the text written to the log stream. More...
class	cNedFunction
	Registration class for extending NED with arbitrary new functions. More...
class	cNedMathFunction
	Registration class for extending NED with new mathematical functions. More...
class	cObjectFactory
	The class behind the createOne() function and the Register_Class() macro. More...
class	cObjectParImpl
	A cParImpl subclass that stores a module/channel parameter of type "object". More...
class	cParImpl
	Internal class that stores values for cPar objects. More...
class	cRegistrationList
	Implements a list or table of objects with qualified names. More...
class	cGlobalRegistrationList
	Singleton class, used for registration lists. Instances are supposed to be global variables. More...
class	cResultFilterType
	Registers a cResultFilter. More...
class	cResultRecorderType
	Registers a cResultRecorder. More...
class	cStringParImpl
	A cParImpl subclass that stores a module/channel parameter of the type string. More...
class	cWatchBase
	Helper class to make primitive types and non-cOwnedObject objects inspectable in Qtenv. To be used only via the WATCH, WATCH_PTR, WATCH_OBJ, WATCH_VECTOR etc macros. More...
class	cWatch< T >
	Template Watch class that delegates to the type's cClassDescriptor for string conversion and inspection. More...
class	cPointerWatch< T >
	Template Watch class that delegates to the type's cClassDescriptor for string conversion and inspection. More...
class	cComputedWatch< T >
	Template Watch class for computed values (lambdas, expressions). Stores a std::function that is re-evaluated on each inspector refresh. 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	NeumaierSum
	Compensated summation using the Kahan-Babuška-Neumaier (KBN) algorithm. More...

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.