openfluid::fluidx::GeneratorDescriptor Class Reference

#include <fluidx/GeneratorDescriptor.hpp>

Public Types
enum	GeneratorMethod {   NoGenMethod, Fixed, Random, Interp,   Inject }

Public Member Functions
	GeneratorDescriptor ()
virtual	~GeneratorDescriptor ()
	GeneratorDescriptor (openfluid::core::VariableName_t VarName, openfluid::core::UnitsClass_t UnitsClass, GeneratorMethod GenMethod, unsigned int VarSize=1)
openfluid::core::VariableName_t	getVariableName () const
openfluid::core::UnitsClass_t	getUnitsClass () const
openfluid::core::UnitsClass_t	getUnitClass () const
GeneratorMethod	getGeneratorMethod () const
bool	isVectorVariable () const
bool	isScalarVariable () const
unsigned int	getVariableSize () const
openfluid::core::Value::Type	getVariableType () const
std::string	getGeneratedID () const
Public Member Functions inherited from openfluid::fluidx::ModelItemDescriptor
	ModelItemDescriptor ()
virtual	~ModelItemDescriptor ()
Public Member Functions inherited from openfluid::fluidx::WareDescriptor
	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 (openfluid::ware::WareType MIType) const
openfluid::ware::WareType	getType () const
void	eraseParameter (const openfluid::ware::WareParamKey_t &Key)
void	clearParameters ()
bool	hasParameter (const std::string &ParameterKey) const
void	setEnabled (bool Enabled)
bool	isEnabled () const

Static Public Member Functions
static std::string	getGeneratorName (GeneratorDescriptor::GeneratorMethod GenMethod)

Additional Inherited Members
Protected Attributes inherited from openfluid::fluidx::WareDescriptor
openfluid::ware::WareType	m_WareType
openfluid::ware::WareParams_t	m_Params
bool	m_Enabled

Inheritance diagram for openfluid::fluidx::GeneratorDescriptor:

Collaboration diagram for openfluid::fluidx::GeneratorDescriptor:

Member Enumeration Documentation

GeneratorMethod

enum openfluid::fluidx::GeneratorDescriptor::GeneratorMethod

Enumerator
NoGenMethod
Fixed
Random
Interp
Inject

Constructor & Destructor Documentation

GeneratorDescriptor() [1/2]

openfluid::fluidx::GeneratorDescriptor::GeneratorDescriptor

(

)

~GeneratorDescriptor()

virtual openfluid::fluidx::GeneratorDescriptor::~GeneratorDescriptor ( )

inlinevirtual

GeneratorDescriptor() [2/2]

openfluid::fluidx::GeneratorDescriptor::GeneratorDescriptor	(	openfluid::core::VariableName_t	VarName,
		openfluid::core::UnitsClass_t	UnitsClass,
		GeneratorMethod	GenMethod,
		unsigned int	VarSize = 1
	)

Member Function Documentation

getGeneratedID()

std::string openfluid::fluidx::GeneratorDescriptor::getGeneratedID ( ) const

inline

getGeneratorMethod()

GeneratorMethod openfluid::fluidx::GeneratorDescriptor::getGeneratorMethod

(

)

const

getGeneratorName()

static std::string openfluid::fluidx::GeneratorDescriptor::getGeneratorName ( GeneratorDescriptor::GeneratorMethod  GenMethod )

static

getUnitClass()

openfluid::core::UnitsClass_t openfluid::fluidx::GeneratorDescriptor::getUnitClass ( ) const

inline

Deprecated:

Since version 2.1.0. Use openfluid::fluidx::GeneratorDescriptor::getUnitsClass() const instead

getUnitsClass()

openfluid::core::UnitsClass_t openfluid::fluidx::GeneratorDescriptor::getUnitsClass

(

)

const

getVariableName()

openfluid::core::VariableName_t openfluid::fluidx::GeneratorDescriptor::getVariableName

(

)

const

getVariableSize()

unsigned int openfluid::fluidx::GeneratorDescriptor::getVariableSize ( ) const

inline

getVariableType()

openfluid::core::Value::Type openfluid::fluidx::GeneratorDescriptor::getVariableType ( ) const

inline

isScalarVariable()

bool openfluid::fluidx::GeneratorDescriptor::isScalarVariable ( ) const

inline

isVectorVariable()

bool openfluid::fluidx::GeneratorDescriptor::isVectorVariable ( ) const

inline

---

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

• fluidx/GeneratorDescriptor.hpp