libIntegra
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Types | Public Member Functions | List of all members
integra_api::IControlInfo Class Referenceabstract

Control-specific info about an Endpoint in an Integra Module interface. More...

#include "api/interface_definition.h"

Public Types

enum  control_type { STATEFUL = 1, BANG }
 

Public Member Functions

virtual control_type get_type () const =0
 Get control type. More...
 
virtual const IStateInfoget_state_info () const =0
 Get state info. More...
 
virtual bool get_can_be_source () const =0
 
virtual bool get_can_be_target () const =0
 

Detailed Description

Control-specific info about an Endpoint in an Integra Module interface.

Member Enumeration Documentation

Enumeration of control types

Enumerator
STATEFUL 

Stateful controls represent values (integer, float or string)

BANG 

'Bang' controls are stateless, akin to push-buttons

Member Function Documentation

virtual bool integra_api::IControlInfo::get_can_be_source ( ) const
pure virtual

A few controls are defined as not available to be used as the source for connections and scripts. For example, a connection's source and target paths cannot themselves be source for another (or the same) connection

Returns
true if this control can be a source for connections and an input for scripts, otherwise false
virtual bool integra_api::IControlInfo::get_can_be_target ( ) const
pure virtual

A few controls are defined as not available to be used as the target for connections and scripts. For example, it makes no sense to set AudioIn.vu by a connection or script

Returns
true if this control can be a source for connections and an input for scripts, otherwise false
virtual const IStateInfo* integra_api::IControlInfo::get_state_info ( ) const
pure virtual

Get state info.

See IStateInfo

Returns
an IStateInfo, or NULL if the control is of type 'bang'
virtual control_type integra_api::IControlInfo::get_type ( ) const
pure virtual

Get control type.

See ::control_type


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