---

optionVI.h

Go to the documentation of this file.

#ifndef OPTIONVI_H
#define OPTIONVI_H

#include "Event/nameVI.h"
#include "Event/serverVI.h"

#include <string>
//----------------------------------------------------
/*! 
<ul>
        <li> The derived class can declare some of its parameters as options. The parameters
        should be strings, doubles, integeres or  bool. The derived class should rewrite the virtual
        method \c defineOption() to include the \c defineOption(parName, parPointer) methods
        with the parameter name and the pointer to this parameter. Usually \c defineOptions()
        is just a collection of \c defineOption(parname, parpointer).
        <li> The derived class or a external friend class (optionServer) can set the value
        of options via the methods \c setOption(parName, parContent). The options are identified
        with their names.
        <li> Note that the methods \c setOption() are not protected and they not returns information of errors. 
        The external class that set the options should handle that.
</ul>
*/
//----------------------------------------------
//             J.A Hernando, Santa Cruz 02/29/00
//----------------------------------------------

//############################
class optionVI : public nameVI
//############################
{
        friend class optionServer;

public:

        optionVI() {clear();};
        virtual ~optionVI() {}

protected:

        virtual void setName(std::string name);

        bool search(std::string name) const;

        virtual void defineOption() {};
        
        void defineOption(std::string name, std::string* st) {m_sserver.add(name,st);}
        void defineOption(std::string name, double* d) {m_dserver.add(name,d);}
        void defineOption(std::string name, int* i) {m_iserver.add(name,i);}

        virtual void setOption(std::string name, std::string c) {*(m_sserver.get(name)) = c;}
        virtual void setOption(std::string name, double c) {*(m_dserver.get(name)) = c;}
        virtual void setOption(std::string name, int c) {*(m_iserver.get(name)) = c;}

        virtual void writeOutOptions() const;

        virtual void clear() {m_sserver.clear();m_dserver.clear();m_iserver.clear();}

private:

        serverVI<std::string> m_sserver;
        serverVI<double> m_dserver;
        serverVI<int> m_iserver;

};
#endif

---