OSCCallable Class Reference

The superclass of all objects which reside in the OSCNamespace. More...

#include <OSCCallable.h>

Inheritance diagram for OSCCallable:

[legend]List of all members.

Public Member Functions
virtual void	call (const std::string &data, Transmit *const reply)=0
	Process data, then use reply to send a response.
virtual std::string	getDocumentation ()
virtual void	setDocumentation (std::string documentation)
virtual std::string	getTypeSignature ()
virtual void	setTypeSignature (std::string typeSignature)
virtual std::string	getName ()
Protected Attributes
std::string	myDocumentation
std::string	myTypeSignature

---

Detailed Description

The superclass of all objects which reside in the OSCNamespace.

OSCCallable objects process OSC messages. For example, the simple OSCCallable OSCPrintCallable simply prints data sent to it. More complex OSCCallables might command sound synthesis.

This class should be extended whenever you wish to do something new with OSC messages.

All OSCCallable objects have a type signature that represents the kinds of arguments that the OSCCallable expects, and a documentation string that describes what the OSCCallable does. These tell users of the server how to use the objects in the OSCNamespace.

The transmit object is available so your callable can send a message in reply to the message it's just received. Its creator manages it, so if your callable must reply again *after* return it must clone Transmit*.

Author:

Daniel Holth

Clinton McChesney

Martin Rumori

---

Member Function Documentation

std::string OSCCallable::getName (   )  [virtual]

Returns: a string which identifies this object (incl. type).

---

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

• OSCCallable.h
• OSCCallable.cc

---