openfluid::fluidx::WareDescriptor Class Reference

#include <fluidx/WareDescriptor.hpp>

Inheritance diagram for openfluid::fluidx::WareDescriptor:

Public Types
enum	WareType { NoWareType, PluggedSimulator, Generator, PluggedObserver }

Public Member Functions
	WareDescriptor ()
virtual	~WareDescriptor ()
void	setParameter (const openfluid::ware::WareParamKey_t &Key, const openfluid::ware::WareParamValue_t &Value)
void	setParameters (const openfluid::ware::WareParams_t &Params)
openfluid::ware::WareParams_t	getParameters () const
openfluid::ware::WareParams_t &	parameters ()
bool	isType (WareType MIType) const
WareType	getType () const
void	eraseParameter (const openfluid::ware::WareParamKey_t &Key)
void	clearParameters ()
bool	hasParameter (std::string ParameterKey)
void	setEnabled (bool Enabled)
bool	isEnabled () const

Protected Attributes
WareType	m_WareType
openfluid::ware::WareParams_t	m_Params
bool	m_Enabled

Member Enumeration Documentation

enum openfluid::fluidx::WareDescriptor::WareType

Enumerator
NoWareType
PluggedSimulator
Generator
PluggedObserver

Constructor & Destructor Documentation

openfluid::fluidx::WareDescriptor::WareDescriptor

(

)

virtual openfluid::fluidx::WareDescriptor::~WareDescriptor ( )

virtual

Member Function Documentation

void openfluid::fluidx::WareDescriptor::clearParameters

(

)

void openfluid::fluidx::WareDescriptor::eraseParameter

(

const openfluid::ware::WareParamKey_t &

Key

)

openfluid::ware::WareParams_t openfluid::fluidx::WareDescriptor::getParameters

(

)

const

WareType openfluid::fluidx::WareDescriptor::getType

(

)

const

bool openfluid::fluidx::WareDescriptor::hasParameter

(

std::string

ParameterKey

)

bool openfluid::fluidx::WareDescriptor::isEnabled

(

)

const

bool openfluid::fluidx::WareDescriptor::isType

(

WareType

MIType

)

const

openfluid::ware::WareParams_t& openfluid::fluidx::WareDescriptor::parameters

(

)

void openfluid::fluidx::WareDescriptor::setEnabled

(

bool

Enabled

)

void openfluid::fluidx::WareDescriptor::setParameter	(	const openfluid::ware::WareParamKey_t &	Key,
		const openfluid::ware::WareParamValue_t &	Value
	)

void openfluid::fluidx::WareDescriptor::setParameters

(

const openfluid::ware::WareParams_t &

Params

)

Member Data Documentation

bool openfluid::fluidx::WareDescriptor::m_Enabled

protected

openfluid::ware::WareParams_t openfluid::fluidx::WareDescriptor::m_Params

protected

WareType openfluid::fluidx::WareDescriptor::m_WareType

protected

---

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

• fluidx/WareDescriptor.hpp