openfluid::machine::SimulatorSignatureRegistry Class Reference

#include <machine/SimulatorSignatureRegistry.hpp>

Public Types
typedef std::map< std::string, openfluid::machine::ModelItemSignatureInstance * >	SimSignaturesByName_t
typedef std::map< openfluid::fluidx::GeneratorDescriptor::GeneratorMethod, openfluid::machine::ModelItemSignatureInstance * >	GenSignaturesByMethod_t
typedef std::map< openfluid::ware::WareType, SimSignaturesByName_t >	SimSignaturesByTypeByName_t

Public Member Functions
const SimSignaturesByTypeByName_t &	getSimSignatures () const
const SimSignaturesByName_t &	getGeneratorSignatures () const
const SimSignaturesByName_t &	getSimulatorSignatures () const
void	update ()
bool	isSimulatorAvailable (const openfluid::ware::WareID_t &ID) const
const ModelItemSignatureInstance *	signature (const openfluid::ware::WareID_t &ID) const
const ModelItemSignatureInstance *	signature (openfluid::fluidx::ModelItemDescriptor *Item) const
const ModelItemSignatureInstance *	signature (openfluid::fluidx::GeneratorDescriptor::GeneratorMethod Method) const
void	unloadAll ()

Inheritance diagram for openfluid::machine::SimulatorSignatureRegistry:

Collaboration diagram for openfluid::machine::SimulatorSignatureRegistry:

Member Typedef Documentation

GenSignaturesByMethod_t

typedef std::map<openfluid::fluidx::GeneratorDescriptor::GeneratorMethod, openfluid::machine::ModelItemSignatureInstance*> openfluid::machine::SimulatorSignatureRegistry::GenSignaturesByMethod_t

SimSignaturesByName_t

typedef std::map<std::string, openfluid::machine::ModelItemSignatureInstance*> openfluid::machine::SimulatorSignatureRegistry::SimSignaturesByName_t

SimSignaturesByTypeByName_t

typedef std::map<openfluid::ware::WareType, SimSignaturesByName_t> openfluid::machine::SimulatorSignatureRegistry::SimSignaturesByTypeByName_t

Member Function Documentation

getGeneratorSignatures()

const SimSignaturesByName_t& openfluid::machine::SimulatorSignatureRegistry::getGeneratorSignatures

(

)

const

getSimSignatures()

const SimSignaturesByTypeByName_t& openfluid::machine::SimulatorSignatureRegistry::getSimSignatures

(

)

const

getSimulatorSignatures()

const SimSignaturesByName_t& openfluid::machine::SimulatorSignatureRegistry::getSimulatorSignatures

(

)

const

isSimulatorAvailable()

bool openfluid::machine::SimulatorSignatureRegistry::isSimulatorAvailable

(

const openfluid::ware::WareID_t &

ID

)

const

signature() [1/3]

const ModelItemSignatureInstance* openfluid::machine::SimulatorSignatureRegistry::signature ( const openfluid::ware::WareID_t &  ID ) const

virtual

Returns the signature of the ware given by its ID

Parameters

[in]

ID

The ID of the ware

Returns

The signature of the ware, nullptr if not found

Implements openfluid::machine::WareSignatureRegistry< ModelItemSignatureInstance >.

signature() [2/3]

const ModelItemSignatureInstance* openfluid::machine::SimulatorSignatureRegistry::signature

(

openfluid::fluidx::ModelItemDescriptor *

Item

)

const

signature() [3/3]

const ModelItemSignatureInstance* openfluid::machine::SimulatorSignatureRegistry::signature

(

openfluid::fluidx::GeneratorDescriptor::GeneratorMethod

Method

)

const

unloadAll()

void openfluid::machine::SimulatorSignatureRegistry::unloadAll ( )

virtual

Unloads all signatures of the registry

Implements openfluid::machine::WareSignatureRegistry< ModelItemSignatureInstance >.

update()

void openfluid::machine::SimulatorSignatureRegistry::update ( )

virtual

Updates the registry from available plugins

Implements openfluid::machine::WareSignatureRegistry< ModelItemSignatureInstance >.

---

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

• machine/SimulatorSignatureRegistry.hpp