CLAM::OutControl Class Reference
#include <OutControl.hxx>
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.
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 &) |
| Processing * | GetProcessing () const |
Constructor & Destructor Documentation
| CLAM::OutControl::~OutControl | ( | ) | [virtual] |
Definition at line 36 of file OutControl.cxx.
References CLAM::Processing::GetOutControls(), CLAM::OutControlRegistry::ProcessingInterface_Unregister(), and RemoveLink().
| 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:
-
publish This flag (true by default) concerns the publication of the control pointer at the base processing object. parent Optional. 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] |
Reimplemented in CLAM::OutControlPublisher.
Definition at line 58 of file OutControl.cxx.
References CLAM::InControl::OutControlInterface_AddLink().
Referenced by CLAM::OutControlPublisher::AddLink(), CLAM::Dispatcher::ConcreteConfigure(), CLAM::ConnectControls(), CLAM::FlattenedNetwork::ConnectControls(), CLAM::Instrument::LinkStateOutWithInControl(), and CLAM::SendFloatToInControl().
| void CLAM::OutControl::RemoveLink | ( | InControl & | in | ) |
Definition at line 63 of file OutControl.cxx.
References CLAM::InControl::OutControlInterface_RemoveLink().
Referenced by CLAM::FlattenedNetwork::DisconnectControls(), and ~OutControl().
| std::list< InControl * >::iterator CLAM::OutControl::BeginInControlsConnected | ( | ) |
Definition at line 46 of file OutControl.cxx.
Referenced by CLAM::FlattenedNetwork::GetInControlsConnectedTo().
| std::list< InControl * >::iterator CLAM::OutControl::EndInControlsConnected | ( | ) |
Definition at line 51 of file OutControl.cxx.
Referenced by CLAM::FlattenedNetwork::GetInControlsConnectedTo().
| int CLAM::OutControl::SendControl | ( | TControlData | val | ) |
Definition at line 68 of file OutControl.cxx.
Referenced by CLAM::Normalization::ComputeScaleFactorFromAvgEnergy(), CLAM::Normalization::ComputeScaleFactorFromDominantEnergy(), CLAM::Normalization::ComputeScaleFactorFromMaxEnergy(), CLAM::AudioFileMemoryLoader::ConcreteConfigure(), CLAM::AudioFileMemoryLoader::ConcreteStart(), CLAM::OutControlSender::Do(), CLAM::MultiChannelAudioFileReader::Do(), CLAM::MonoAudioFileReader::Do(), CLAM::MIDIKeyboard::Do(), CLAM::FundFreqDetect::Do(), CLAM::Fundamental2Control::Do(), CLAM::Fund2MIDI::Do(), CLAM::FlagControl::Do(), CLAM::ControlSource::Do(), CLAM::ControlScaler::Do(), CLAM::BinaryControlOp< BinOp >::Do(), CLAM::AutoPanner::Do(), CLAM::AudioFileMemoryLoader::Do(), CLAM::ControlMapper::DoMap(), CLAM::OutControlSender::SendControl(), SendControlAsBoolean(), SendControlAsInteger(), CLAM::SendFloatToInControl(), CLAM::SendFloatToOutControl(), CLAM::Instrument::UpdateNote(), CLAM::Instrument::UpdateState(), CLAM::ADSR::UpdateState(), and CLAM::Instrument::UpdateVel().
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().
| const std::string& CLAM::OutControl::GetName | ( | void | ) | const [inline] |
Definition at line 102 of file OutControl.hxx.
| bool CLAM::OutControl::IsConnected | ( | ) |
Definition at line 80 of file OutControl.cxx.
Definition at line 85 of file OutControl.cxx.
Referenced by CLAM::FlattenedNetwork::ConnectControls(), CLAM::FlattenedNetwork::DisconnectControls(), and CLAM::InControl::IsConnectedTo().
| Processing* CLAM::OutControl::GetProcessing | ( | ) | const [inline] |
Definition at line 105 of file OutControl.hxx.
The documentation for this class was generated from the following files:
