classPdComm.html

Main Page | Namespace List | Class Hierarchy | Class List | File List | Class Members

PdComm Class Reference

The Pd communications class. More...

#include <PdComm.h>

List of all members.


Signals

int dataEvent (int)
 The signal to inform a GUI element of a data change.

Public Member Functions

 PdComm ()
 Default Constructor.
 ~PdComm ()
 Default Destructor.
int loadPatch (XmlRpc::XmlRpcValue *)
 The patch loader.
int setValue (const char *, XmlRpc::XmlRpcValue *)
 Set a value of a certain Pd symbol (integer).
int getValue (const char *, XmlRpc::XmlRpcValue *)
 Get a value of a certain Pd symbol.
int bindSymbol (const char *)
 Bind a symbol for polling.
int unbindSymbol (const char *)
 Unbind the symbol.
bool isConnected ()
 Check whether Pd is connected.

Detailed Description

The Pd communications class.

This class provides static methods for exchanging information with the running Pd programme. It implements the XML-RPC interface defined in the SRS.

Constructor & Destructor Documentation

PdComm::PdComm (   ) 
 

Default Constructor.

Default Constructor checks for environment variables to get the host/port defaults to localhost:8888

PdComm::~PdComm (   ) 
 

Default Destructor.

Default Destructor

Member Function Documentation

int PdComm::bindSymbol (  const char *  symbol  ) 
 

Bind a symbol for polling.

Bind a symbol for polling

Parameters:
symbol The name of the symbol to bind

int PdComm::getValue (  const char *  symbol,
XmlRpc::XmlRpcValue *  value
) 
 

Get a value of a certain Pd symbol.

Get a value of a certain Pd symbol

Parameters:
symbol The binding of the symbol to be queried
value A reference of to a value into which the result is written
Returns:
0 if error, 1 if everything went fine

bool PdComm::isConnected (   ) 
 

Check whether Pd is connected.

Check whether Pd is reachable over XmlRpc and which methods are available

int PdComm::loadPatch (  XmlRpc::XmlRpcValue *  patch  ) 
 

The patch loader.

The patch loader method.

Parameters:
A character string representing the patch as plain text.
Returns:
0 for error, any other indicates success

int PdComm::setValue (  const char *  symbol,
XmlRpc::XmlRpcValue *  value
) 
 

Set a value of a certain Pd symbol (integer).

Set a value of a certain Pd symbol

Parameters:
symbol The binding of the symbol to send to
value The value to be sent
Returns:
0 if error, 1 if everything went fine

int PdComm::unbindSymbol (  const char *  symbol  ) 
 

Unbind the symbol.

Unbind the symbol

Parameters:
symbol The name of the symbol to unbind
The documentation for this class was generated from the following files:
Generated on Thu Nov 25 15:57:07 2004 for iARS(internetAudioRenderingSystem) by  doxygen 1.3.9.1