switchboard::Node Class Reference

Inheritance diagram for switchboard::Node:

Public Member Functions
	Node (uint numberOfInputs, uint numberOfOutputs)
	Node constructor.
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< SBAny >	getValue (const std::string &key) override
	Gets a value from the object.
Result< SBAny >	callAction (const std::string &actionName, const SBAnyMap &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	getURI ()
	Gets the URI of the object.
std::string	getObjectType () const
	Gets the type of the object.
std::optional< std::string >	getObjectSubtype () const
	Gets the subtype of the object.
void	setObjectSubtype (std::optional< std::string > subtype)
	Sets the subtype 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 SBAny &value)
	Sets a value on the object.
void	registerConfiguration (const std::string &key, const SBAnyMap &schema, const SBAny &value)
	Registers a configuration for the object using a static schema and an instance value.
void	setConfigurationValue (const std::string &key, const SBAny &value)
	Sets a configuration value for the object.
void	registerProperty (const std::string &key, const SBAnyMap &schema, const SBAny &getter=SBAny(), const SBAny &setter=SBAny())
	Registers a property for the object.
void	registerAction (const std::string &key, const SBAnyMap &schema, ActionHandler handler={})
	Registers an action for the object.
void	registerEvent (const std::string &eventName, const SBAnyMap &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.

Protected Attributes
unsigned int	numberOfInputs
	The number of inputs (audio buses) for the node.
unsigned int	numberOfOutputs
	The number of outputs (audio buses) for the node.
std::string	title
	The title of the node that can be displayed in the UI.

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

Constructor & Destructor Documentation

Node()

switchboard::Node::Node	(	uint	numberOfInputs,
		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< SBAny > switchboard::Node::callAction ( const std::string & actionName, const SBAnyMap & 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()

std::string switchboard::Node::getType

(

)

const

Gets the type of the node.

Equivalent to SwitchboardObject::getObjectSubtype(); returns the fully-qualified node type (e.g. "Switchboard.Gain"), or an empty string if no subtype is set.

Returns

The type of the node.

getValue()

Result< SBAny > 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.

---

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

• Node.hpp