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

Represents a node endpoint. More...

#include "api/node_endpoint.h"

Public Member Functions

virtual const INodeget_node () const =0
 Get backreference to the node endpoint's owning node.
 
virtual const IEndpointDefinitionget_endpoint_definition () const =0
 Get reference to the node endpoint's definition.
 
virtual const CValueget_value () const =0
 Get pointer to the node endpoint's current value. More...
 
virtual const CPathget_path () const =0
 Get node endpoint's path. More...
 

Detailed Description

Represents a node endpoint.

Endpoints are the controls and stream i/o of Integra Modules.

INodeEndpoint provides methods to query the endpoints of nodes (Module Instances)

Member Function Documentation

virtual const CPath& integra_api::INodeEndpoint::get_path ( ) const
pure virtual

Get node endpoint's path.

The node endpoint's path consists of the owning node's path, with the node endpoint's name (from the endpoint definition ) appended to it.

virtual const CValue* integra_api::INodeEndpoint::get_value ( ) const
pure virtual

Get pointer to the node endpoint's current value.

Returns
If the node endpoint is a stateful control, returns current state. Otherwise (stream or bang control) returns NULL.

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