OSCDocumentor Class Reference

Reply to a documentation request. More...

#include <OSCDocumenter.h>

Inheritance diagram for OSCDocumentor:

[legend]Collaboration diagram for OSCDocumentor:[legend]List of all members.

Public Member Functions
void	setNamespace (OSCNamespace *space)
void	call (const std::string &data, Transmit *const replier)
	Send documentation string using replier.
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 Member Functions
OSCNamespace *	getNamespace ()
Protected Attributes
std::string	myDocumentation
std::string	myTypeSignature

---

Detailed Description

Reply to a documentation request.

Sends a documentation reply with the docstring of the queried object to the requester of the documentation.

---

Member Function Documentation

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

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

---

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

• OSCDocumenter.h

---