makVre::DtVortexInterfaceDescriptor Class Reference

Detailed Description

DtVortexInterfaceDescriptor manages interfaces for the Vortex physics engine, defining input and output parameters through separate element lists. It provides methods to set and retrieve the interface name and parameter lists, and supports serialization to and from XML.

#include <vortexInterfaceDescriptor.h>

Inheritance diagram for makVre::DtVortexInterfaceDescriptor:

Public Member Functions
	DtVortexInterfaceDescriptor ()
	DtVortexInterfaceDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtVortexInterfaceDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtVortexInterfaceDescriptor (const DtVortexInterfaceDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
DtVortexInterfaceDescriptor &	operator= (const DtVortexInterfaceDescriptor &orig)
virtual	~DtVortexInterfaceDescriptor () override
virtual void	setVortexInterfaceName (const std::string &interfaceName)
virtual std::string	vortexInterfaceName () const
virtual void	setInputList (const DtVortexInterfaceElementList &list)
virtual const DtVortexInterfaceElementList &	inputList () const
virtual void	setOutputList (const DtVortexInterfaceElementList &list)
virtual const DtVortexInterfaceElementList &	outputList () const
virtual const char *	readerWriterType () const override
virtual const char *	xmlType () const override

Static Public Member Functions
static const char *	theXmlType ()

Protected Attributes
DtRwString	myInterfaceName
DtVortexInterfaceElementList	myInputList
DtVortexInterfaceElementList	myOutputList

Constructor & Destructor Documentation

DtVortexInterfaceDescriptor() [1/4]

makVre::DtVortexInterfaceDescriptor::DtVortexInterfaceDescriptor

(

)

Default constructor.

Creates an empty interface descriptor

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

DtVortexInterfaceDescriptor() [2/4]

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

Constructor with interface name and registry.

Parameters

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

DtVortexInterfaceDescriptor() [3/4]

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

Constructor with symbol interface name and registry.

Parameters

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

DtVortexInterfaceDescriptor() [4/4]

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

Copy constructor.

Parameters

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

References DtVortexInterfaceDescriptor().

~DtVortexInterfaceDescriptor()

virtual makVre::DtVortexInterfaceDescriptor::~DtVortexInterfaceDescriptor ( )

overridevirtual

Virtual destructor.

Member Function Documentation

operator=()

DtVortexInterfaceDescriptor & makVre::DtVortexInterfaceDescriptor::operator=

(

const DtVortexInterfaceDescriptor &

orig

)

Assignment operator.

Parameters

orig	Original interface descriptor to copy from

Returns

Reference to this interface descriptor after assignment

References DtVortexInterfaceDescriptor().

setVortexInterfaceName()

virtual void makVre::DtVortexInterfaceDescriptor::setVortexInterfaceName ( const std::string & interfaceName )

virtual

Sets the name of the Vortex interface.

Parameters

interfaceName

The name to set for this interface

vortexInterfaceName()

virtual std::string makVre::DtVortexInterfaceDescriptor::vortexInterfaceName ( ) const

virtual

Gets the name of the Vortex interface.

Returns

The name of this interface

setInputList()

virtual void makVre::DtVortexInterfaceDescriptor::setInputList ( const DtVortexInterfaceElementList & list )

virtual

Sets the list of input interface elements.

Parameters

list	The list of input interface elements to set

inputList()

virtual const DtVortexInterfaceElementList & makVre::DtVortexInterfaceDescriptor::inputList ( ) const

virtual

Gets the list of input interface elements.

Returns

Constant reference to the list of input interface elements

setOutputList()

virtual void makVre::DtVortexInterfaceDescriptor::setOutputList ( const DtVortexInterfaceElementList & list )

virtual

Sets the list of output interface elements.

Parameters

list	The list of output interface elements to set

outputList()

virtual const DtVortexInterfaceElementList & makVre::DtVortexInterfaceDescriptor::outputList ( ) const

virtual

Gets the list of output interface elements.

Returns

Constant reference to the list of output interface elements

readerWriterType()

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

overridevirtual

Gets the type identifier for reader/writer operations.

Returns

Type identifier string

theXmlType()

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

inlineoverridevirtual

Gets the XML type identifier for this instance.

Returns

XML type identifier string

References theXmlType().

Member Data Documentation

myInterfaceName

DtRwString makVre::DtVortexInterfaceDescriptor::myInterfaceName

protected

The name of this Vortex interface.

myInputList

DtVortexInterfaceElementList makVre::DtVortexInterfaceDescriptor::myInputList

protected

List of input interface elements for this interface.

myOutputList

DtVortexInterfaceElementList makVre::DtVortexInterfaceDescriptor::myOutputList

protected

List of output interface elements for this interface.

---

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

• include/vrfExtensions/vreVrfVortexObjparam/vortexInterfaceDescriptor.h