cValueHolder Class Reference

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

Public Member Functions

Constructors, destructor, assignment.
 cValueHolder (const cValueHolder &other)
 cValueHolder (const char *name=nullptr)
 cValueHolder (const char *name, const cValue &value)
virtual ~cValueHolder ()
cValueHolderoperator= (const cValueHolder &other)
Redefined cObject member functions
virtual cValueHolderdup () const override
virtual std::string str () const override
virtual void forEachChild (cVisitor *v) override
Container functions.
const cValueget () const
void set (const cValue &v)
Public Member Functions inherited from cValueContainer
 cValueContainer (const char *name=nullptr)
Public Member Functions inherited from cOwnedObject
 cOwnedObject ()
 cOwnedObject (const char *name, bool namepooling=true)
 cOwnedObject (const cOwnedObject &obj)
virtual ~cOwnedObject ()
cOwnedObjectoperator= (const cOwnedObject &o)
virtual cObjectgetOwner () const override
virtual bool isOwnedObject () const override
Public Member Functions inherited from cNamedObject
 cNamedObject ()
 cNamedObject (const char *name, bool namepooling=true)
 cNamedObject (const cNamedObject &obj)
virtual ~cNamedObject ()
cNamedObjectoperator= (const cNamedObject &o)
virtual void setName (const char *s)
virtual const char * getName () const override
virtual void setNamePooling (bool b)
virtual bool getNamePooling ()
Public Member Functions inherited from cObject
 cObject ()
 cObject (const cObject &other)=default
virtual ~cObject ()
virtual const char * getClassName () const
bool isName (const char *s) const
virtual const char * getFullName () const
virtual std::string getFullPath () const
virtual std::string getClassAndFullName () const
virtual std::string getClassAndFullPath () const
const cObjectgetThisPtr () const
virtual std::ostream & printOn (std::ostream &os) const
virtual bool isSoftOwner () const
cObjectfindObject (const char *name, bool deep=true)
virtual cClassDescriptorgetDescriptor () const
void copyNotSupported () const

Additional Inherited Members

Static Public Member Functions inherited from cOwnedObject
static long getTotalObjectCount ()
static long getLiveObjectCount ()
static void resetObjectCounters ()
static cSoftOwnergetOwningContext ()
Protected Member Functions inherited from cObject
virtual void take (cOwnedObject *obj)
virtual void drop (cOwnedObject *obj)
void dropAndDelete (cOwnedObject *obj)

Description

cOwnedObject-based container/wrapper to hold a single cValue.

The added value is ownership handling of object values (cObject* pointers) contained in cValue objects. Guidelines: owned objects are those that subclass from cOwnedObject and getOwner() returns this object, and all cObjects that are non-cOwnedObject.

Constructor & Destructor Documentation

◆ cValueHolder() [1/3]

cValueHolder ( const cValueHolder & other)
inline

Copy constructor. Contained objects will be duplicated so that the new cValueHolder will have its own copy of them.

Note that this behavior is different from most other container classes in the simulation library like cQueue, which only duplicate the objects they own, and leave externally owned objects alone.

References cValueContainer::cValueContainer(), and cValueHolder().

Referenced by cValueHolder(), dup(), and operator=().

◆ cValueHolder() [2/3]

cValueHolder ( const char * name = nullptr)
inlineexplicit

Constructor.

References cValueContainer::cValueContainer().

◆ cValueHolder() [3/3]

cValueHolder ( const char * name,
const cValue & value )
inlineexplicit

Constructor.

References cValueContainer::cValueContainer().

◆ ~cValueHolder()

virtual ~cValueHolder ( )
inlinevirtual

Destructor. The contained objects that were owned by the container will be deleted.

Member Function Documentation

◆ operator=()

cValueHolder & operator= ( const cValueHolder & other)

Assignment operator. The name member is not copied; see cNamedObject::operator=() for details. Contained objects that are owned by cValueHolder will be duplicated so that the new cValueHolder will have its own copy of them.

References cValueHolder().

◆ dup()

virtual cValueHolder * dup ( ) const
inlineoverridevirtual

Creates and returns an exact copy of this object. Contained objects will be duplicated so that the new cValueHolder will have its own copy of them.

Note that this behavior is different from most other container classes in the simulation library like cQueue, which only duplicate the objects they own, and leave externally owned objects alone.

Reimplemented from cObject.

References cValueHolder().

◆ str()

virtual std::string str ( ) const
inlineoverridevirtual

Produces a one-line description of the object's contents. See cObject for more details.

Reimplemented from cObject.

◆ forEachChild()

virtual void forEachChild ( cVisitor * v)
overridevirtual

Calls v->visit(this) for each contained object. See cObject for more details.

Reimplemented from cObject.

◆ get()

const cValue & get ( ) const
inline

Returns the stored value.

◆ set()

void set ( const cValue & v)
inline

Replaces the stored value.