makVre::DtVortexConfigurationDescriptor Class Reference

Detailed Description

DtVortexConfigurationDescriptor manages a collection of configuration parameters for the Vortex physics engine. It stores a name for the configuration and a list of configuration elements that define specific physics parameters. This class supports serialization to and from XML and provides debugging options for parameters.

#include <vortexConfigurationDescriptor.h>

Inheritance diagram for makVre::DtVortexConfigurationDescriptor:

Public Member Functions
	DtVortexConfigurationDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtVortexConfigurationDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtVortexConfigurationDescriptor (const DtVortexConfigurationDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtVortexConfigurationDescriptor &	operator= (const DtVortexConfigurationDescriptor &orig)
virtual	~DtVortexConfigurationDescriptor () override
virtual void	setVortexConfigurationName (const std::string &ConfigurationName)
virtual std::string	vortexConfigurationName () const
virtual void	setConfigurationList (const DtVortexConfigurationElementList &list)
virtual const DtVortexConfigurationElementList &	configurationList () const
virtual void	setDebugParameters (const bool enable)
virtual const bool	debugParameters () const
virtual const char *	readerWriterType () const override
virtual const char *	xmlType () const override

Static Public Member Functions
static const char *	theXmlType ()

Protected Member Functions
	DtVortexConfigurationDescriptor ()

Protected Attributes
DtRwString	myConfigurationName
DtRwBoolean	myDebugParameters
DtVortexConfigurationElementList	myConfigList

Constructor & Destructor Documentation

DtVortexConfigurationDescriptor() [1/4]

makVre::DtVortexConfigurationDescriptor::DtVortexConfigurationDescriptor ( )

protected

Protected default constructor.

Creates an empty configuration descriptor

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

DtVortexConfigurationDescriptor() [2/4]

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

Constructor with configuration name and registry.

Parameters

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

DtVortexConfigurationDescriptor() [3/4]

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

Constructor with symbol configuration name and registry.

Parameters

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

DtVortexConfigurationDescriptor() [4/4]

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

Copy constructor.

Parameters

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

References DtVortexConfigurationDescriptor().

~DtVortexConfigurationDescriptor()

virtual makVre::DtVortexConfigurationDescriptor::~DtVortexConfigurationDescriptor ( )

overridevirtual

Virtual destructor.

Member Function Documentation

operator=()

DtVortexConfigurationDescriptor & makVre::DtVortexConfigurationDescriptor::operator=

(

const DtVortexConfigurationDescriptor &

orig

)

Assignment operator.

Parameters

orig	Original configuration descriptor to copy from

Returns

Reference to this configuration descriptor after assignment

References DtVortexConfigurationDescriptor().

setVortexConfigurationName()

virtual void makVre::DtVortexConfigurationDescriptor::setVortexConfigurationName ( const std::string & ConfigurationName )

virtual

Sets the name of the Vortex configuration.

Parameters

ConfigurationName

The name to set for this configuration

vortexConfigurationName()

virtual std::string makVre::DtVortexConfigurationDescriptor::vortexConfigurationName ( ) const

virtual

Gets the name of the Vortex configuration.

Returns

The name of this configuration

setConfigurationList()

virtual void makVre::DtVortexConfigurationDescriptor::setConfigurationList ( const DtVortexConfigurationElementList & list )

virtual

Sets the list of configuration elements.

Parameters

list	The list of configuration elements to set

configurationList()

virtual const DtVortexConfigurationElementList & makVre::DtVortexConfigurationDescriptor::configurationList ( ) const

virtual

Gets the list of configuration elements.

Returns

Constant reference to the list of configuration elements

setDebugParameters()

virtual void makVre::DtVortexConfigurationDescriptor::setDebugParameters ( const bool enable )

virtual

Enables or disables debug mode for parameters.

Parameters

enable

True to enable debug mode, false to disable

debugParameters()

virtual const bool makVre::DtVortexConfigurationDescriptor::debugParameters ( ) const

virtual

Checks if debug mode is enabled for parameters.

Returns

True if debug mode is enabled, false otherwise

readerWriterType()

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

overridevirtual

Gets the type identifier for reader/writer operations.

Returns

Type identifier string

theXmlType()

static const char * makVre::DtVortexConfigurationDescriptor::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::DtVortexConfigurationDescriptor::xmlType ( ) const

inlineoverridevirtual

Gets the XML type identifier for this instance.

Returns

XML type identifier string

References theXmlType().

Member Data Documentation

myConfigurationName

DtRwString makVre::DtVortexConfigurationDescriptor::myConfigurationName

protected

The name of this Vortex configuration.

myDebugParameters

DtRwBoolean makVre::DtVortexConfigurationDescriptor::myDebugParameters

protected

Flag indicating if debug mode is enabled for parameters.

myConfigList

DtVortexConfigurationElementList makVre::DtVortexConfigurationDescriptor::myConfigList

protected

List of configuration elements defining specific physics parameters.

---

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

• include/vrfExtensions/vreVrfVortexObjparam/vortexConfigurationDescriptor.h