#include <ware/SimulationInspectorWare.hpp>
openfluid::ware::SimulationInspectorWare::SimulationInspectorWare | ( | WareType | WType | ) | [inline, protected] |
virtual openfluid::ware::SimulationInspectorWare::~SimulationInspectorWare | ( | ) | [inline, virtual] |
virtual bool openfluid::ware::SimulationInspectorWare::isLinked | ( | ) | const [inline, protected, virtual] |
Reimplemented from openfluid::ware::SimulationDrivenWare.
void openfluid::ware::SimulationInspectorWare::linkToCoreRepository | ( | openfluid::core::CoreRepository * | CoreRepos | ) | [inline] |
void openfluid::ware::SimulationInspectorWare::linkToDatastore | ( | openfluid::core::Datastore * | DStore | ) | [inline] |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetAttribute | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::AttributeName_t & | AttrName, | ||
openfluid::core::StringValue & | Val | ||
) | const [protected] |
Gets attribute for a unit, as a StringValue
[in] | UnitPtr | a Unit |
[in] | AttrName | the name of the requested attribute |
[out] | Val | the value of the requested attribute |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetAttribute | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::AttributeName_t & | AttrName, | ||
openfluid::core::DoubleValue & | Val | ||
) | const [protected] |
Gets attribute for a unit, as a DoubleValue
[in] | UnitPtr | a Unit |
[in] | AttrName | the name of the requested attribute |
[out] | Val | the value of the requested attribute |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetAttribute | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::AttributeName_t & | AttrName, | ||
openfluid::core::VectorValue & | Val | ||
) | const [protected] |
Gets attribute for a unit, as a VectorValue
[in] | UnitPtr | a Unit |
[in] | AttrName | the name of the requested attribute |
[out] | Val | the value of the requested attribute |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetAttribute | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::AttributeName_t & | AttrName, | ||
openfluid::core::MatrixValue & | Val | ||
) | const [protected] |
Gets attribute for a unit, as a MatrixValue
[in] | UnitPtr | a Unit |
[in] | AttrName | the name of the requested attribute |
[out] | Val | the value of the requested attribute |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetAttribute | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::AttributeName_t & | AttrName, | ||
double & | Val | ||
) | const [protected] |
Gets attribute for a unit, as a double
[in] | UnitPtr | a Unit |
[in] | AttrName | the name of the requested attribute |
[out] | Val | the value of the requested attribute |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetAttribute | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::AttributeName_t & | AttrName, | ||
long & | Val | ||
) | const [protected] |
Gets attribute for a unit, as a long integer
[in] | UnitPtr | a Unit |
[in] | AttrName | the name of the requested attribute |
[out] | Val | the value of the requested attribute |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetAttribute | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::AttributeName_t & | AttrName, | ||
std::string & | Val | ||
) | const [protected] |
Gets attribute for a unit, as a string
[in] | UnitPtr | a Unit |
[in] | AttrName | the name of the requested attribute |
[out] | Val | the value of the requested attribute |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetEvents | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::DateTime | BeginDate, | ||
const openfluid::core::DateTime | EndDate, | ||
openfluid::core::EventsCollection & | Events | ||
) | const [protected] |
Gets discrete events happening on a unit during a time period
[in] | UnitPtr | a Unit |
[in] | BeginDate | the beginning of the time period |
[in] | EndDate | the ending of the time period |
[out] | Events | the collection of event corresponding to the request |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetLatestVariable | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::VariableName_t & | VarName, | ||
openfluid::core::IndexedValue & | IndVal | ||
) | [protected] |
Gets the latest available variable for a unit
[in] | UnitPtr | a Unit |
[in] | VarName | the name of the requested variable |
[out] | IndVal | the value and timeindex of the requested variable |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetLatestVariables | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::VariableName_t & | VarName, | ||
const openfluid::core::TimeIndex_t | BeginIndex, | ||
openfluid::core::IndexedValueList & | IndValList | ||
) | [protected] |
Gets the latest available variables for a unit since the given time index
[in] | UnitPtr | a Unit |
[in] | VarName | the name of the requested variable |
[out] | IndVal | the value and timeindex of the requested variable |
bool openfluid::ware::SimulationInspectorWare::OPENFLUID_GetUnit | ( | const openfluid::core::UnitClass_t & | ClassName, |
const openfluid::core::UnitID_t & | ID, | ||
openfluid::core::Unit * | aUnit | ||
) | const [protected] |
Returns a pointer to the queried unit if exists
[in] | ClassName | the queried class name |
[in] | ID | the queried unit ID |
[out] | aUnit | a pointer to the requested Unit, NULL if the unit does not exist |
openfluid::core::Unit* openfluid::ware::SimulationInspectorWare::OPENFLUID_GetUnit | ( | const openfluid::core::UnitClass_t & | ClassName, |
const openfluid::core::UnitID_t & | ID | ||
) | const [protected] |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetUnitsCount | ( | unsigned int & | UnitsCount | ) | const [protected] |
Returns the total number of units
[out] | UnitsCount | the queried class name |
bool openfluid::ware::SimulationInspectorWare::OPENFLUID_GetUnitsCount | ( | const openfluid::core::UnitClass_t | ClassName, |
unsigned int & | UnitsCount | ||
) | const [protected] |
Returns the number of units of the class if the queried unit class exists
[in] | ClassName | the queried class name |
[out] | UnitsCount | the queried class name |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::VariableName_t & | VarName, | ||
const openfluid::core::TimeIndex_t | Index, | ||
openfluid::core::Value & | Val | ||
) | const [protected] |
Gets the distributed variable value for a unit at a time index
[in] | UnitPtr | a Unit |
[in] | VarName | the name of the requested variable |
[in] | Index | the time index for the value of the requested variable |
[out] | Val | the value of the requested variable |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::VariableName_t & | VarName, | ||
const openfluid::core::TimeIndex_t | Index, | ||
double & | Val | ||
) | const [protected] |
Gets the distributed variable value for a unit at a time index
[in] | UnitPtr | a Unit |
[in] | VarName | the name of the requested variable |
[in] | Index | the time index for the value of the requested variable |
[out] | Val | the value of the requested variable |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::VariableName_t & | VarName, | ||
const openfluid::core::TimeIndex_t | Index, | ||
long & | Val | ||
) | const [protected] |
Gets the distributed variable value for a unit at a time index
[in] | UnitPtr | a Unit |
[in] | VarName | the name of the requested variable |
[in] | Index | the time index for the value of the requested variable |
[out] | Val | the value of the requested variable |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::VariableName_t & | VarName, | ||
const openfluid::core::TimeIndex_t | Index, | ||
bool & | Val | ||
) | const [protected] |
Gets the distributed variable value for a unit at a time index
[in] | UnitPtr | a Unit |
[in] | VarName | the name of the requested variable |
[in] | Index | the time index for the value of the requested variable |
[out] | Val | the value of the requested variable |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::VariableName_t & | VarName, | ||
const openfluid::core::TimeIndex_t | Index, | ||
std::string & | Val | ||
) | const [protected] |
Gets the distributed variable value for a unit at a time index
[in] | UnitPtr | a Unit |
[in] | VarName | the name of the requested variable |
[in] | Index | the time index for the value of the requested variable |
[out] | Val | the value of the requested variable |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::VariableName_t & | VarName, | ||
openfluid::core::Value & | Val | ||
) | const [protected] |
Gets the distributed variable value for a unit at the current time index
[in] | UnitPtr | a Unit |
[in] | VarName | the name of the requested variable |
[out] | Val | the value of the requested variable |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::VariableName_t & | VarName, | ||
double & | Val | ||
) | const [protected] |
Gets the distributed variable value for a unit at the current time index
[in] | UnitPtr | a Unit |
[in] | VarName | the name of the requested variable |
[out] | Val | the value of the requested variable |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::VariableName_t & | VarName, | ||
long & | Val | ||
) | const [protected] |
Gets the distributed variable value for a unit at the current time index
[in] | UnitPtr | a Unit |
[in] | VarName | the name of the requested variable |
[out] | Val | the value of the requested variable |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::VariableName_t & | VarName, | ||
bool & | Val | ||
) | const [protected] |
Gets the distributed variable value for a unit at the current time index
[in] | UnitPtr | a Unit |
[in] | VarName | the name of the requested variable |
[in] | Index | the time index for the value of the requested variable |
[out] | Val | the value of the requested variable |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariable | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::VariableName_t & | VarName, | ||
std::string & | Val | ||
) | const [protected] |
Gets the distributed variable value for a unit at the current time index
[in] | UnitPtr | a Unit |
[in] | VarName | the name of the requested variable |
[out] | Val | the value of the requested variable |
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetVariables | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::VariableName_t & | VarName, | ||
const openfluid::core::TimeIndex_t | BeginIndex, | ||
const openfluid::core::TimeIndex_t | EndIndex, | ||
openfluid::core::IndexedValueList & | IndValList | ||
) | [protected] |
Gets the available variables for a unit during a given period (between two time indexes)
[in] | UnitPtr | a Unit |
[in] | VarName | the name of the requested variable |
[in] | BeginIndex | the time index for the beginning of the period |
[in] | EndIndex | the time index for the end of the period |
[out] | IndVal | the value and timeindex of the requested variable |
bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsAttributeExist | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::AttributeName_t & | AttrName | ||
) | const [protected] |
Returns true if a distributed attribute exists, false otherwise
[in] | UnitPtr | a Unit |
[in] | AttrName | the name of the queried attribute |
bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsTypedVariableExist | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::VariableName_t & | VarName, | ||
const openfluid::core::Value::Type | VarType | ||
) | const [protected] |
Returns true if a distributed variable exists and if the type set for this variable is the given type, false otherwise
[in] | UnitPtr | a Unit |
[in] | VarName | the name of the requested variable |
[in] | VarType | the type of the variable |
bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsTypedVariableExist | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::VariableName_t & | VarName, | ||
const openfluid::core::TimeIndex_t | Index, | ||
const openfluid::core::Value::Type | VarType | ||
) | const [protected] |
Returns true if a distributed variable exists and if a value has been set for the given index and if the type set for this variable is the given type, false otherwise
[in] | UnitPtr | a Unit |
[in] | VarName | the name of the requested variable |
[in] | Index | the time index for the value of the variable |
[in] | VarType | the type of the variable |
bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsUnitChildOf | ( | openfluid::core::Unit * | aUnit, |
const openfluid::core::UnitClass_t & | ClassNameParent, | ||
const openfluid::core::UnitID_t & | IDParent | ||
) | const [protected] |
Returns true if a given unit is "a child of" another unit
[in] | aUnit | the given unit |
[in] | ClassNameParent | the class name of the other unit to test |
[in] | IDParent | the ID of the other unit to test |
bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsUnitClassExist | ( | openfluid::core::UnitClass_t | ClassName | ) | const [protected] |
Returns true if the queried unit class exists
[in] | ClassName | the queried class name |
bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsUnitConnectedFrom | ( | openfluid::core::Unit * | aUnit, |
const openfluid::core::UnitClass_t & | ClassNameFrom, | ||
const openfluid::core::UnitID_t & | IDFrom | ||
) | const [protected] |
Returns true if a given unit is connected "from" another unit
[in] | aUnit | the given unit |
[in] | ClassNameFrom | the class name of the other unit to test |
[in] | IDFrom | the ID of the other unit to test |
bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsUnitConnectedTo | ( | openfluid::core::Unit * | aUnit, |
const openfluid::core::UnitClass_t & | ClassNameTo, | ||
const openfluid::core::UnitID_t & | IDTo | ||
) | const [protected] |
Returns true if a given unit is connected "to" another unit
[in] | aUnit | the given unit |
[in] | ClassNameTo | the class name of the other unit to test |
[in] | IDTo | the ID of the other unit to test |
bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsUnitExist | ( | openfluid::core::UnitClass_t | ClassName, |
openfluid::core::UnitID_t | ID | ||
) | const [protected] |
Returns true if the queried unit exists
[in] | ClassName | the class of the queried unit |
[in] | ID | the ID of the queried unit |
bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsUnitParentOf | ( | openfluid::core::Unit * | aUnit, |
const openfluid::core::UnitClass_t & | ClassNameChild, | ||
const openfluid::core::UnitID_t & | IDChild | ||
) | const [protected] |
Returns true if a given unit is "parent of" another unit
[in] | aUnit | the given unit |
[in] | ClassNameChild | the class name of the other unit to test |
[in] | IDChild | the ID of the other unit to test |
bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsVariableExist | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::VariableName_t & | VarName | ||
) | const [protected] |
Returns true if a distributed variable exists, false otherwise
[in] | UnitPtr | a Unit |
[in] | VarName | the name of the requested variable |
bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsVariableExist | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::VariableName_t & | VarName, | ||
const openfluid::core::TimeIndex_t | Index | ||
) | const [protected] |
Returns true if a distributed variable exists and if a value has been set for the given index, false otherwise
[in] | UnitPtr | a Unit |
[in] | VarName | the name of the requested variable |
[in] | Index | the time index for the value of the variable |
bool openfluid::ware::SimulationInspectorWare::OPENFLUID_IsVariableExist | ( | const openfluid::core::Unit * | UnitPtr, |
const openfluid::core::VariableName_t & | VarName, | ||
const openfluid::core::TimeIndex_t | Index, | ||
const openfluid::core::Value::Type | ValueType | ||
) | const [protected] |
Returns true if a distributed variable exists and if a value has been set for the given index and if the value type is the given type, false otherwise
[in] | UnitPtr | a Unit |
[in] | VarName | the name of the requested variable |
[in] | Index | the time index for the value of the variable |
[in] | ValueType | the type of the value |
Pointer to the core repository (const). It should be used with care. Prefer to use the OPENFLUID_Xxxx methods.