All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Protected Member Functions | Protected Attributes
openfluid::ware::SimulationInspectorWare Class Reference

#include <ware/SimulationInspectorWare.hpp>

Inheritance diagram for openfluid::ware::SimulationInspectorWare:
openfluid::ware::SimulationDrivenWare openfluid::ware::PluggableWare openfluid::ware::PluggableObserver openfluid::ware::SimulationContributorWare openfluid::ware::PluggableSimulator openfluid::machine::Generator openfluid::machine::FixedGenerator openfluid::machine::InjectGenerator openfluid::machine::InterpGenerator openfluid::machine::RandomGenerator

List of all members.

Public Member Functions

virtual ~SimulationInspectorWare ()
void linkToCoreRepository (openfluid::core::CoreRepository *CoreRepos)
void linkToDatastore (openfluid::core::Datastore *DStore)

Protected Member Functions

virtual bool isLinked () const
bool OPENFLUID_IsAttributeExist (const openfluid::core::Unit *UnitPtr, const openfluid::core::AttributeName_t &AttrName) const
void OPENFLUID_GetAttribute (const openfluid::core::Unit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, openfluid::core::StringValue &Val) const
void OPENFLUID_GetAttribute (const openfluid::core::Unit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, openfluid::core::DoubleValue &Val) const
void OPENFLUID_GetAttribute (const openfluid::core::Unit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, openfluid::core::VectorValue &Val) const
void OPENFLUID_GetAttribute (const openfluid::core::Unit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, openfluid::core::MatrixValue &Val) const
void OPENFLUID_GetAttribute (const openfluid::core::Unit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, double &Val) const
void OPENFLUID_GetAttribute (const openfluid::core::Unit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, long &Val) const
void OPENFLUID_GetAttribute (const openfluid::core::Unit *UnitPtr, const openfluid::core::AttributeName_t &AttrName, std::string &Val) const
bool OPENFLUID_IsVariableExist (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName) const
bool OPENFLUID_IsVariableExist (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index) const
bool 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
bool OPENFLUID_IsTypedVariableExist (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::Value::Type VarType) const
bool 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
void OPENFLUID_GetVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index, openfluid::core::Value &Val) const
void OPENFLUID_GetVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index, double &Val) const
void OPENFLUID_GetVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index, long &Val) const
void OPENFLUID_GetVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index, bool &Val) const
void OPENFLUID_GetVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t Index, std::string &Val) const
void OPENFLUID_GetVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, openfluid::core::Value &Val) const
void OPENFLUID_GetVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, double &Val) const
void OPENFLUID_GetVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, long &Val) const
void OPENFLUID_GetVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, bool &Val) const
void OPENFLUID_GetVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, std::string &Val) const
void OPENFLUID_GetLatestVariable (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, openfluid::core::IndexedValue &IndVal)
void OPENFLUID_GetLatestVariables (const openfluid::core::Unit *UnitPtr, const openfluid::core::VariableName_t &VarName, const openfluid::core::TimeIndex_t BeginIndex, openfluid::core::IndexedValueList &IndValList)
void 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)
void OPENFLUID_GetEvents (const openfluid::core::Unit *UnitPtr, const openfluid::core::DateTime BeginDate, const openfluid::core::DateTime EndDate, openfluid::core::EventsCollection &Events) const
bool OPENFLUID_IsUnitClassExist (openfluid::core::UnitClass_t ClassName) const
bool OPENFLUID_IsUnitExist (openfluid::core::UnitClass_t ClassName, openfluid::core::UnitID_t ID) const
void OPENFLUID_GetUnitsCount (unsigned int &UnitsCount) const
bool OPENFLUID_GetUnitsCount (const openfluid::core::UnitClass_t ClassName, unsigned int &UnitsCount) const
bool OPENFLUID_GetUnit (const openfluid::core::UnitClass_t &ClassName, const openfluid::core::UnitID_t &ID, openfluid::core::Unit *aUnit) const
openfluid::core::UnitOPENFLUID_GetUnit (const openfluid::core::UnitClass_t &ClassName, const openfluid::core::UnitID_t &ID) const
bool OPENFLUID_IsUnitConnectedTo (openfluid::core::Unit *aUnit, const openfluid::core::UnitClass_t &ClassNameTo, const openfluid::core::UnitID_t &IDTo) const
bool OPENFLUID_IsUnitConnectedFrom (openfluid::core::Unit *aUnit, const openfluid::core::UnitClass_t &ClassNameFrom, const openfluid::core::UnitID_t &IDFrom) const
bool OPENFLUID_IsUnitChildOf (openfluid::core::Unit *aUnit, const openfluid::core::UnitClass_t &ClassNameParent, const openfluid::core::UnitID_t &IDParent) const
bool OPENFLUID_IsUnitParentOf (openfluid::core::Unit *aUnit, const openfluid::core::UnitClass_t &ClassNameChild, const openfluid::core::UnitID_t &IDChild) const
 SimulationInspectorWare (WareType WType)

