Public Types | Public Member Functions | Static Public Member Functions | List of all members
openfluid::fluidx::GeneratorDescriptor Class Reference

#include <fluidx/GeneratorDescriptor.hpp>

Inheritance diagram for openfluid::fluidx::GeneratorDescriptor:
Inheritance graph
[legend]
Collaboration diagram for openfluid::fluidx::GeneratorDescriptor:
Collaboration graph
[legend]

Public Types

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

Public Member Functions

 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 OPENFLUID_DEPRECATED
 
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_tparameters ()
 
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
 

Member Enumeration Documentation

Enumerator
NoGenMethod 
Fixed 
Random 
Interp 
Inject 

Constructor & Destructor Documentation

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

Member Function Documentation

std::string openfluid::fluidx::GeneratorDescriptor::getGeneratedID ( ) const
inline
GeneratorMethod openfluid::fluidx::GeneratorDescriptor::getGeneratorMethod ( ) const
static std::string openfluid::fluidx::GeneratorDescriptor::getGeneratorName ( GeneratorDescriptor::GeneratorMethod  GenMethod)
static
openfluid::core::UnitsClass_t openfluid::fluidx::GeneratorDescriptor::getUnitClass ( ) const
inline
openfluid::core::UnitsClass_t openfluid::fluidx::GeneratorDescriptor::getUnitsClass ( ) const
openfluid::core::VariableName_t openfluid::fluidx::GeneratorDescriptor::getVariableName ( ) const
unsigned int openfluid::fluidx::GeneratorDescriptor::getVariableSize ( ) const
inline
openfluid::core::Value::Type openfluid::fluidx::GeneratorDescriptor::getVariableType ( ) const
inline
bool openfluid::fluidx::GeneratorDescriptor::isScalarVariable ( ) const
inline
bool openfluid::fluidx::GeneratorDescriptor::isVectorVariable ( ) const
inline

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