makVre::DtVortexInterfaceElementDescriptor Class Reference

Detailed Description

DtVortexInterfaceElementDescriptor represents a single parameter element within a Vortex interface descriptor. It stores the name of the parameter in the Vortex physics engine and its data type. These elements are used in input and output parameter lists to define the interface for communication with the Vortex physics engine.

#include <vortexInterfaceElementDescriptor.h>

Inheritance diagram for makVre::DtVortexInterfaceElementDescriptor:

Public Member Functions
	DtVortexInterfaceElementDescriptor ()
	DtVortexInterfaceElementDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtVortexInterfaceElementDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtVortexInterfaceElementDescriptor (const DtVortexInterfaceElementDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtVortexInterfaceElementDescriptor &	operator= (const DtVortexInterfaceElementDescriptor &orig)
virtual	~DtVortexInterfaceElementDescriptor () override
virtual void	setVortexName (const DtString &name)
virtual const DtString &	vortexName () const
virtual void	setDataType (const DtString &type)
virtual const DtString &	dataType () const
virtual const char *	readerWriterType () const override
virtual const char *	xmlType () const override

Static Public Member Functions
static const char *	theXmlType ()

Protected Attributes
DtRwString	myVortexName
DtRwString	myDataType

Constructor & Destructor Documentation

DtVortexInterfaceElementDescriptor() [1/4]

makVre::DtVortexInterfaceElementDescriptor::DtVortexInterfaceElementDescriptor

(

)

Default constructor.

Creates an empty interface element descriptor

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

DtVortexInterfaceElementDescriptor() [2/4]

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

Constructor with element name and registry.

Parameters

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

DtVortexInterfaceElementDescriptor() [3/4]

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

Constructor with symbol element name and registry.

Parameters

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

DtVortexInterfaceElementDescriptor() [4/4]

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

Copy constructor.

Parameters

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

References DtVortexInterfaceElementDescriptor().

~DtVortexInterfaceElementDescriptor()

virtual makVre::DtVortexInterfaceElementDescriptor::~DtVortexInterfaceElementDescriptor ( )

overridevirtual

Virtual destructor.

Member Function Documentation

operator=()

DtVortexInterfaceElementDescriptor & makVre::DtVortexInterfaceElementDescriptor::operator=

(

const DtVortexInterfaceElementDescriptor &

orig

)

Assignment operator.

Parameters

orig	Original interface element descriptor to copy from

Returns

Reference to this interface element descriptor after assignment

References DtVortexInterfaceElementDescriptor().

setVortexName()

virtual void makVre::DtVortexInterfaceElementDescriptor::setVortexName ( const DtString & name )

virtual

Sets the Vortex parameter name.

Parameters

name	The parameter name to set in the Vortex physics engine

vortexName()

virtual const DtString & makVre::DtVortexInterfaceElementDescriptor::vortexName ( ) const

virtual

Gets the Vortex parameter name.

Returns

The parameter name in the Vortex physics engine

setDataType()

virtual void makVre::DtVortexInterfaceElementDescriptor::setDataType ( const DtString & type )

virtual

Sets the data type of the parameter.

Parameters

type	The data type to set for this parameter

dataType()

virtual const DtString & makVre::DtVortexInterfaceElementDescriptor::dataType ( ) const

virtual

Gets the data type of the parameter.

Returns

The data type of this parameter

readerWriterType()

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

overridevirtual

Gets the type identifier for reader/writer operations.

Returns

Type identifier string

theXmlType()

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

inlineoverridevirtual

Gets the XML type identifier for this instance.

Returns

XML type identifier string

References theXmlType().

Member Data Documentation

myVortexName

DtRwString makVre::DtVortexInterfaceElementDescriptor::myVortexName

protected

The parameter name in the Vortex physics engine.

myDataType

DtRwString makVre::DtVortexInterfaceElementDescriptor::myDataType

protected

The data type of this parameter.

---

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

• include/vrfExtensions/vreVrfVortexObjparam/vortexInterfaceElementDescriptor.h