CLAM-Development  1.1
Public Member Functions
CLAM::OutControl Class Reference

Processing out control class. More...

#include <OutControl.hxx>

List of all members.

Public Member Functions

virtual ~OutControl ()
 OutControl (const std::string &name, Processing *parent=0, const bool publish=true)
 Constructor of the OutControl.
virtual void AddLink (InControl &in)
void RemoveLink (InControl &in)
std::list< InControl * >::iterator BeginInControlsConnected ()
std::list< InControl * >::iterator EndInControlsConnected ()
int SendControl (TControlData val)
int SendControlAsBoolean (bool booleanValue)
 Sends a 0.0 or 1.0 float control depending on the parameter.
int SendControlAsInteger (int intvalue)
 Sends the given int value as a control (float)
const std::string & GetName (void) const
bool IsConnected ()
bool IsConnectedTo (InControl &)
ProcessingGetProcessing () const

Detailed Description

Processing out control class.

Controls are limited to emmit and receive TControlData (float) numbers. Though extensible typed connections are future planned development:

See also:
TypedOutControl

Definition at line 45 of file OutControl.hxx.


Constructor & Destructor Documentation

CLAM::OutControl::OutControl ( const std::string &  name,
Processing parent = 0,
const bool  publish = true 
)

Constructor of the OutControl.

Warning:
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 meaningfull . For avoiding this case we recommend using the flag publish=false. And invoque the PublishInControl method of the processing object, once the copy is made.
Parameters:
publishThis flag (true by default) concerns the publication of the control pointer at the base processing object.
parentOptional. The processing object that owns the control object. The one where to publish the control if it is the case (publish flag set)
Todo:
improve construction mechanism (params set)

Definition at line 30 of file OutControl.cxx.

References CLAM::Processing::RegisterOutControl().


Member Function Documentation

void CLAM::OutControl::AddLink ( InControl in) [virtual]

Definition at line 46 of file OutControl.cxx.

Referenced by CLAM::FlattenedNetwork::GetInControlsConnectedTo().

Definition at line 51 of file OutControl.cxx.

Referenced by CLAM::FlattenedNetwork::GetInControlsConnectedTo().

const std::string& CLAM::OutControl::GetName ( void  ) const [inline]

Definition at line 102 of file OutControl.hxx.

Definition at line 105 of file OutControl.hxx.

Definition at line 80 of file OutControl.cxx.

int CLAM::OutControl::SendControlAsBoolean ( bool  booleanValue) [inline]

Sends a 0.0 or 1.0 float control depending on the parameter.

To be used in conjunction with InControl::GetLastValueAsBoolean

Definition at line 87 of file OutControl.hxx.

References SendControl().

Sends the given int value as a control (float)

To be used in conjunction with InControl::GetLastValueAsBoolean

Definition at line 97 of file OutControl.hxx.

References SendControl().


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