CLAM-Development  1.4.0
Public Member Functions
CLAM::InControlPublisher Class Reference

#include <InControlPublisher.hxx>

List of all members.

Public Member Functions

 InControlPublisher ()
 InControlPublisher (const std::string &name, Processing *father)
void PublishInControl (FloatInControl &in)
void DoControl (const TControlData &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.
const TControlDataGetLastValue () const
 Returns the last received value.
- Public Member Functions inherited from CLAM::InControl< float >
 InControl (const std::string &name="unnamed in control", Processing *proc=0)
 Constructor to use when no callback is used.
 InControl (const std::string &name, ProcessingType *proc, void(ProcessingType::*callback)(const ParameterType &))
 Constructor to use a callback by const reference.
 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.
 InControl (const std::string &name, ProcessingType *proc, void(ProcessingType::*callback)(ParameterType))
 Constructor to use a callback by copy.
 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 ()
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.
- 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< float >
float 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

Definition at line 11 of file InControlPublisher.hxx.


Constructor & Destructor Documentation

CLAM::InControlPublisher::InControlPublisher ( )
inline

Definition at line 16 of file InControlPublisher.hxx.

References NULL.

CLAM::InControlPublisher::InControlPublisher ( const std::string &  name,
Processing father 
)
inline

Definition at line 22 of file InControlPublisher.hxx.

References NULL.


Member Function Documentation

void CLAM::InControlPublisher::DoControl ( const TControlData val)
inlinevirtual

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.

Reimplemented from CLAM::InControl< float >.

Definition at line 32 of file InControlPublisher.hxx.

References CLAM::InControl< ControlDataType >::DoControl().

Referenced by CLAM::SegmentTransformation::ConcreteConfigure(), and CLAM::SegmentTransformation::UpdateControlValueFromBPF().

const TControlData& CLAM::InControlPublisher::GetLastValue ( ) const
inlinevirtual

Returns the last received value.

Reimplemented from CLAM::InControl< float >.

Definition at line 39 of file InControlPublisher.hxx.

References CLAM::InControl< ControlDataType >::GetLastValue(), and CLAM::InControl< float >::mLastValue.

void CLAM::InControlPublisher::PublishInControl ( FloatInControl in)
inline

Definition at line 28 of file InControlPublisher.hxx.


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