CLAM-Development  1.1
Public Types | Public Member Functions
CLAM::InControlTmpl< ProcObj > Class Template Reference

Subclass of InControl that provides the incontrol with a callback method The method must be defined inside the parent Processing class. More...

#include <InControl.hxx>

List of all members.

Public Types

typedef int(ProcObj::* TPtrMemberFunc )(TControlData)
typedef int(ProcObj::* TPtrMemberFuncId )(int, TControlData)

Public Member Functions

int DoControl (TControlData val)
 Stores the incoming control value.
bool ExistMemberFunc ()
void SetMemberFunc (TPtrMemberFunc f)
int GetId (void) const
 InControlTmpl (const std::string &name, ProcObj *parent, TPtrMemberFunc f=0, const bool publish=true)
 Constructor of the InControlTmpl with a member-service-function associated.
 InControlTmpl (int id, const std::string &name, ProcObj *parent, TPtrMemberFuncId f, const bool publish=true)
 ~InControlTmpl ()

Detailed Description

template<class ProcObj>
class CLAM::InControlTmpl< ProcObj >

Subclass of InControl that provides the incontrol with a callback method The method must be defined inside the parent Processing class.

See the InControlTmpl constructors for learn how to provide the callback to the InControlTmpl

Definition at line 109 of file InControl.hxx.


Member Typedef Documentation

template<class ProcObj>
typedef int(ProcObj::* CLAM::InControlTmpl< ProcObj >::TPtrMemberFunc)(TControlData)

Definition at line 112 of file InControl.hxx.

template<class ProcObj>
typedef int(ProcObj::* CLAM::InControlTmpl< ProcObj >::TPtrMemberFuncId)(int, TControlData)

Definition at line 113 of file InControl.hxx.


Constructor & Destructor Documentation

template<class ProcObj>
CLAM::InControlTmpl< ProcObj >::InControlTmpl ( const std::string &  name,
ProcObj *  parent,
TPtrMemberFunc  f = 0,
const bool  publish = true 
) [inline]

Constructor of the InControlTmpl with a member-service-function associated.

Parameters:
publishThis flag (true by default) concerns the publication of the control pointer at the base processing object. Important: notice that if the out control object is going to suffer a copy (i.e.creating controls that will be copied inside an STL container) the original pointer published will be no longer . For avoiding this case we recommend using the flag publish=true. And invoke the PublishInControl method of the processing object, once the copy is made.
fThe member function that will act as a service funtion each time the DoControl method is invoqued. The processing object that owns the control object. The one where to publish the control if it is the case (publish flag set)

Definition at line 146 of file InControl.hxx.

template<class ProcObj>
CLAM::InControlTmpl< ProcObj >::InControlTmpl ( int  id,
const std::string &  name,
ProcObj *  parent,
TPtrMemberFuncId  f,
const bool  publish = true 
) [inline]

Definition at line 156 of file InControl.hxx.

template<class ProcObj>
CLAM::InControlTmpl< ProcObj >::~InControlTmpl ( ) [inline]

Definition at line 166 of file InControl.hxx.


Member Function Documentation

template<class ProcObj >
int CLAM::InControlTmpl< ProcObj >::DoControl ( TControlData  val) [virtual]
template<class ProcObj>
bool CLAM::InControlTmpl< ProcObj >::ExistMemberFunc ( ) [inline]

Definition at line 125 of file InControl.hxx.

template<class ProcObj>
int CLAM::InControlTmpl< ProcObj >::GetId ( void  ) const [inline]

Definition at line 128 of file InControl.hxx.

template<class ProcObj>
void CLAM::InControlTmpl< ProcObj >::SetMemberFunc ( TPtrMemberFunc  f) [inline]

Definition at line 126 of file InControl.hxx.


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