CLAM-Development
1.1
|
Processing in control class. More...
#include <InControl.hxx>
Public Member Functions | |
virtual int | DoControl (TControlData val) |
Stores the incoming control value. | |
const TControlData & | GetLastValue () const |
Returns the last TControlData (float) received event. | |
bool | GetLastValueAsBoolean () const |
Returns the last TControlData (float) received interpreted as a bool. | |
int | GetLastValueAsInteger () const |
Returns the last TControlData (float) received interpireted as an integer. | |
const std::string & | GetName () const |
bool | IsConnectedTo (OutControl &) |
bool | IsConnected () const |
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) |
Processing * | GetProcessing () const |
void | OutControlInterface_AddLink (OutControl &outControl) |
Implementation detail just to be used from OutControl. | |
void | OutControlInterface_RemoveLink (OutControl &outControl) |
Implementation detail just to be used from OutControl. | |
InControl (const std::string &name, Processing *parent=0, const bool publish=true) | |
virtual | ~InControl () |
Protected Attributes | |
std::list< OutControl * > | mLinks |
TControlData | mLastValue |
std::string | mName |
Processing * | mParent |
TControlData | mDefaultValue |
TControlData | mUpperBound |
TControlData | mLowerBound |
bool | mBounded |
bool | mHasDefaultValue |
Processing in control class.
Controls are limited to emmit and receive TControlData (float) numbers. Though extensible typed connections are future planned development:
Definition at line 44 of file InControl.hxx.
CLAM::InControl::InControl | ( | const std::string & | name, |
Processing * | parent = 0 , |
||
const bool | publish = true |
||
) |
parent
Optional. If present, is the processing where to be published.
Definition at line 29 of file InControl.cxx.
References CLAM::Processing::RegisterInControl().
CLAM::InControl::~InControl | ( | ) | [virtual] |
Definition at line 43 of file InControl.cxx.
References CLAM::Processing::GetInControls(), mLinks, mParent, and CLAM::InControlRegistry::ProcessingInterface_Unregister().
TControlData CLAM::InControl::DefaultValue | ( | ) | const |
Returns the bounds mean or the value set with SetDefaultValue() if its the case.
Definition at line 85 of file InControl.cxx.
References mDefaultValue, mHasDefaultValue, mLowerBound, and mUpperBound.
virtual int CLAM::InControl::DoControl | ( | TControlData | val | ) | [inline, virtual] |
Stores the incoming control value.
It can be retrieved using GetLastValue
Reimplemented in CLAM::InControlTmpl< ProcObj >, CLAM::InControlTmpl< FDFilterGen >, CLAM::InControlTmpl< SMSSineFilter >, CLAM::InControlTmpl< SpectralPeakArrayInterpolator >, CLAM::InControlTmpl< Instrument >, CLAM::InControlTmpl< EnvelopeGenerator >, CLAM::InControlTmpl< SinusoidalSynthesis >, CLAM::InControlTmpl< BinaryControlOp >, CLAM::InControlTmpl< MIDIClocker >, CLAM::InControlTmpl< MIDIDispatcher >, CLAM::InControlTmpl< SpectrumInterpolator >, CLAM::InControlTmpl< SegmentSMSMorph >, CLAM::InControlTmpl< SMSSynthesis >, CLAM::InControlTmpl< ADSR >, CLAM::InControlTmpl< EnvelopeExtractor >, CLAM::InControlTmpl< ControlMapper >, CLAM::InControlTmpl< FDCombFilter >, CLAM::InControlTmpl< FrameInterpolator >, CLAM::InControlTmpl< PhaseManagement >, CLAM::InControlTmpl< Dispatcher >, CLAM::InControlTmpl< PrintControl >, CLAM::InControlTmpl< SegmentSMSHarmonizer >, and CLAM::InControlPublisher.
Definition at line 65 of file InControl.hxx.
References mLastValue.
Referenced by CLAM::SegmentSMSTimeStretch::ConcreteConfigure(), CLAM::CircularShift::ConcreteConfigure(), CLAM::ControlScaler::ConcreteConfigure(), CLAM::SMSResidualGain::ConcreteConfigure(), CLAM::Robotization::ConcreteConfigure(), CLAM::SMSSinusoidalGain::ConcreteConfigure(), CLAM::ThreeBandFilter::ConcreteConfigure(), CLAM::SMSGenderChange::ConcreteConfigure(), CLAM::OscillatingSpectralNotch::ConcreteConfigure(), CLAM::SpectralDelay::ConcreteConfigure(), CLAM::SMSPitchShift::ConcreteConfigure(), CLAM::AudioAmplifier::ConcreteConfigure(), CLAM::Control2Data::ConcreteConfigure(), CLAM::SimpleOscillator::ConcreteConfigure(), CLAM::SMSHarmonizer::ConcreteConfigure(), CLAM::SMSPitchShift::Do(), CLAM::InControlPublisher::DoControl(), CLAM::InControlTmpl< ProcObj >::DoControl(), CLAM::SegmentSMSHarmonizer::IgnoreResidual(), CLAM::SMSHarmonizer::IgnoreResidual(), CLAM::FrameTransformation::InitControls(), CLAM::SpectralGate::InitControls(), CLAM::SpectralReverse::InitControls(), CLAM::SpectralAverage::InitControls(), CLAM::SpectralCombDelta::InitControls(), CLAM::SpectralCombTriang::InitControls(), CLAM::Partializer::InitControls(), CLAM::Peakalizer::InitControls(), CLAM::SpectralExciter::InitControls(), CLAM::SampleAndHold::InitControls(), CLAM::SpectralNotch::InitControls(), CLAM::HumRemover::InitControls(), CLAM::SpectralRingModulation::InitControls(), CLAM::Deesser::InitControls(), CLAM::SpectralAmplitudeModulation::InitControls(), CLAM::SpectralPhaseModulation::InitControls(), CLAM::ThreeBandGate::InitControls(), CLAM::ThreeBandCompressor::InitControls(), CLAM::ThreeBandAM::InitControls(), CLAM::Vocoder::InitControls(), CLAM::SpectralSpread::InitControls(), CLAM::SpectralFocus::InitControls(), CLAM::CircularShift::SetAmount(), and CLAM::WindowGenerator::SetSize().
const TControlData& CLAM::InControl::GetLastValue | ( | ) | const [inline] |
Returns the last TControlData (float) received event.
Reimplemented in CLAM::InControlPublisher.
Definition at line 67 of file InControl.hxx.
References mLastValue.
Referenced by CLAM::SimpleOscillator::ApplyFreqAndAmpControls(), CLAM::AudioFileMemoryLoader::Do(), CLAM::ControlScaler::Do(), CLAM::MIDIKeyboard::Do(), CLAM::SpectralLimiter::Do(), CLAM::NoSpectralTransformation::Do(), CLAM::RandomPhase::Do(), CLAM::FreqShift::Do(), CLAM::SpectralReject::Do(), CLAM::SMSFreqShift::Do(), CLAM::SMSOddEvenHarmonicRatio::Do(), CLAM::SegmentSMSMorph::Do(), CLAM::SpectralReverse::Do(), CLAM::CircularShift::Do(), CLAM::SpectralGate::Do(), CLAM::SMSDeesser::Do(), CLAM::SMSResidualGain::Do(), CLAM::SMSSinusoidalGain::Do(), CLAM::SpectralAverage::Do(), CLAM::SampleAndHold::Do(), CLAM::SMSSpectralShapeShift::Do(), CLAM::Robotization::Do(), CLAM::Control2Data::Do(), CLAM::Peakalizer::Do(), CLAM::SpectralCombDelta::Do(), CLAM::SpectralCombTriang::Do(), CLAM::Partializer::Do(), CLAM::SpectralRingModulation::Do(), CLAM::SpectralAmplitudeModulation::Do(), CLAM::SpectralExciter::Do(), CLAM::SpectralPhaseModulation::Do(), CLAM::SpectralPeakArrayInterpolator::Do(), CLAM::SpectralNotch::Do(), CLAM::HumRemover::Do(), CLAM::Deesser::Do(), CLAM::Vocoder::Do(), CLAM::ThreeBandGate::Do(), CLAM::ThreeBandCompressor::Do(), CLAM::SpectralSpread::Do(), CLAM::SinTracking::Do(), CLAM::FDCombFilter::Do(), CLAM::ThreeBandAM::Do(), CLAM::FrameInterpolator::Do(), CLAM::SpectralShapeShift::Do(), CLAM::SpectralFocus::Do(), CLAM::ThreeBandFilter::Do(), CLAM::AudioAmplifier::Do(), CLAM::SMSPitchShift::Do(), CLAM::OscillatingSpectralNotch::Do(), CLAM::SpectralDelay::Do(), CLAM::SMSGenderChange::Do(), CLAM::WindowGenerator::Do(), CLAM::SinusoidalSynthesis::Do(), CLAM::SMSSynthesis::Do(), CLAM::SMSMorph::Do(), CLAM::SMSHarmonizer::Do(), CLAM::SimpleOscillator::Do(), CLAM::FDFilterGen::Do(), CLAM::PhaseManagement::DoPhaseAlignment(), CLAM::PhaseManagement::DoPhaseContinuation(), CLAM::SegmentSMSMorph::FindInterpolatedFrameFromSegment2Morph(), CLAM::MIDI2Melody::GenerateOutputData(), CLAM::ControlSink::GetControlValue(), CLAM::GetFloatFromInControl(), CLAM::InControlPublisher::GetLastValue(), CLAM::TokenDelay< Spectrum >::GivenDelay(), CLAM::SegmentSMSHarmonizer::UpdateBPF(), CLAM::SegmentSMSMorph::UpdateControlValueFromBPF(), CLAM::SegmentSMSMorph::UpdateFrameInterpolatorFactors(), and CLAM::SegmentSMSTimeStretch::UpdateTimeAndIndex().
bool CLAM::InControl::GetLastValueAsBoolean | ( | ) | const [inline] |
Returns the last TControlData (float) received interpreted as a bool.
Definition at line 69 of file InControl.hxx.
References mLastValue.
int CLAM::InControl::GetLastValueAsInteger | ( | ) | const [inline] |
Returns the last TControlData (float) received interpireted as an integer.
Definition at line 74 of file InControl.hxx.
References mLastValue.
const std::string& CLAM::InControl::GetName | ( | ) | const [inline] |
Definition at line 75 of file InControl.hxx.
References mName.
Processing* CLAM::InControl::GetProcessing | ( | ) | const [inline] |
Definition at line 86 of file InControl.hxx.
References mParent.
bool CLAM::InControl::IsBounded | ( | ) | const |
Definition at line 62 of file InControl.cxx.
References mBounded.
bool CLAM::InControl::IsConnected | ( | ) | const |
Definition at line 57 of file InControl.cxx.
References mLinks.
bool CLAM::InControl::IsConnectedTo | ( | OutControl & | out | ) |
Definition at line 52 of file InControl.cxx.
References CLAM::OutControl::IsConnectedTo().
TControlData CLAM::InControl::LowerBound | ( | ) | const |
Definition at line 70 of file InControl.cxx.
References mLowerBound.
void CLAM::InControl::OutControlInterface_AddLink | ( | OutControl & | outControl | ) |
Implementation detail just to be used from OutControl.
Definition at line 91 of file InControl.cxx.
References mLinks.
Referenced by CLAM::OutControl::AddLink().
void CLAM::InControl::OutControlInterface_RemoveLink | ( | OutControl & | outControl | ) |
Implementation detail just to be used from OutControl.
Definition at line 96 of file InControl.cxx.
References mLinks.
Referenced by CLAM::OutControl::RemoveLink().
void CLAM::InControl::SetBounds | ( | TControlData | lower, |
TControlData | upper | ||
) |
Definition at line 74 of file InControl.cxx.
References mBounded, mLowerBound, and mUpperBound.
Referenced by CLAM::AudioFileMemoryLoader::AudioFileMemoryLoader(), CLAM::SMSResidualGain::ConcreteConfigure(), CLAM::Robotization::ConcreteConfigure(), CLAM::SMSSinusoidalGain::ConcreteConfigure(), CLAM::ThreeBandFilter::ConcreteConfigure(), CLAM::OscillatingSpectralNotch::ConcreteConfigure(), CLAM::SMSGenderChange::ConcreteConfigure(), CLAM::SpectralDelay::ConcreteConfigure(), CLAM::SMSPitchShift::ConcreteConfigure(), CLAM::AudioAmplifier::ConcreteConfigure(), CLAM::SMSMorph::ConcreteConfigure(), and CLAM::SMSHarmonizer::ConcreteConfigure().
void CLAM::InControl::SetDefaultValue | ( | TControlData | val | ) |
Definition at line 80 of file InControl.cxx.
References mDefaultValue, and mHasDefaultValue.
Referenced by CLAM::SMSResidualGain::ConcreteConfigure(), CLAM::SMSSinusoidalGain::ConcreteConfigure(), CLAM::Robotization::ConcreteConfigure(), CLAM::SMSPitchShift::ConcreteConfigure(), CLAM::AudioAmplifier::ConcreteConfigure(), CLAM::SMSMorph::ConcreteConfigure(), and CLAM::SMSHarmonizer::ConcreteConfigure().
TControlData CLAM::InControl::UpperBound | ( | ) | const |
Definition at line 66 of file InControl.cxx.
References mUpperBound.
bool CLAM::InControl::mBounded [protected] |
Definition at line 56 of file InControl.hxx.
Referenced by IsBounded(), and SetBounds().
TControlData CLAM::InControl::mDefaultValue [protected] |
Definition at line 52 of file InControl.hxx.
Referenced by DefaultValue(), and SetDefaultValue().
bool CLAM::InControl::mHasDefaultValue [protected] |
Definition at line 57 of file InControl.hxx.
Referenced by DefaultValue(), and SetDefaultValue().
TControlData CLAM::InControl::mLastValue [protected] |
Definition at line 49 of file InControl.hxx.
Referenced by DoControl(), CLAM::InControlPublisher::GetLastValue(), GetLastValue(), GetLastValueAsBoolean(), and GetLastValueAsInteger().
std::list<OutControl*> CLAM::InControl::mLinks [protected] |
Definition at line 48 of file InControl.hxx.
Referenced by IsConnected(), OutControlInterface_AddLink(), OutControlInterface_RemoveLink(), and ~InControl().
TControlData CLAM::InControl::mLowerBound [protected] |
Definition at line 54 of file InControl.hxx.
Referenced by DefaultValue(), LowerBound(), and SetBounds().
std::string CLAM::InControl::mName [protected] |
Definition at line 50 of file InControl.hxx.
Referenced by GetName().
Processing* CLAM::InControl::mParent [protected] |
Definition at line 51 of file InControl.hxx.
Referenced by GetProcessing(), and ~InControl().
TControlData CLAM::InControl::mUpperBound [protected] |
Definition at line 53 of file InControl.hxx.
Referenced by DefaultValue(), SetBounds(), and UpperBound().