switchboard::SwitchboardObject Class Reference

SwitchboardObject interface. More...

#include <SwitchboardObject.hpp>

Inheritance diagram for switchboard::SwitchboardObject:

Public Member Functions
	SwitchboardObject (const std::string &objectType)
	SwitchboardObject constructor.
	~SwitchboardObject () override
	SwitchboardObject destructor.
std::string	getObjectID () const
	Gets the ID of the object.
void	setObjectID (const std::string &objectID)
	Sets the ID of the object.
std::string	getObjectType () const
	Gets the type of the object.
SwitchboardObject *	getParentObject () const
	Gets the parent object of the object.
void	setParentObject (SwitchboardObject *parentObject)
	Sets the parent object of the object.
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.
void	registerConfiguration (const std::string &key, const std::map< std::string, std::any > &configuration)
	Registers a configuration for the object.
void	setConfigurationValue (const std::string &key, const std::any &value)
	Sets a configuration value for the object.
void	registerProperty (const std::string &key, const std::map< std::string, std::any > &propertyInfo)
	Registers a property for the object.
void	registerAction (const std::string &key, const std::map< std::string, std::any > &actionInfo)
	Registers an action for the object.
void	registerEvent (const std::string &eventName, const std::map< std::string, std::any > &eventInfo)
	Registers an event for 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, Callback callback)
	Adds a new event listener to the object.
bool	removeEventListener (unsigned int listenerID)
	Removes an event listener from the object.

Additional Inherited Members
Public Types inherited from switchboard::EventEmitter
using	Callback = std::function<void(const std::string&, const std::any&)>
Protected Member Functions inherited from switchboard::EventEmitter
void	emitEvent (const std::string &eventName, const std::any &data)
	Emits an event.

Detailed Description

SwitchboardObject interface.

Constructor & Destructor Documentation

SwitchboardObject()

switchboard::SwitchboardObject::SwitchboardObject ( const std::string & objectType )

explicit

SwitchboardObject constructor.

Parameters

objectType

The type of the object.

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.

getObjectID()

std::string switchboard::SwitchboardObject::getObjectID

(

)

const

Gets the ID of the object.

Returns

The ID of the object.

getObjectType()

std::string switchboard::SwitchboardObject::getObjectType

(

)

const

Gets the type of the object.

Returns

The type of the object.

getParentObject()

SwitchboardObject * switchboard::SwitchboardObject::getParentObject

(

)

const

Gets the parent object of the object.

Returns

The parent object of the object.

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.

registerAction()

void switchboard::SwitchboardObject::registerAction	(	const std::string &	key,
		const std::map< std::string, std::any > &	actionInfo )

Registers an action for the object.

Parameters

key	The key of the action.
actionInfo	The information about the action.

registerConfiguration()

void switchboard::SwitchboardObject::registerConfiguration	(	const std::string &	key,
		const std::map< std::string, std::any > &	configuration )

Registers a configuration for the object.

Parameters

key	The key of the configuration.
configuration	The configuration to register.

registerEvent()

void switchboard::SwitchboardObject::registerEvent	(	const std::string &	eventName,
		const std::map< std::string, std::any > &	eventInfo )

Registers an event for the object.

Parameters

eventName	The name of the event.
eventInfo	The information about the event.

registerProperty()

void switchboard::SwitchboardObject::registerProperty	(	const std::string &	key,
		const std::map< std::string, std::any > &	propertyInfo )

Registers a property for the object.

Parameters

key	The key of the property.
propertyInfo	The information about the property.

setConfigurationValue()

void switchboard::SwitchboardObject::setConfigurationValue	(	const std::string &	key,
		const std::any &	value )

Sets a configuration value for the object.

Parameters

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

setObjectID()

void switchboard::SwitchboardObject::setObjectID

(

const std::string &

objectID

)

Sets the ID of the object.

Parameters

objectID

The ID to set.

setParentObject()

void switchboard::SwitchboardObject::setParentObject

(

SwitchboardObject *

parentObject

)

Sets the parent object of the object.

Parameters

parentObject

The parent object to set.

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