HiveMindBridge
Public Member Functions | Private Attributes | List of all members
UserCallbackMap Class Reference

#include <UserCallbackMap.h>

Inheritance diagram for UserCallbackMap:
Inheritance graph
Collaboration diagram for UserCallbackMap:
Collaboration graph

Public Member Functions

bool registerCallback (std::string name, CallbackFunction callback, CallbackArgsManifest manifest) override
 
bool registerCallback (std::string name, CallbackFunction callback) override
 
std::optional< CallbackFunctiongetCallback (const std::string &name) override
 
uint32_t getLength () override
 
std::optional< CallbackArgsManifestgetManifestAt (uint32_t index) override
 
std::optional< std::string > getNameAt (uint32_t index) override
 

Private Attributes

CallbackMap m_callbacks
 
std::vector< std::string > m_callbackNames
 

Member Function Documentation

◆ getCallback()

std::optional< CallbackFunction > UserCallbackMap::getCallback ( const std::string &  name)
overridevirtual

Get an instance of a callback, if it exists.

Parameters
nameKey under which the callback was registered
Returns
The callback function if it exists.

Implements IUserCallbackMap.

◆ getLength()

uint32_t UserCallbackMap::getLength ( )
overridevirtual

Implements IUserCallbackMap.

◆ getManifestAt()

std::optional< CallbackArgsManifest > UserCallbackMap::getManifestAt ( uint32_t  index)
overridevirtual

Implements IUserCallbackMap.

Here is the call graph for this function:

◆ getNameAt()

std::optional< std::string > UserCallbackMap::getNameAt ( uint32_t  index)
overridevirtual

Implements IUserCallbackMap.

◆ registerCallback() [1/2]

bool UserCallbackMap::registerCallback ( std::string  name,
CallbackFunction  callback 
)
overridevirtual

Register a callback

Parameters
nameKey of the callback
callbackCallback function
Returns
True if an existing callback function was overwritten, false otherwise

Implements IUserCallbackMap.

Here is the call graph for this function:

◆ registerCallback() [2/2]

bool UserCallbackMap::registerCallback ( std::string  name,
CallbackFunction  callback,
CallbackArgsManifest  manifest 
)
overridevirtual

Register a callback

Parameters
nameKey of the callback
callbackCallback function
manifestA list describing the callback's expected arguments name and type
Returns
True if an existing callback function was overwritten, false otherwise

Implements IUserCallbackMap.

Here is the caller graph for this function:

Member Data Documentation

◆ m_callbackNames

std::vector<std::string> UserCallbackMap::m_callbackNames
private

◆ m_callbacks

CallbackMap UserCallbackMap::m_callbacks
private

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