openfluid::fluidx::AdvancedModelDescriptor Class Reference

#include <fluidx/AdvancedModelDescriptor.hpp>

Public Member Functions
	AdvancedModelDescriptor (openfluid::fluidx::CoupledModelDescriptor &ModelDesc)
	~AdvancedModelDescriptor ()
void	checkModel () const
const std::list < openfluid::fluidx::ModelItemDescriptor * > &	getItems () const
openfluid::fluidx::ModelItemDescriptor *	getItemAt (unsigned int Index) const
int	getFirstItemIndex (std::string ItemID) const
int	getFirstItemIndex (openfluid::fluidx::ModelItemDescriptor *Item) const
std::vector< std::string >	getOrderedIDs () const
std::string	getID (openfluid::fluidx::ModelItemDescriptor *Item) const
void	appendItem (openfluid::fluidx::ModelItemDescriptor *Item)
void	insertItem (openfluid::fluidx::ModelItemDescriptor *Item, unsigned int Position)
void	setItems (std::list< openfluid::fluidx::ModelItemDescriptor * > SimulatorsList)
	Replace existing simulators with SimulatorsList. More...
void	removeItem (unsigned int Position)
void	moveItem (unsigned int From, unsigned int To)
unsigned int	getItemsCount () const
void	getItemsCount (unsigned int &SimCount, unsigned int &GenCount) const
void	setGlobalParameter (const openfluid::ware::WareParamKey_t &Key, const openfluid::ware::WareParamValue_t &Value)
void	setGlobalParameters (const openfluid::ware::WareParams_t &Params)
openfluid::ware::WareParams_t	getGlobalParameters () const
void	eraseGlobalParameter (const openfluid::ware::WareParamKey_t &Key)

Protected Member Functions
	AdvancedModelDescriptor ()

Protected Attributes
openfluid::fluidx::CoupledModelDescriptor *	mp_ModelDesc

Constructor & Destructor Documentation

openfluid::fluidx::AdvancedModelDescriptor::AdvancedModelDescriptor ( )

inlineprotected

openfluid::fluidx::AdvancedModelDescriptor::AdvancedModelDescriptor

(

openfluid::fluidx::CoupledModelDescriptor &

ModelDesc

)

openfluid::fluidx::AdvancedModelDescriptor::~AdvancedModelDescriptor

(

)

Member Function Documentation

void openfluid::fluidx::AdvancedModelDescriptor::appendItem

(

openfluid::fluidx::ModelItemDescriptor *

Item

)

void openfluid::fluidx::AdvancedModelDescriptor::checkModel

(

)

const

void openfluid::fluidx::AdvancedModelDescriptor::eraseGlobalParameter

(

const openfluid::ware::WareParamKey_t &

Key

)

int openfluid::fluidx::AdvancedModelDescriptor::getFirstItemIndex

(

std::string

ItemID

)

const

Return the position of the firts Item with ItemID found in the list, or -1 if not found

Parameters

ItemID

Returns

int openfluid::fluidx::AdvancedModelDescriptor::getFirstItemIndex

(

openfluid::fluidx::ModelItemDescriptor *

Item

)

const

openfluid::ware::WareParams_t openfluid::fluidx::AdvancedModelDescriptor::getGlobalParameters

(

)

const

std::string openfluid::fluidx::AdvancedModelDescriptor::getID

(

openfluid::fluidx::ModelItemDescriptor *

Item

)

const

openfluid::fluidx::ModelItemDescriptor* openfluid::fluidx::AdvancedModelDescriptor::getItemAt

(

unsigned int

Index

)

const

Exceptions

openfluid::base::OFException

if Index is out of range

Parameters

Index

Returns

const std::list<openfluid::fluidx::ModelItemDescriptor*>& openfluid::fluidx::AdvancedModelDescriptor::getItems

(

)

const

unsigned int openfluid::fluidx::AdvancedModelDescriptor::getItemsCount

(

)

const

void openfluid::fluidx::AdvancedModelDescriptor::getItemsCount	(	unsigned int &	SimCount,
		unsigned int &	GenCount
	)		const

std::vector<std::string> openfluid::fluidx::AdvancedModelDescriptor::getOrderedIDs

(

)

const

void openfluid::fluidx::AdvancedModelDescriptor::insertItem	(	openfluid::fluidx::ModelItemDescriptor *	Item,
		unsigned int	Position
	)

Insert an Item before the given position (positions starts at index 0)

Parameters

[in]	Item	the ModelItemDescriptor to insert
[in]	Position	the position, should be between zero and list size - 1. To insert an Item at the end of the list, use appendItem instead.

Exceptions

openfluid::base::OFException

if Position is out of range

void openfluid::fluidx::AdvancedModelDescriptor::moveItem	(	unsigned int	From,
		unsigned int	To
	)

Move the Item located at the given From position to the To position (positions starts at index 0)

Parameters

From
To

Exceptions

openfluid::base::OFException

a position is out of range

void openfluid::fluidx::AdvancedModelDescriptor::removeItem

(

unsigned int

Position

)

Remove from the list the Item located at the given Position (positions starts at index 0). This doesn't delete the ModelItemDescriptor pointer.

Parameters

[in]

Position

the position

Exceptions

openfluid::base::OFException

if Position is out of range

void openfluid::fluidx::AdvancedModelDescriptor::setGlobalParameter	(	const openfluid::ware::WareParamKey_t &	Key,
		const openfluid::ware::WareParamValue_t &	Value
	)

void openfluid::fluidx::AdvancedModelDescriptor::setGlobalParameters

(

const openfluid::ware::WareParams_t &

Params

)

void openfluid::fluidx::AdvancedModelDescriptor::setItems

(

std::list< openfluid::fluidx::ModelItemDescriptor * >

SimulatorsList

)

Replace existing simulators with SimulatorsList.

Member Data Documentation

openfluid::fluidx::CoupledModelDescriptor* openfluid::fluidx::AdvancedModelDescriptor::mp_ModelDesc

protected

---

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

• fluidx/AdvancedModelDescriptor.hpp