openfluid::core::Variables Class Reference

#include <core/Variables.hpp>

Public Member Functions
bool	createVariable (const VariableName_t &aName)
bool	createVariable (const VariableName_t &aName, const Value::Type &aType)
bool	modifyValue (const VariableName_t &aName, const TimeIndex_t &anIndex, const Value &aValue)
bool	modifyCurrentValue (const VariableName_t &aName, const Value &aValue)
bool	appendValue (const VariableName_t &aName, const TimeIndex_t &anIndex, const Value &aValue)
bool	getValue (const VariableName_t &aName, const TimeIndex_t &anIndex, Value *aValue) const
const Value *	value (const VariableName_t &aName, const TimeIndex_t &anIndex) const
const Value *	currentValue (const VariableName_t &aName) const
bool	getCurrentValue (const VariableName_t &aName, Value *aValue) const
bool	getLatestIndexedValue (const VariableName_t &aName, IndexedValue &IndValue) const
bool	getLatestIndexedValues (const VariableName_t &aName, const TimeIndex_t &anIndex, IndexedValueList &IndValueList) const
bool	getIndexedValues (const VariableName_t &aName, const TimeIndex_t &aBeginIndex, const TimeIndex_t &anEndIndex, IndexedValueList &IndValueList) const
bool	getCurrentValueIfIndex (const VariableName_t &aName, const TimeIndex_t &Index, Value *aValue) const
Value *	currentValueIfIndex (const VariableName_t &aName, const TimeIndex_t &Index) const
bool	isVariableExist (const VariableName_t &aName) const
bool	isVariableExist (const VariableName_t &aName, const TimeIndex_t &anIndex) const
bool	isVariableExist (const VariableName_t &aName, const TimeIndex_t &anIndex, Value::Type ValueType) const
bool	isTypedVariableExist (const VariableName_t &aName, const Value::Type &VarType) const
bool	isTypedVariableExist (const VariableName_t &aName, const TimeIndex_t &anIndex, const Value::Type &VarType) const
std::vector< VariableName_t >	getVariablesNames () const
int	getVariableValuesCount (const VariableName_t &aName) const
bool	checkAllVariablesCount (unsigned int Count, VariableName_t &ErrorVarName) const
void	clear ()
void	displayContent (const VariableName_t &aName, std::ostream &OStream) const

Member Function Documentation

appendValue()

bool openfluid::core::Variables::appendValue	(	const VariableName_t &	aName,
		const TimeIndex_t &	anIndex,
		const Value &	aValue
	)

checkAllVariablesCount()

bool openfluid::core::Variables::checkAllVariablesCount	(	unsigned int	Count,
		VariableName_t &	ErrorVarName
	)		const

clear()

void openfluid::core::Variables::clear

(

)

createVariable() [1/2]

bool openfluid::core::Variables::createVariable

(

const VariableName_t &

aName

)

createVariable() [2/2]

bool openfluid::core::Variables::createVariable	(	const VariableName_t &	aName,
		const Value::Type &	aType
	)

currentValue()

const Value* openfluid::core::Variables::currentValue

(

const VariableName_t &

aName

)

const

currentValueIfIndex()

Value* openfluid::core::Variables::currentValueIfIndex	(	const VariableName_t &	aName,
		const TimeIndex_t &	Index
	)		const

displayContent()

void openfluid::core::Variables::displayContent	(	const VariableName_t &	aName,
		std::ostream &	OStream
	)		const

getCurrentValue()

bool openfluid::core::Variables::getCurrentValue	(	const VariableName_t &	aName,
		Value *	aValue
	)		const

getCurrentValueIfIndex()

bool openfluid::core::Variables::getCurrentValueIfIndex	(	const VariableName_t &	aName,
		const TimeIndex_t &	Index,
		Value *	aValue
	)		const

getIndexedValues()

bool openfluid::core::Variables::getIndexedValues	(	const VariableName_t &	aName,
		const TimeIndex_t &	aBeginIndex,
		const TimeIndex_t &	anEndIndex,
		IndexedValueList &	IndValueList
	)		const

getLatestIndexedValue()

bool openfluid::core::Variables::getLatestIndexedValue	(	const VariableName_t &	aName,
		IndexedValue &	IndValue
	)		const

getLatestIndexedValues()

bool openfluid::core::Variables::getLatestIndexedValues	(	const VariableName_t &	aName,
		const TimeIndex_t &	anIndex,
		IndexedValueList &	IndValueList
	)		const

getValue()

bool openfluid::core::Variables::getValue	(	const VariableName_t &	aName,
		const TimeIndex_t &	anIndex,
		Value *	aValue
	)		const

getVariablesNames()

std::vector<VariableName_t> openfluid::core::Variables::getVariablesNames

(

)

const

getVariableValuesCount()

int openfluid::core::Variables::getVariableValuesCount

(

const VariableName_t &

aName

)

const

isTypedVariableExist() [1/2]

bool openfluid::core::Variables::isTypedVariableExist	(	const VariableName_t &	aName,
		const TimeIndex_t &	anIndex,
		const Value::Type &	VarType
	)		const

isTypedVariableExist() [2/2]

bool openfluid::core::Variables::isTypedVariableExist	(	const VariableName_t &	aName,
		const Value::Type &	VarType
	)		const

isVariableExist() [1/3]

bool openfluid::core::Variables::isVariableExist

(

const VariableName_t &

aName

)

const

isVariableExist() [2/3]

bool openfluid::core::Variables::isVariableExist	(	const VariableName_t &	aName,
		const TimeIndex_t &	anIndex
	)		const

isVariableExist() [3/3]

bool openfluid::core::Variables::isVariableExist	(	const VariableName_t &	aName,
		const TimeIndex_t &	anIndex,
		Value::Type	ValueType
	)		const

modifyCurrentValue()

bool openfluid::core::Variables::modifyCurrentValue	(	const VariableName_t &	aName,
		const Value &	aValue
	)

modifyValue()

bool openfluid::core::Variables::modifyValue	(	const VariableName_t &	aName,
		const TimeIndex_t &	anIndex,
		const Value &	aValue
	)

value()

const Value* openfluid::core::Variables::value	(	const VariableName_t &	aName,
		const TimeIndex_t &	anIndex
	)		const

---

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

• core/Variables.hpp