Documentation for OpenFLUID 2.2.0
openfluid::machine::ObserverRegistry Class Reference

#include <machine/ObserverRegistry.hpp>

Public Member Functions

bool addWare (const openfluid::ware::WareID_t &ID)
 
void discoverWares (const std::string IDPattern="")
 
void clear ()
 
- Public Member Functions inherited from openfluid::machine::WareRegistry< openfluid::ware::ObserverSignature >
void clearWares ()
 
const WareContainer< openfluid::ware::ObserverSignature > & wareContainer (const openfluid::ware::WareID_t &ID) const
 
const WaresByID_tavailableWares () const
 
const WaresByPath_terroredWares () const
 
bool hasAvailableWare (const openfluid::ware::WareID_t &ID) const
 

Additional Inherited Members

- Public Types inherited from openfluid::machine::WareRegistry< openfluid::ware::ObserverSignature >
using WaresByID_t = std::map< openfluid::ware::WareID_t, WareContainer< openfluid::ware::ObserverSignature > >
 
using WaresByPath_t = std::map< std::string, WareContainer< openfluid::ware::ObserverSignature > >
 
- Protected Member Functions inherited from openfluid::machine::WareRegistry< openfluid::ware::ObserverSignature >
virtual ~WareRegistry ()
 
bool add (WareContainer< openfluid::ware::ObserverSignature > Container)
 
- Protected Attributes inherited from openfluid::machine::WareRegistry< openfluid::ware::ObserverSignature >
WaresByID_t m_AvailableWares
 
WaresByPath_t m_ErroredWares
 
WareContainer< openfluid::ware::ObserverSignaturem_InvalidWareContainer
 
Inheritance diagram for openfluid::machine::ObserverRegistry:
Collaboration diagram for openfluid::machine::ObserverRegistry:

Member Function Documentation

◆ addWare()

bool openfluid::machine::ObserverRegistry::addWare ( const openfluid::ware::WareID_t ID)
virtual

Loads an observer ware and adds it in the registry if everything went fine

Parameters
[in]IDthe ID of the ware to load
Returns
true if the wares is successfully added

Implements openfluid::machine::WareRegistry< openfluid::ware::ObserverSignature >.

◆ clear()

void openfluid::machine::ObserverRegistry::clear ( )
inlinevirtual

◆ discoverWares()

void openfluid::machine::ObserverRegistry::discoverWares ( const std::string  IDPattern = "")
virtual

Automatically discovers observer wares and adds it in the registry, optionally filtered on IDs using a given pattern

Parameters
[in]IDPatternthe pattern to filter the wares on ID. Default is empty (no filtering)

Implements openfluid::machine::WareRegistry< openfluid::ware::ObserverSignature >.


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