integra_api::CCommandSource Class Reference

Represents an enumeration of command sources. More...

#include "api/command_source.h"

Public Types
enum	source {   NONE = -1, INITIALIZATION, LOAD, SYSTEM,   CONNECTION, SCRIPT, MODULE_IMPLEMENTATION, PUBLIC_API }

Public Member Functions
	CCommandSource (source command_source)
	create a CCommandSource from an enumeration constant
	operator source () const
	casting operator, allows direct comparison of CCommandSource and enumeration constants
string	get_text () const

Detailed Description

Represents an enumeration of command sources.

Command Sources represent the different places from which a command can originate. They are passed to integraLive api users via INotificationSink and CPollingNotificationSink. The enumeration is implemented as a class to allow inline stringification where needed

Member Enumeration Documentation

enum integra_api::CCommandSource::source

Command Source enumeration values

Enumerator
INITIALIZATION	Used for initialization of stateful node endpoints
LOAD	Used during execution of a ILoadCommand for creation of nodes and setting values for stateful node endpoints
SYSTEM	Used for all business logic not explicitly covered by any other command source
CONNECTION	Used by business logic for connections
SCRIPT	Used by business logic for scripts
MODULE_IMPLEMENTATION	Used when control endpoints are accessed by dsp module implementations (eg vu meters, analysis modules etc)
PUBLIC_API	Used when libIntegra's state is altered through libIntegra's api

Member Function Documentation

string integra_api::CCommandSource::get_text

(

)

const

to string

Returns

a string representation of the command source

---

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

• /Users/jamie/Documents/IntegraLive/libIntegra/api/command_source.h