CLAM::InControlBase Class Reference

Base class for an inwards control connector. More...

#include <InControlBase.hxx>

Public Member Functions
bool	HasBeenRead () const
	InControlBase (const std::string &name, Processing *processing=0)
	Class constructor.
virtual	~InControlBase ()
	Class destructor.
virtual const std::type_info &	GetTypeId () const =0
	Concrete InControls must overload this method by returning the typeid of the kind of data they communicate.
const std::string &	GetName () const
Processing *	GetProcessing () 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.
virtual const std::string	GetLastValueAsString ()
Float specific services
Todo: move them to the concrete float class
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)
Protected Types
typedef std::list < OutControlBase * >	Peers
Protected Attributes
Processing *	mProcessing
Peers	mLinks
	Stores the pointers to the connected outcontrols.
TControlData	mDefaultValue
TControlData	mUpperBound
TControlData	mLowerBound
bool	mBounded
bool	mHasDefaultValue
bool	_hasBeenRead

Detailed Description

Base class for an inwards control connector.

InControls can be used to receive asynchronous data from connected OutControls in other processings.

See also:: OutControlBase AddingControlsToProcessings Processing

Todo:: Remove the float services

Definition at line 22 of file InControlBase.hxx.

Member Typedef Documentation

typedef std::list<OutControlBase*> CLAM::InControlBase::Peers [protected]

Definition at line 27 of file InControlBase.hxx.

Constructor & Destructor Documentation

CLAM::InControlBase::InControlBase	(	const std::string &	name,
		Processing *	processing = `0`
	)

Class constructor.

Parameters:

	name	Unique name of the control within the processing.
	processing	Host processing (0 for a free control).

Definition at line 6 of file InControlBase.cxx.

References CLAM::Processing::RegisterInControl().

CLAM::InControlBase::~InControlBase ( ) [virtual]

Class destructor.

Destruction clears any connection left and unregisters the control from the processing. Whatever it gets destructed first (In or Out) links are properly unset.

Definition at line 18 of file InControlBase.cxx.

References CLAM::Processing::GetInControls(), mLinks, mProcessing, and CLAM::InControlRegistry::ProcessingInterface_Unregister().

Member Function Documentation

float CLAM::InControlBase::DefaultValue ( ) const

Returns the bounds mean or the value set with SetDefaultValue() if its the case.

Definition at line 53 of file InControlBase.cxx.

References mDefaultValue, mHasDefaultValue, mLowerBound, and mUpperBound.

virtual const std::string CLAM::InControlBase::GetLastValueAsString ( ) [inline, virtual]

Reimplemented in CLAM::InControl< ControlDataType >, CLAM::InControl< float >, CLAM::InControl< MIDI::Message >, and CLAM::InControl< ControlDataType >.

Definition at line 95 of file InControlBase.hxx.

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

Returns:: The unique name that the control takes within the processing.

Definition at line 64 of file InControlBase.hxx.

Processing* CLAM::InControlBase::GetProcessing ( ) const [inline]

Returns:: The hosting processing

Definition at line 66 of file InControlBase.hxx.

References mProcessing.

virtual const std::type_info& CLAM::InControlBase::GetTypeId ( ) const [pure virtual]

Concrete InControls must overload this method by returning the typeid of the kind of data they communicate.

This method is used internanlly in order to assure type compatibility between an input an an output control. There are some other uses like the NetworkEditor assigning different colors to connectors depending on this type.