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

Command to set 'control' type node endpoints. More...

#include "api/command.h"

Inheritance diagram for integra_api::ISetCommand:
Inheritance graph
[legend]
Collaboration diagram for integra_api::ISetCommand:
Collaboration graph
[legend]

Public Member Functions

virtual const CPathget_endpoint_path () const =0
 
- Public Member Functions inherited from integra_api::ICommand
virtual CError execute (integra_internal::CServer &server, CCommandSource source, CCommandResult *result)=0
 Internal use only.
 

Static Public Member Functions

static ISetCommandcreate (const CPath &endpoint_path, const CValue &value)
 Create an instance of ISetCommand Use this one to set the value of a stateful control endpoint. More...
 
static ISetCommandcreate (const CPath &endpoint_path)
 Create an instance of ISetCommand Use this one to send a bang to a stateless control endpoint. More...
 

Detailed Description

Command to set 'control' type node endpoints.

Member Function Documentation

static ISetCommand* integra_api::ISetCommand::create ( const CPath endpoint_path,
const CValue value 
)
static

Create an instance of ISetCommand Use this one to set the value of a stateful control endpoint.

Parameters
endpoint_paththe node endpoint to set
valuethe new value
Returns
a pointer to the command, created on the heap.
static ISetCommand* integra_api::ISetCommand::create ( const CPath endpoint_path)
static

Create an instance of ISetCommand Use this one to send a bang to a stateless control endpoint.

Parameters
endpoint_paththe node endpoint to bang
Returns
a pointer to the command, created on the heap.

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