switchboard::Node Class Reference

Inheritance diagram for switchboard::Node:

Public Member Functions
	Node (const uint numberOfInputs, const uint numberOfOutputs)
	Node constructor.
const std::string &	getType () const
	Gets the type of the node.
unsigned int	getNumberOfInputs () const
	Gets the number of inputs for the node.
unsigned int	getNumberOfOutputs () const
	Gets the number of outputs for the node.
Result< std::any >	getValue (const std::string &key) override
	Gets a value from the object.
Result< void >	setValue (const std::string &key, const std::any &value) override
	Sets a value on the object.
Result< std::any >	callAction (const std::string &actionName, const std::map< std::string, std::any > &params) override
	Calls an action on the object.
Public Member Functions inherited from switchboard::SwitchboardObject
	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.
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.

Public Attributes
std::string	name
	The name of the node.

Protected Attributes
std::string	type
unsigned int	numberOfInputs
unsigned int	numberOfOutputs

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.

Constructor & Destructor Documentation

Node()

switchboard::Node::Node	(	const uint	numberOfInputs,
		const uint	numberOfOutputs )

Node constructor.

Parameters

numberOfInputs	The number of inputs for the node.
numberOfOutputs	The number of outputs for the node.

Member Function Documentation

callAction()

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

overridevirtual

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 from switchboard::SwitchboardObject.

getNumberOfInputs()

unsigned int switchboard::Node::getNumberOfInputs

(

)

const

Gets the number of inputs for the node.

Returns

The number of inputs for the node.

getNumberOfOutputs()

unsigned int switchboard::Node::getNumberOfOutputs

(

)

const

Gets the number of outputs for the node.

Returns

The number of outputs for the node.

getType()

const std::string & switchboard::Node::getType

(

)

const

Gets the type of the node.

Returns

The type of the node.

getValue()

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

overridevirtual

Gets a value from the object.

Parameters

key	The key of the value.

Returns

The value.

Reimplemented from switchboard::SwitchboardObject.

setValue()

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

overridevirtual

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 from switchboard::SwitchboardObject.

---

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

• Node.hpp