vrecko
virtual reality framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vrecko::RequestInputPin< _MessageType, _ReturningMessageType > Class Template Reference

#include <IOPins.h>

Inheritance diagram for vrecko::RequestInputPin< _MessageType, _ReturningMessageType >:
vrecko::RequestInputPinBase vrecko::IORequestPinBase vrecko::IOPinBase

Public Types

typedef osg::ref_ptr
< _ReturningMessageType >
(BaseClass::* 		PROCESSING_METHOD )(_MessageType *message)
 

Public Member Functions

 RequestInputPin (BaseClass *_owner, const char *_requestInputName, PROCESSING_METHOD _methodForProcessing)
 
 ~RequestInputPin ()
 
virtual VreckoMessage * createCompatibleMessage ()
 Creates an instance of a message type that is recognized by this input/output. More...
 
virtual VreckoMessage * createReturningCompatibleMessage ()
 Same as IOPinBase::createCompatibleMessage() but for the returning message type. More...
 
virtual osg::ref_ptr
< VreckoMessage > 		processRequest (VreckoMessage *message)
 Method that is called when actual request is received. More...
 

Protected Member Functions

void coreInit (BaseClass *_owner, const char *_requestInputName, PROCESSING_METHOD _methodForProcessing)
 

Protected Attributes

PROCESSING_METHOD methodForProcessing
 

Member Typedef Documentation

template<class _MessageType , class _ReturningMessageType >
typedef osg::ref_ptr<_ReturningMessageType>(BaseClass::* vrecko::RequestInputPin< _MessageType, _ReturningMessageType >::PROCESSING_METHOD)(_MessageType *message)

Constructor & Destructor Documentation

template<class _MessageType , class _ReturningMessageType >
vrecko::RequestInputPin< _MessageType, _ReturningMessageType >::RequestInputPin ( BaseClass *  _owner,
const char *  _requestInputName,
PROCESSING_METHOD  _methodForProcessing 
)
inline
template<class _MessageType , class _ReturningMessageType >
vrecko::RequestInputPin< _MessageType, _ReturningMessageType >::~RequestInputPin ( )
inline

Member Function Documentation

template<class _MessageType , class _ReturningMessageType >
void vrecko::RequestInputPin< _MessageType, _ReturningMessageType >::coreInit ( BaseClass *  _owner,
const char *  _requestInputName,
PROCESSING_METHOD  _methodForProcessing 
)
inlineprotected
template<class _MessageType , class _ReturningMessageType >
virtual VreckoMessage* vrecko::RequestInputPin< _MessageType, _ReturningMessageType >::createCompatibleMessage ( )
inlinevirtual

Creates an instance of a message type that is recognized by this input/output.

If you will create a new descendant class of type XY, this method will generally be:

virtual VreckoMessage* createCompatibleMessage() { return new XY; };

Returns
(VreckoMessage*)

Implements vrecko::IOPinBase.

template<class _MessageType , class _ReturningMessageType >
virtual VreckoMessage* vrecko::RequestInputPin< _MessageType, _ReturningMessageType >::createReturningCompatibleMessage ( )
inlinevirtual

Same as IOPinBase::createCompatibleMessage() but for the returning message type.

Returns
(VreckoMessage*)

Implements vrecko::IORequestPinBase.

template<class _MessageType , class _ReturningMessageType >
virtual osg::ref_ptr<VreckoMessage> vrecko::RequestInputPin< _MessageType, _ReturningMessageType >::processRequest ( VreckoMessage *  message)
inlinevirtual

Method that is called when actual request is received.

Parameters
message(VreckoMessage *)
Returns
(osg::ref_ptr<VreckoMessage>)

Implements vrecko::RequestInputPinBase.

Member Data Documentation

template<class _MessageType , class _ReturningMessageType >
PROCESSING_METHOD vrecko::RequestInputPin< _MessageType, _ReturningMessageType >::methodForProcessing
protected
The documentation for this class was generated from the following file: