DtVortexInterfaceBaseElement Class Reference

Detailed Description

Provides a common interface for all Vortex interface elements, allowing for type-agnostic handling of different port types.

#include <vortexInterface.h>

Inheritance diagram for DtVortexInterfaceBaseElement:

Public Member Functions
	DtVortexInterfaceBaseElement ()
virtual	~DtVortexInterfaceBaseElement ()
virtual void	update ()=0
virtual std::string	portName ()=0
virtual std::string	getFieldName ()=0
virtual void	setField (VxData::FieldBase *field)=0

Constructor & Destructor Documentation

DtVortexInterfaceBaseElement()

DtVortexInterfaceBaseElement::DtVortexInterfaceBaseElement ( )

inline

Default constructor.

~DtVortexInterfaceBaseElement()

virtual DtVortexInterfaceBaseElement::~DtVortexInterfaceBaseElement ( )

inlinevirtual

Virtual destructor.

Ensures proper cleanup of derived classes.

Member Function Documentation

update()

virtual void DtVortexInterfaceBaseElement::update ( )

pure virtual

Updates the interface element.

Pure virtual function that must be implemented by derived classes to handle data transfer between ports and Vortex fields.

Implemented in DtVortexInterfaceElement< T >.

portName()

virtual std::string DtVortexInterfaceBaseElement::portName ( )

pure virtual

Gets the port name.

Returns

The name of the port

Implemented in DtVortexInterfaceElement< T >.

getFieldName()

virtual std::string DtVortexInterfaceBaseElement::getFieldName ( )

pure virtual

Gets the field name.

Returns

The name of the field

Implemented in DtVortexInterfaceElement< T >.

setField()

virtual void DtVortexInterfaceBaseElement::setField ( VxData::FieldBase * field )

pure virtual

Sets the Vortex field associated with this element.

Parameters

field

Pointer to the Vortex field

Implemented in DtVortexInterfaceElement< T >.

---

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

• include/vrfExtensions/vreVrfVortex/vortexInterface.h