rrPluginParameter.h

Go to the documentation of this file.

#ifndef rrPluginParameterH
#define rrPluginParameterH
#include "rrPluginsAPIExporter.h"
#include <string>
#include <ostream>
//---------------------------------------------------------------------------

namespace rrp
{

using std::string;
using std::ostream;

class PLUGINS_API_DECLSPEC PluginParameter
{
    public:
                                            PluginParameter(const string& name, const string& hint);
        virtual                            ~PluginParameter();

        string                              asString() const;

        string                              getName() const;

        string                              getDescription() const;
        
        void                                setDescription(const string& descr);
        
        void                                setHint(const string& hint);

        string                              getHint() const;

        //Pure virtuals
        virtual string                      getValueAsString() const;

        virtual string                      getType() const;

        virtual void*                       getValueHandle();

        virtual void                        setValueFromString(const string& value) = 0;

        PLUGINS_API_DECLSPEC
        friend ostream&                     operator<<(ostream& stream, const PluginParameter& outMe);

    protected:
        string                              mName;

        string                              mDescription;

        string                              mHint;

};

}
#endif