makVre::DtVortexConfigurationElementDescriptor Class Reference

Detailed Description

DtVortexConfigurationElementDescriptor represents a single parameter in the Vortex physics configuration. It supports multiple data types (boolean, vector, integer, real, string, and filename) and stores the parameter name along with its value. This class provides type-specific accessors and modifiers and supports serialization to and from XML.

#include <vortexConfigurationElementDescriptor.h>

Inheritance diagram for makVre::DtVortexConfigurationElementDescriptor:

Public Member Functions
	DtVortexConfigurationElementDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtVortexConfigurationElementDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtVortexConfigurationElementDescriptor (const DtVortexConfigurationElementDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtVortexConfigurationElementDescriptor &	operator= (const DtVortexConfigurationElementDescriptor &orig)
virtual	~DtVortexConfigurationElementDescriptor () override
virtual void	setParameterName (const DtString &name)
virtual const DtString &	getParameterName () const
virtual bool	parameterNameSpecified () const
virtual bool	getBooleanValue () const
virtual void	setBooleanValue (bool val, bool isSpecified=true)
virtual bool	booleanValueSpecified () const
virtual DtVector	getVectorValue () const
virtual void	setVectorValue (const DtVector &loc, bool isSpecified=true)
virtual bool	vectorValueSpecified () const
virtual int	getIntValue () const
virtual void	setIntValue (const int loc, bool isSpecified=true)
virtual bool	intValueSpecified () const
virtual double	getRealValue () const
virtual void	setRealValue (double val, bool isSpecified=true)
virtual bool	realValueSpecified () const
virtual const DtString &	getStringValue () const
virtual void	setStringValue (const DtString &str, bool isSpecified=true)
virtual bool	stringValueSpecified () const
virtual const DtString &	getFilenameValue () const
virtual void	setFilenameValue (const DtString &filename, bool isSpecified=true)
virtual bool	filenameValueSpecified () const
virtual const char *	readerWriterType () const override
virtual const char *	xmlType () const override

Static Public Member Functions
static const char *	theXmlType ()

Protected Member Functions
	DtVortexConfigurationElementDescriptor ()

Protected Attributes
DtRwString	myParameterName
DtRwBoolean	myBoolValue
DtRwVector	myVectorValue
DtRwInt	myIntValue
DtRwReal	myRealValue
DtRwString	myStringValue
DtRwString	myFilenameValue

Constructor & Destructor Documentation

DtVortexConfigurationElementDescriptor() [1/4]

makVre::DtVortexConfigurationElementDescriptor::DtVortexConfigurationElementDescriptor ( )

protected

Protected default constructor.

Creates an empty configuration element descriptor

Referenced by DtVortexConfigurationElementDescriptor(), and operator=().

DtVortexConfigurationElementDescriptor() [2/4]

makVre::DtVortexConfigurationElementDescriptor::DtVortexConfigurationElementDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0 )

Constructor with element name and registry.

Parameters

name	Name of the configuration element
parentRegistry	Optional parent registry for reader/writer operations

DtVortexConfigurationElementDescriptor() [3/4]

makVre::DtVortexConfigurationElementDescriptor::DtVortexConfigurationElementDescriptor	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0 )

Constructor with symbol element name and registry.

Parameters

name	Symbol string name of the configuration element
parentRegistry	Optional parent registry for reader/writer operations

DtVortexConfigurationElementDescriptor() [4/4]

makVre::DtVortexConfigurationElementDescriptor::DtVortexConfigurationElementDescriptor	(	const DtVortexConfigurationElementDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0 )

Copy constructor.

Parameters

orig	Original configuration element descriptor to copy from
parentRegistry	Optional parent registry for reader/writer operations

References DtVortexConfigurationElementDescriptor().

~DtVortexConfigurationElementDescriptor()

virtual makVre::DtVortexConfigurationElementDescriptor::~DtVortexConfigurationElementDescriptor ( )

overridevirtual

Virtual destructor.

Member Function Documentation

operator=()

DtVortexConfigurationElementDescriptor & makVre::DtVortexConfigurationElementDescriptor::operator=

(

const DtVortexConfigurationElementDescriptor &

orig

)

Assignment operator.

Parameters

orig	Original configuration element descriptor to copy from

Returns

Reference to this configuration element descriptor after assignment

References DtVortexConfigurationElementDescriptor().

setParameterName()

virtual void makVre::DtVortexConfigurationElementDescriptor::setParameterName ( const DtString & name )

virtual

Sets the parameter name.

Parameters

name	The name to set for this parameter

getParameterName()

virtual const DtString & makVre::DtVortexConfigurationElementDescriptor::getParameterName ( ) const

virtual

Gets the parameter name.

Returns

The name of this parameter

parameterNameSpecified()

virtual bool makVre::DtVortexConfigurationElementDescriptor::parameterNameSpecified ( ) const

virtual

Checks if a parameter name has been specified.

Returns

True if the parameter name has been specified, false otherwise

getBooleanValue()

virtual bool makVre::DtVortexConfigurationElementDescriptor::getBooleanValue ( ) const

virtual

Gets the boolean value.

Returns

The boolean value of this parameter

setBooleanValue()

virtual void makVre::DtVortexConfigurationElementDescriptor::setBooleanValue ( bool val, bool isSpecified = true )

virtual

Sets the boolean value.

Parameters

val	The boolean value to set
isSpecified	Flag indicating if the value is specified

