RT::IControlTransportHelper Class Reference

Abstract class, provides interface to exchange data between robot and FrontEnd. More...

#include <RobotHelperInterfaces.h>

List of all members.

Classes

struct  node_callback

Public Member Functions

virtual int sendMessage (char *buf, int lenght)=0
virtual int send (RTNodeList *)=0
virtual int send (RTNode *)=0
virtual RTNodeListget_root_output_templates ()=0
virtual RTNodeListget_root_input_templates ()=0
virtual int for_each_output_node (node_callback &cb)=0
virtual int for_each_input_node (node_callback &cb)=0

Detailed Description

Abstract class, provides interface to exchange data between robot and FrontEnd.


Member Function Documentation

virtual int RT::IControlTransportHelper::for_each_input_node ( node_callback cb  )  [pure virtual]

Framework will call node_callback function for each input node (not only for the top level ones)

virtual int RT::IControlTransportHelper::for_each_output_node ( node_callback cb  )  [pure virtual]

Framework will call node_callback function for each output node (not only for the top level ones)

virtual RTNodeList* RT::IControlTransportHelper::get_root_input_templates (  )  [pure virtual]

Input XML messages format templates for instructions from FE to robot (nodes from the top level only)

virtual RTNodeList* RT::IControlTransportHelper::get_root_output_templates (  )  [pure virtual]

Get predefined output XML format templates for reports from robot to FE (nodes from the top level only)

virtual int RT::IControlTransportHelper::send ( RTNode  )  [pure virtual]

Send message to Front End in XML-like format for separate node (if node has children they will be included automatically )

virtual int RT::IControlTransportHelper::send ( RTNodeList  )  [pure virtual]

Send message to Front End in XML-like format for several nodes (if node has children they will be included automatically )

virtual int RT::IControlTransportHelper::sendMessage ( char *  buf,
int  lenght 
) [pure virtual]

Send message to Front End

Parameters:
buf Message data
length Data length

The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Enumerations Enumerator
Generated on Tue Jun 7 15:51:19 2011 for RTAPI by  doxygen 1.6.3