FME Server C++ API 3.0

ifmeserverproperty.h

Go to the documentation of this file.
00001 #ifndef _IFMESERVERPROPERTY_H_
00002 #define _IFMESERVERPROPERTY_H_
00003 
00070 #include <fmeservertypes.h>
00071 
00072 class IFMEServerStringArray;
00073 class IFMEServerString;
00074 
00075 class IFMEServerProperty
00076 {
00077 public:
00078 
00079    // -----------------------------------------------------------------------
00083    virtual void getCategory(IFMEServerString& propertyCategory) const = 0;
00084 
00085    // -----------------------------------------------------------------------
00089    virtual void getName(IFMEServerString& propertyName) const = 0;
00090   
00091    // -----------------------------------------------------------------------
00095    virtual void getValue(IFMEServerString& propertyValue) const = 0;  
00096 
00097    // -----------------------------------------------------------------------
00102    virtual FME_Boolean getAttribute(const IFMEServerString& attributeName,
00103                                     IFMEServerString& attributeValue) const = 0;
00104 
00105    // -----------------------------------------------------------------------
00109    virtual void getAllAttributeNames(IFMEServerStringArray& attributeNames) const = 0;
00110 
00111   // -----------------------------------------------------------------------
00115   virtual void setCategory(const IFMEServerString& propertyCategory) = 0;
00116   
00117   // -----------------------------------------------------------------------
00121   virtual void setName(const IFMEServerString& propertyName) = 0;
00122   
00123   // -----------------------------------------------------------------------
00127   virtual void setValue(const IFMEServerString& propertyValue) = 0;
00128   
00129   // -----------------------------------------------------------------------
00134   virtual void setAttribute(const IFMEServerString& attributeName,
00135                       const IFMEServerString& attributeValue) = 0;
00136 
00137 protected:
00138    // -----------------------------------------------------------------------
00139    // No one should be creating an instance of this directly, so we
00140    // make the constructor protected.
00141    IFMEServerProperty() {}; 
00142 
00143    // -----------------------------------------------------------------------
00144    // Destructor 
00145    virtual ~IFMEServerProperty() {};
00146 
00147 private:
00148    // Hide methods that we don't want called -- but we leave the door
00149    // open if subclasses want to implement these
00150 
00151    //---------------------------------------------------------------
00152    // copy constructor
00153    IFMEServerProperty(const IFMEServerProperty&);
00154 
00155    //---------------------------------------------------------------
00156    // assignment operator.
00157    IFMEServerProperty& operator=(const IFMEServerProperty&);
00158 };
00159 
00160 #endif
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines