Main Page | Class Hierarchy | Class List | File List | Class Members | File Members | Related Pages | Examples

WOscReceiverMethod Class Reference

#include <WOscReceiverMethod.h>

Inherits WOscMethod.

List of all members.

Public Member Functions

 WOscReceiverMethod (WOscContainer *parent, WOscReceiver *context, const char *methodName, const char *methodDescription)
 WOscReceiverMethod (WOscContainer *parent, WOscReceiver *context, const char *methodName, WOscMethodInfo *info)

Protected Member Functions

virtual ~WOscReceiverMethod ()
WOscReceiver * GetContext ()

Detailed Description

Adds functionality to WOscMethod necessary for use in WOscReceiver. This happens by handling the internal context pointer in a type-save way by providing constructors and functions.
Examples:

WOscClient.cpp, and WOscServer.cpp.

Definition at line 53 of file WOscReceiverMethod.h.

Constructor & Destructor Documentation

WOscReceiverMethod::WOscReceiverMethod (  WOscContainer *  parent,
WOscReceiver *  context,
const char *  methodName,
const char *  methodDescription
)  [inline]
 

Constructor of an OSC receiver method.

Parameters:
parent Pointer to parent container.
context Pointer to the receiver owning this method. The context can be used later in receiver methods (i.e. for accessing OSC receiver functionality inside OSC methods).
methodName Address pattern (e.g. "echo").
methodDescription Description of this method.

Definition at line 68 of file WOscReceiverMethod.h.

00069                                                                    :
00070         WOscMethod(parent, methodName, new WOscMethodInfo(methodDescription)),
00071         m_context(context)
00072     { }
    /** As the other constructor but the user can set a proprietary method

WOscReceiverMethod::WOscReceiverMethod (  WOscContainer *  parent,
WOscReceiver *  context,
const char *  methodName,
WOscMethodInfo *  info
)  [inline]
 

As the other constructor but the user can set a proprietary method info.

Parameters:
info Proprietary info. Note that this object will be deallocated by the method itself.

Definition at line 79 of file WOscReceiverMethod.h.

00080                                                           :
00081         WOscMethod(parent, methodName, info), m_context(context)
00082     { }

virtual WOscReceiverMethod::~WOscReceiverMethod (   )  [inline, protected, virtual]
 

Destructor.

Definition at line 86 of file WOscReceiverMethod.h.

00086 { }

Member Function Documentation

WOscReceiver* WOscReceiverMethod::GetContext (   )  [inline, protected]
 

Returns a pointer to the OSC receiver owning this method. Casts the internal context-pointer to OSC receiver.

Returns:
The receiver context of the OSC method.
Examples:
WOscClient.cpp, and WOscServer.cpp.

Definition at line 92 of file WOscReceiverMethod.h.

00092 { return m_context; }

The documentation for this class was generated from the following file:
Generated on Sun Nov 1 23:31:19 2009 for WOscLib by  doxygen 1.4.1