makVre::DtVortexConfigurationBaseElement Class Reference

Detailed Description

Provides common functionality for storing and managing Vortex configuration parameters regardless of their data type.

#include <vortexConfiguration.h>

Inheritance diagram for makVre::DtVortexConfigurationBaseElement:

Public Member Functions
	DtVortexConfigurationBaseElement (VxData::FieldBase *field)
virtual	~DtVortexConfigurationBaseElement ()
virtual VxData::FieldBase *	getField ()
virtual void	setField (VxData::FieldBase *fb)
virtual const Vx::VxID &	vxId ()
virtual void	setVxId (const Vx::VxID &vortexId)
virtual bool	updateConfigValue ()=0

Protected Attributes
VxData::FieldBase *	myVortexField
Vx::VxID	myVortexId

Constructor & Destructor Documentation

DtVortexConfigurationBaseElement()

makVre::DtVortexConfigurationBaseElement::DtVortexConfigurationBaseElement ( VxData::FieldBase * field )

explicit

Constructor with field initialization.

Creates a configuration element associated with the specified Vortex field.

Parameters

field

Pointer to the Vortex field to be configured

~DtVortexConfigurationBaseElement()

virtual makVre::DtVortexConfigurationBaseElement::~DtVortexConfigurationBaseElement ( )

virtual

Virtual destructor.

Allows for proper cleanup of derived classes.

Member Function Documentation

getField()

virtual VxData::FieldBase * makVre::DtVortexConfigurationBaseElement::getField ( )

virtual

Gets the associated Vortex field.

Returns

Pointer to the Vortex field being configured

setField()

virtual void makVre::DtVortexConfigurationBaseElement::setField ( VxData::FieldBase * fb )

virtual

Sets the associated Vortex field.

Parameters

fb	Pointer to the Vortex field to be configured

vxId()

virtual const Vx::VxID & makVre::DtVortexConfigurationBaseElement::vxId ( )

virtual

Gets the Vortex identifier.

Returns

The Vortex ID of the configured field

setVxId()

virtual void makVre::DtVortexConfigurationBaseElement::setVxId ( const Vx::VxID & vortexId )

virtual

Sets the Vortex identifier.

Parameters

vortexId

The Vortex ID to associate with this element

updateConfigValue()

virtual bool makVre::DtVortexConfigurationBaseElement::updateConfigValue ( )

pure virtual

Updates the configuration value in Vortex.

Pure virtual function that must be implemented by derived classes to update the Vortex field with the stored value.

Returns

True if the update succeeded, false otherwise

Implemented in makVre::DtVortexConfigurationElement< T >.

Member Data Documentation

myVortexField

VxData::FieldBase* makVre::DtVortexConfigurationBaseElement::myVortexField

protected

Pointer to the Vortex field being configured.

myVortexId

Vx::VxID makVre::DtVortexConfigurationBaseElement::myVortexId

protected

Vortex ID of the configured field.

---

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

• include/vrfExtensions/vreVrfVortex/vortexConfiguration.h