InControl.hxx

Go to the documentation of this file.

/*
 * Copyright (c) 2001-2004 MUSIC TECHNOLOGY GROUP (MTG)
 *                         UNIVERSITAT POMPEU FABRA
 *
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#ifndef _InControl_
#define _InControl_

#include <sstream>
#include <string>
#include <list>

namespace CLAM {

// Forward Declaration:
class Processing;
class OutControl;

typedef float TControlData;

class InControl
{
// Attributes:
protected:
        std::list<OutControl*> mLinks;
        TControlData mLastValue;
        std::string mName;
        Processing * mParent;
        TControlData mDefaultValue;
        TControlData mUpperBound;
        TControlData mLowerBound;

        bool mBounded;
        bool mHasDefaultValue;

// Methods:
public:
        virtual int DoControl(TControlData val) { mLastValue = val; return 0; };
        const TControlData& GetLastValue() const { return mLastValue; };
        bool GetLastValueAsBoolean() const 
        { 
                return (mLastValue > 0) ? mLastValue>0.01 : mLastValue<-0.01;
        };
        int GetLastValueAsInteger() const { return (int)(mLastValue+0.5f); };
        const std::string& GetName() const { return mName; }
        bool IsConnectedTo( OutControl & );
        bool IsConnected() const;
        bool IsBounded() const;
        TControlData UpperBound() const;
        TControlData LowerBound() const;
        TControlData DefaultValue() const;
        void SetDefaultValue(TControlData val);
        void SetBounds(TControlData lower, TControlData upper);

        Processing * GetProcessing() const { return mParent; }
        
        void OutControlInterface_AddLink(OutControl & outControl);
        void OutControlInterface_RemoveLink(OutControl & outControl);

//Constructor/Destructor
        InControl(const std::string &name, Processing* parent=0, const bool publish=true);
        virtual ~InControl();
};

template<class ProcObj>
class InControlTmpl : public InControl
{
public:
        typedef int (ProcObj::*TPtrMemberFunc)(TControlData);
        typedef int (ProcObj::*TPtrMemberFuncId)(int,TControlData);

private:
        TPtrMemberFunc   mFunc;
        TPtrMemberFuncId mFuncId;
        ProcObj* mProcObj;
        int mId;

public:
        // redeclaration
        int DoControl(TControlData val);

        bool ExistMemberFunc() { return (mFunc==0); };
        void SetMemberFunc(TPtrMemberFunc f) { mFunc = f; };

        int GetId(void) const { return mId; }

//Constructor/Destructor

        InControlTmpl(const std::string &name, ProcObj* parent, TPtrMemberFunc f = 0,const bool publish=true )  :
                InControl(name,parent,publish),
                mFunc(f),
                mFuncId(0),
                mProcObj(parent)

                {
//                      if (publish) mProcObj->PublishInControl(this);
                };

        InControlTmpl(int id,const std::string &name, ProcObj* parent, TPtrMemberFuncId f,const bool publish=true )     :
                InControl(name,parent,publish),
                mFunc(0),
                mFuncId(f),
                mProcObj(parent),
                mId(id)
                {
//                      if (publish && mProcObj) mProcObj->PublishInControl(this);
                };

        ~InControlTmpl(){};
        
};


//  Implementation of class InControlTmpl
//

template<class ProcObj>
int InControlTmpl<ProcObj>::DoControl(TControlData val)
{
        InControl::DoControl(val);
        if(mFunc)
                return (mProcObj->*mFunc)(val);
        else if (mFuncId)
                return (mProcObj->*mFuncId)(mId,val);
        else
                return 0;
}



} // namespace CLAM

#endif //_InControl_

---