booleanValueSpecified()

virtual bool makVre::DtVortexConfigurationElementDescriptor::booleanValueSpecified ( ) const

virtual

Checks if a boolean value has been specified.

Returns

True if a boolean value has been specified, false otherwise

getVectorValue()

virtual DtVector makVre::DtVortexConfigurationElementDescriptor::getVectorValue ( ) const

virtual

Gets the vector value.

Returns

The vector value of this parameter

setVectorValue()

virtual void makVre::DtVortexConfigurationElementDescriptor::setVectorValue ( const DtVector & loc, bool isSpecified = true )

virtual

Sets the vector value.

Parameters

loc	The vector value to set
isSpecified	Flag indicating if the value is specified

vectorValueSpecified()

virtual bool makVre::DtVortexConfigurationElementDescriptor::vectorValueSpecified ( ) const

virtual

Checks if a vector value has been specified.

Returns

True if a vector value has been specified, false otherwise

getIntValue()

virtual int makVre::DtVortexConfigurationElementDescriptor::getIntValue ( ) const

virtual

Gets the integer value.

Returns

The integer value of this parameter

setIntValue()

virtual void makVre::DtVortexConfigurationElementDescriptor::setIntValue ( const int loc, bool isSpecified = true )

virtual

Sets the integer value.

Parameters

loc	The integer value to set
isSpecified	Flag indicating if the value is specified

intValueSpecified()

virtual bool makVre::DtVortexConfigurationElementDescriptor::intValueSpecified ( ) const

virtual

Checks if an integer value has been specified.

Returns

True if an integer value has been specified, false otherwise

getRealValue()

virtual double makVre::DtVortexConfigurationElementDescriptor::getRealValue ( ) const

virtual

Gets the real (double) value.

Returns

The real value of this parameter

setRealValue()

virtual void makVre::DtVortexConfigurationElementDescriptor::setRealValue ( double val, bool isSpecified = true )

virtual

Sets the real (double) value.

Parameters

val	The real value to set
isSpecified	Flag indicating if the value is specified

realValueSpecified()

virtual bool makVre::DtVortexConfigurationElementDescriptor::realValueSpecified ( ) const

virtual

Checks if a real value has been specified.

Returns

True if a real value has been specified, false otherwise

getStringValue()

virtual const DtString & makVre::DtVortexConfigurationElementDescriptor::getStringValue ( ) const

virtual

Gets the string value.

Returns

The string value of this parameter

setStringValue()

virtual void makVre::DtVortexConfigurationElementDescriptor::setStringValue ( const DtString & str, bool isSpecified = true )

virtual

Sets the string value.

Parameters

str	The string value to set
isSpecified	Flag indicating if the value is specified

stringValueSpecified()

virtual bool makVre::DtVortexConfigurationElementDescriptor::stringValueSpecified ( ) const

virtual

Checks if a string value has been specified.

Returns

True if a string value has been specified, false otherwise

getFilenameValue()

virtual const DtString & makVre::DtVortexConfigurationElementDescriptor::getFilenameValue ( ) const

virtual

Gets the filename value.

Returns

The filename value of this parameter

setFilenameValue()

virtual void makVre::DtVortexConfigurationElementDescriptor::setFilenameValue ( const DtString & filename, bool isSpecified = true )

virtual

Sets the filename value.

Parameters

filename	The filename value to set
isSpecified	Flag indicating if the value is specified

filenameValueSpecified()

virtual bool makVre::DtVortexConfigurationElementDescriptor::filenameValueSpecified ( ) const

virtual

Checks if a filename value has been specified.

Returns

True if a filename value has been specified, false otherwise

readerWriterType()

virtual const char * makVre::DtVortexConfigurationElementDescriptor::readerWriterType ( ) const

overridevirtual

Gets the type identifier for reader/writer operations.

Returns

Type identifier string

theXmlType()

static const char * makVre::DtVortexConfigurationElementDescriptor::theXmlType ( )

static

Gets the XML type identifier for serialization.

Returns

XML type identifier string used when archiving to an XML stream

Referenced by xmlType().

xmlType()

virtual const char * makVre::DtVortexConfigurationElementDescriptor::xmlType ( ) const

inlineoverridevirtual

Gets the XML type identifier for this instance.

Returns

XML type identifier string

References theXmlType().

Member Data Documentation

myParameterName

DtRwString makVre::DtVortexConfigurationElementDescriptor::myParameterName

protected

The name of this parameter.

myBoolValue

DtRwBoolean makVre::DtVortexConfigurationElementDescriptor::myBoolValue

protected

The boolean value of this parameter.

myVectorValue

DtRwVector makVre::DtVortexConfigurationElementDescriptor::myVectorValue

protected

The vector value of this parameter.

myIntValue

DtRwInt makVre::DtVortexConfigurationElementDescriptor::myIntValue

protected

The integer value of this parameter.

myRealValue

DtRwReal makVre::DtVortexConfigurationElementDescriptor::myRealValue

protected

The real (double) value of this parameter.

myStringValue

DtRwString makVre::DtVortexConfigurationElementDescriptor::myStringValue

protected

The string value of this parameter.

myFilenameValue

DtRwString makVre::DtVortexConfigurationElementDescriptor::myFilenameValue

protected

The filename value of this parameter.

---

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

• include/vrfExtensions/vreVrfVortexObjparam/vortexConfigurationElementDescriptor.h