Fawkes API  Fawkes Development Version
protoboard::bb_iface_manager< IfaceT, MessageTypeList > Class Template Reference

Container for an opened interface of type. More...

#include <blackboard_manager.h>

Public Member Functions

 bb_iface_manager ()
 Constructor. Not responsible for actual initialization. More...
 
void init (fawkes::BlackBoard *blackboard, fawkes::Thread *thread)
 Open an interface of the given type with the ID supplied by iface_id_for_type and register to wake the given thread when any of the given types arrives. More...
 
void finalize ()
 Cleanup. More...
 
IfaceT * interface () const
 

Detailed Description

template<class IfaceT, class MessageTypeList>
class protoboard::bb_iface_manager< IfaceT, MessageTypeList >

Container for an opened interface of type.

Template Parameters
IfaceT.
MessageTypeListmust be a type_list of the message types that should be handled on
IfaceT.

Definition at line 63 of file blackboard_manager.h.

Constructor & Destructor Documentation

◆ bb_iface_manager()

template<class IfaceT , class MessageTypeList >
protoboard::bb_iface_manager< IfaceT, MessageTypeList >::bb_iface_manager ( )
inline

Constructor. Not responsible for actual initialization.

Definition at line 67 of file blackboard_manager.h.

Member Function Documentation

◆ finalize()

template<class IfaceT , class MessageTypeList >
void protoboard::bb_iface_manager< IfaceT, MessageTypeList >::finalize ( )
inline

Cleanup.

Definition at line 90 of file blackboard_manager.h.

References fawkes::BlackBoard::close().

◆ init()

template<class IfaceT , class MessageTypeList >
void protoboard::bb_iface_manager< IfaceT, MessageTypeList >::init ( fawkes::BlackBoard blackboard,
fawkes::Thread thread 
)
inline

Open an interface of the given type with the ID supplied by iface_id_for_type and register to wake the given thread when any of the given types arrives.

Parameters
blackboardThe blackboard to use
threadThe thread to wake

Definition at line 76 of file blackboard_manager.h.

References fawkes::BlackBoard::open_for_writing().

◆ interface()

template<class IfaceT , class MessageTypeList >
IfaceT* protoboard::bb_iface_manager< IfaceT, MessageTypeList >::interface ( ) const
inline
Returns
The managed interface

Definition at line 99 of file blackboard_manager.h.


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