Protected Attributes

openfluid::core::CoreRepositorymp_CoreData

Constructor & Destructor Documentation


Member Function Documentation

virtual bool openfluid::ware::SimulationInspectorWare::isLinked ( ) const [inline, protected, virtual]

Gets attribute for a unit, as a StringValue

Parameters:
[in]UnitPtra Unit
[in]AttrNamethe name of the requested attribute
[out]Valthe value of the requested attribute

Gets attribute for a unit, as a DoubleValue

Parameters:
[in]UnitPtra Unit
[in]AttrNamethe name of the requested attribute
[out]Valthe value of the requested attribute

Gets attribute for a unit, as a VectorValue

Parameters:
[in]UnitPtra Unit
[in]AttrNamethe name of the requested attribute
[out]Valthe value of the requested attribute

Gets attribute for a unit, as a MatrixValue

Parameters:
[in]UnitPtra Unit
[in]AttrNamethe name of the requested attribute
[out]Valthe 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

Parameters:
[in]UnitPtra Unit
[in]AttrNamethe name of the requested attribute
[out]Valthe 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

Parameters:
[in]UnitPtra Unit
[in]AttrNamethe name of the requested attribute
[out]Valthe 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

Parameters:
[in]UnitPtra Unit
[in]AttrNamethe name of the requested attribute
[out]Valthe value of the requested attribute

Gets discrete events happening on a unit during a time period

Parameters:
[in]UnitPtra Unit
[in]BeginDatethe beginning of the time period
[in]EndDatethe ending of the time period
[out]Eventsthe collection of event corresponding to the request

Gets the latest available variable for a unit

Parameters:
[in]UnitPtra Unit
[in]VarNamethe name of the requested variable
[out]IndValthe value and timeindex of the requested variable

Gets the latest available variables for a unit since the given time index

Parameters:
[in]UnitPtra Unit
[in]VarNamethe name of the requested variable
[out]IndValthe value and timeindex of the requested variable

Returns a pointer to the queried unit if exists

Parameters:
[in]ClassNamethe queried class name
[in]IDthe queried unit ID
[out]aUnita pointer to the requested Unit, NULL if the unit does not exist
Returns:
false if the unit does not exist
void openfluid::ware::SimulationInspectorWare::OPENFLUID_GetUnitsCount ( unsigned int &  UnitsCount) const [protected]

Returns the total number of units

Parameters:
[out]UnitsCountthe 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

Parameters:
[in]ClassNamethe queried class name
[out]UnitsCountthe queried class name
Returns:
false if the unit class does not exist

Gets the distributed variable value for a unit at a time index

Parameters:
[in]UnitPtra Unit
[in]VarNamethe name of the requested variable
[in]Indexthe time index for the value of the requested variable
[out]Valthe 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

Parameters:
[in]UnitPtra Unit
[in]VarNamethe name of the requested variable
[in]Indexthe time index for the value of the requested variable
[out]Valthe 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

