CLAM-Development  1.4.0
Public Member Functions
CLAM::TypedInControl< ControlDataType > Class Template Reference

Transition class, use InControl instead. More...

#include <TypedInControl.hxx>

List of all members.

Public Member Functions

 TypedInControl (const std::string &name="unnamed in control", Processing *proc=0)
 Constructor to use when no callback is used.
template<typename ProcessingType , typename ParameterType >
 TypedInControl (const std::string &name, ProcessingType *proc, void(ProcessingType::*callback)(const ParameterType &))
 Constructor to use a callback by const reference.
template<typename ProcessingType , typename ParameterType >
 TypedInControl (unsigned id, const std::string &name, ProcessingType *proc, void(ProcessingType::*callback)(unsigned, const ParameterType &))
 Constructor to use a callback by const reference plus a port id to distinguish different caller controls in a single serving callback.
template<typename ProcessingType , typename ParameterType >
 TypedInControl (const std::string &name, ProcessingType *proc, void(ProcessingType::*callback)(ParameterType))
 Constructor to use a callback by copy.
template<typename ProcessingType , typename ParameterType >
 TypedInControl (unsigned id, const std::string &name, ProcessingType *proc, void(ProcessingType::*callback)(unsigned, ParameterType))
 Constructor to use a callback by copy plus a port id to distinguish different caller controls in a single serving callback.
- Public Member Functions inherited from CLAM::InControl< ControlDataType >
 InControl (const std::string &name="unnamed in control", Processing *proc=0)
 Constructor to use when no callback is used.
template<typename ProcessingType , typename ParameterType >
 InControl (const std::string &name, ProcessingType *proc, void(ProcessingType::*callback)(const ParameterType &))
 Constructor to use a callback by const reference.
template<typename ProcessingType , typename ParameterType >
 InControl (unsigned id, const std::string &name, ProcessingType *proc, void(ProcessingType::*callback)(unsigned, const ParameterType &))
 Constructor to use a callback by const reference plus a port id to distinguish different caller controls in a single serving callback.
template<typename ProcessingType , typename ParameterType >
 InControl (const std::string &name, ProcessingType *proc, void(ProcessingType::*callback)(ParameterType))
 Constructor to use a callback by copy.
template<typename ProcessingType , typename ParameterType >
 InControl (unsigned id, const std::string &name, ProcessingType *proc, void(ProcessingType::*callback)(unsigned, ParameterType))
 Constructor to use a callback by copy plus a port id to distinguish different caller controls in a single serving callback.
virtual ~InControl ()
virtual void DoControl (const ControlDataType &val)
 The control receives a value when this method gets called. Associated callback if any, gets triggered on result. Connected OutControl may trigger it but it also may be called directly, for example to set the initial value.
virtual const ControlDataType & GetLastValue () const
 Returns the last received value.
const std::string GetLastValueAsString ()
 Convenience method to get the string representation of the last value. This just works if the token is storable as XML leaf, if not a "Not printable" string is given.
virtual const std::type_info & GetTypeId () const
 Concrete InControls must overload this method by returning the typeid of the kind of data they communicate.
template<>
const std::string GetLastValueAsString ()
- Public Member Functions inherited from CLAM::InControlBase
bool HasBeenRead () const
 InControlBase (const std::string &name, Processing *processing=0)
 Class constructor.
virtual ~InControlBase ()
 Class destructor.
const std::string & GetName () const
ProcessingGetProcessing () const
bool IsConnected () const
bool IsConnectedTo (OutControlBase &out)
void OutControlInterface_AddLink (OutControlBase &outControl)
 Implementation detail just to be used just from OutControlBase.
void OutControlInterface_RemoveLink (OutControlBase &outControl)
 Implementation detail just to be used just from OutControlBase.
bool IsBounded () const
TControlData UpperBound () const
TControlData LowerBound () const
TControlData DefaultValue () const
 Returns the bounds mean or the value set with SetDefaultValue() if its the case.
void SetDefaultValue (TControlData val)
void SetBounds (TControlData lower, TControlData upper)

Additional Inherited Members

- Protected Attributes inherited from CLAM::InControl< ControlDataType >
ControlDataType mLastValue
- Protected Attributes inherited from CLAM::InControlBase
ProcessingmProcessing
Peers mLinks
 Stores the pointers to the connected outcontrols.
TControlData mDefaultValue
TControlData mUpperBound
TControlData mLowerBound
bool mBounded
bool mHasDefaultValue
bool _hasBeenRead

Detailed Description

template<class ControlDataType>
class CLAM::TypedInControl< ControlDataType >

Transition class, use InControl instead.

Definition at line 12 of file TypedInControl.hxx.


Constructor & Destructor Documentation

template<class ControlDataType >
CLAM::TypedInControl< ControlDataType >::TypedInControl ( const std::string &  name = "unnamed in control",
Processing proc = 0 
)
inline

Constructor to use when no callback is used.

Definition at line 16 of file TypedInControl.hxx.

template<class ControlDataType >
template<typename ProcessingType , typename ParameterType >
CLAM::TypedInControl< ControlDataType >::TypedInControl ( const std::string &  name,
ProcessingType *  proc,
void(ProcessingType::*)(const ParameterType &)  callback 
)
inline

Constructor to use a callback by const reference.

Definition at line 22 of file TypedInControl.hxx.

template<class ControlDataType >
template<typename ProcessingType , typename ParameterType >
CLAM::TypedInControl< ControlDataType >::TypedInControl ( unsigned  id,
const std::string &  name,
ProcessingType *  proc,
void(ProcessingType::*)(unsigned, const ParameterType &)  callback 
)
inline

Constructor to use a callback by const reference plus a port id to distinguish different caller controls in a single serving callback.

Definition at line 28 of file TypedInControl.hxx.

template<class ControlDataType >
template<typename ProcessingType , typename ParameterType >
CLAM::TypedInControl< ControlDataType >::TypedInControl ( const std::string &  name,
ProcessingType *  proc,
void(ProcessingType::*)(ParameterType)  callback 
)
inline

Constructor to use a callback by copy.

Definition at line 34 of file TypedInControl.hxx.

template<class ControlDataType >
template<typename ProcessingType , typename ParameterType >
CLAM::TypedInControl< ControlDataType >::TypedInControl ( unsigned  id,
const std::string &  name,
ProcessingType *  proc,
void(ProcessingType::*)(unsigned, ParameterType)  callback 
)
inline

Constructor to use a callback by copy plus a port id to distinguish different caller controls in a single serving callback.

Definition at line 40 of file TypedInControl.hxx.


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