switchboard::SwitchboardObject Class Reference

SwitchboardObject interface. More...

#include <SwitchboardObject.hpp>

Inheritance diagram for switchboard::SwitchboardObject:

Public Member Functions
	SwitchboardObject (const std::string &objectType)
	~SwitchboardObject () override=default
	SwitchboardObject destructor.
virtual Result< void >	setValue (const std::string &key, const std::any &value)
	Sets a value on the object.
virtual Result< std::any >	getValue (const std::string &key)
	Gets a value from the object.
virtual Result< std::any >	callAction (const std::string &actionName, const std::map< std::string, std::any > &params)
	Calls an action on the object.
Public Member Functions inherited from switchboard::EventEmitter
	EventEmitter ()
	Constructor for the EventEmitter class.
virtual	~EventEmitter ()
	Destructor for the EventEmitter class.
unsigned int	addEventListener (const std::string &eventName, EventCallback callback)
	Adds a new event listener to the object.
bool	removeEventListener (unsigned int listenerID)
	Removes an event listener from the object.

Additional Inherited Members
Protected Member Functions inherited from switchboard::EventEmitter
void	emitEvent (const std::string &eventName, const EventData &data)
	Emits an event.

Detailed Description

SwitchboardObject interface.

Member Function Documentation

callAction()

virtual Result< std::any > switchboard::SwitchboardObject::callAction ( const std::string & actionName, const std::map< std::string, std::any > & params )

virtual

Calls an action on the object.

Parameters

actionName	The name of the action.
params	The parameters of the action.

Returns

The result of the action.

Reimplemented in switchboard::AudioNode, switchboard::Engine, and switchboard::Node.

getValue()

virtual Result< std::any > switchboard::SwitchboardObject::getValue ( const std::string & key )

virtual

Gets a value from the object.

Parameters

key	The key of the value.

Returns

The value.

Reimplemented in switchboard::AudioNode, switchboard::Engine, and switchboard::Node.

setValue()

virtual Result< void > switchboard::SwitchboardObject::setValue ( const std::string & key, const std::any & value )

virtual

Sets a value on the object.

Parameters

key	The key of the value.
value	The value to set.

Returns

A successful result if the value was set successfully, an error result otherwise.

Reimplemented in switchboard::AudioNode, switchboard::Engine, and switchboard::Node.

---

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

• SwitchboardObject.hpp