VR-Engage  2.2
Loading...
Searching...
No Matches
makVre::DtVortexConfigurationElement< T > Class Template Reference

Detailed Description

template<typename T>
class makVre::DtVortexConfigurationElement< T >

Extends the base configuration element with type-specific storage and update logic. Specializations exist for certain types that require custom handling (e.g., DtVector).

#include <vortexConfiguration.h>

Inheritance diagram for makVre::DtVortexConfigurationElement< T >:
[legend]

Public Member Functions

 DtVortexConfigurationElement (VxData::FieldBase *field)
 
virtual ~DtVortexConfigurationElement () override
 
virtual bool updateConfigValue () override
 
value ()
 
void setValue (const T &val)
 
- Public Member Functions inherited from makVre::DtVortexConfigurationBaseElement
 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)
 

Protected Attributes

myValue
 
- Protected Attributes inherited from makVre::DtVortexConfigurationBaseElement
VxData::FieldBase * myVortexField
 
Vx::VxID myVortexId
 

Constructor & Destructor Documentation

◆ DtVortexConfigurationElement()

template<typename T>
makVre::DtVortexConfigurationElement< T >::DtVortexConfigurationElement ( VxData::FieldBase * field)
explicit

Constructor with field initialization.

Creates a typed configuration element associated with the specified Vortex field.

Parameters
fieldPointer to the Vortex field to be configured

◆ ~DtVortexConfigurationElement()

template<typename T>
virtual makVre::DtVortexConfigurationElement< T >::~DtVortexConfigurationElement ( )
overridevirtual

Virtual destructor.

Allows for proper cleanup of derived classes.

Member Function Documentation

◆ updateConfigValue()

template<typename T>
virtual bool makVre::DtVortexConfigurationElement< T >::updateConfigValue ( )
overridevirtual

Updates the Vortex field with the stored value.

Implements the pure virtual function from the base class to set the value in the Vortex field.

Returns
True if the update succeeded, false otherwise

Implements makVre::DtVortexConfigurationBaseElement.

◆ value()

template<typename T>
T makVre::DtVortexConfigurationElement< T >::value ( )
inline

Gets the current configuration value.

Returns
The current value stored in this configuration element

References myValue.

◆ setValue()

template<typename T>
void makVre::DtVortexConfigurationElement< T >::setValue ( const T & val)

Sets the configuration value.

Parameters
valThe value to store in this configuration element

Member Data Documentation

◆ myValue

template<typename T>
T makVre::DtVortexConfigurationElement< T >::myValue
protected

The typed value stored in this configuration element.

Referenced by value().


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