Parameters:
[in]UnitPtra Unit
[in]VarNamethe name of the requested variable
[in]Indexthe time index for the value of the requested variable
[out]Valthe 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

Parameters:
[in]UnitPtra Unit
[in]VarNamethe name of the requested variable
[in]Indexthe time index for the value of the requested variable
[out]Valthe 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

Parameters:
[in]UnitPtra Unit
[in]VarNamethe name of the requested variable
[in]Indexthe time index for the value of the requested variable
[out]Valthe value of the requested variable

Gets the distributed variable value for a unit at the current time index

Parameters:
[in]UnitPtra Unit
[in]VarNamethe name of the requested variable
[out]Valthe 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

Parameters:
[in]UnitPtra Unit
[in]VarNamethe name of the requested variable
[out]Valthe 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

Parameters:
[in]UnitPtra Unit
[in]VarNamethe name of the requested variable
[out]Valthe 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

Parameters:
[in]UnitPtra Unit
[in]VarNamethe name of the requested variable
[in]Indexthe time index for the value of the requested variable
[out]Valthe 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

Parameters:
[in]UnitPtra Unit
[in]VarNamethe name of the requested variable
[out]Valthe value of the requested variable

Gets the available variables for a unit during a given period (between two time indexes)

Parameters:
[in]UnitPtra Unit
[in]VarNamethe name of the requested variable
[in]BeginIndexthe time index for the beginning of the period
[in]EndIndexthe time index for the end of the period
[out]IndValthe value and timeindex of the requested variable

Returns true if a distributed attribute exists, false otherwise

Parameters:
[in]UnitPtra Unit
[in]AttrNamethe name of the queried attribute

Returns true if a distributed variable exists and if the type set for this variable is the given type, false otherwise

Parameters:
[in]UnitPtra Unit
[in]VarNamethe name of the requested variable
[in]VarTypethe type of the variable

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

Parameters:
[in]UnitPtra Unit
[in]VarNamethe name of the requested variable
[in]Indexthe time index for the value of the variable
[in]VarTypethe type of the variable

Returns true if a given unit is "a child of" another unit

Parameters:
[in]aUnitthe given unit
[in]ClassNameParentthe class name of the other unit to test
[in]IDParentthe ID of the other unit to test
Returns:
true if the given unit is "a child of" the other unit

Returns true if the queried unit class exists

Parameters:
[in]ClassNamethe queried class name

Returns true if a given unit is connected "from" another unit

Parameters:
[in]aUnitthe given unit
[in]ClassNameFromthe class name of the other unit to test
[in]IDFromthe ID of the other unit to test
Returns:
true if the given unit is connected "from" the other unit

Returns true if a given unit is connected "to" another unit

Parameters:
[in]aUnitthe given unit
[in]ClassNameTothe class name of the other unit to test
[in]IDTothe ID of the other unit to test
Returns:
true if the given unit is connected "to" the other unit

Returns true if the queried unit exists

Parameters:
[in]ClassNamethe class of the queried unit
[in]IDthe ID of the queried unit

Returns true if a given unit is "parent of" another unit

Parameters:
[in]aUnitthe given unit
[in]ClassNameChildthe class name of the other unit to test
[in]IDChildthe ID of the other unit to test
Returns:
true if the given unit is "parent of" the other unit

Returns true if a distributed variable exists, false otherwise

Parameters:
[in]UnitPtra Unit
[in]VarNamethe name of the requested variable

Returns true if a distributed variable exists and if a value has been set for the given index, false otherwise

Parameters:
[in]UnitPtra Unit
[in]VarNamethe name of the requested variable
[in]Indexthe time index for the value of the variable

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

Parameters:
[in]UnitPtra Unit
[in]VarNamethe name of the requested variable
[in]Indexthe time index for the value of the variable
[in]ValueTypethe type of the value

Member Data Documentation

Pointer to the core repository (const). It should be used with care. Prefer to use the OPENFLUID_Xxxx methods.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines