FME Server C++ API 3.0

ifmeserverparameter.h

Go to the documentation of this file.
00001 #ifndef _IFMESERVERPARAMETER_H
00002 #define _IFMESERVERPARAMETER_H
00003 
00057 #include <fmeservertypes.h>
00058 
00059 class IFMEServerString;
00060 class IFMEServerStringArray;
00061 
00062 class IFMEServerParameter
00063 {
00064 public:
00065    //-------------------------------------------------------------------
00068    virtual void getName(IFMEServerString& name) const = 0;
00069 
00070    //-------------------------------------------------------------------
00073    virtual void getDescription(IFMEServerString& description) const = 0;
00074 
00075    //-------------------------------------------------------------------
00084    virtual void getDefaultValue(IFMEServerString& value) const = 0;
00085 
00086    //-------------------------------------------------------------------
00089    virtual void getType(IFMEServerString& type) const = 0;
00090 
00091    //-------------------------------------------------------------------
00094    virtual void getOptionsList(IFMEServerStringArray& optionsList) const = 0;
00095 
00096    //-------------------------------------------------------------------
00099    virtual void getOptions(IFMEServerString& options) const = 0;
00100 
00101    //-------------------------------------------------------------------
00111    virtual void getOptionsType(IFMEServerString& optionsType) const = 0;
00112 
00113 protected:
00114 
00115    // -----------------------------------------------------------------------
00116    // No one should be creating an instance of this directly, so we
00117    // make the constructor protected.
00118    IFMEServerParameter() {}
00119 
00120    // -----------------------------------------------------------------------
00121    // No one should be destroying an instance of this directly, so we
00122    // make the destructor protected.
00123    virtual ~IFMEServerParameter() {}
00124 
00125 private:
00126 
00127    // -----------------------------------------------------------------------
00128    // The copy constructor is not implemented.
00129    IFMEServerParameter(const IFMEServerParameter &other);
00130 
00131    //---------------------------------------------------------------
00132    // The assignment operator is not implemented. 
00133    IFMEServerParameter &operator=(const IFMEServerParameter &other);
00134 };
00135 
00136 #endif
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines