src/HYDROPy/HYDROData_Object.sip

   1 // Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23
  24 %ExportedHeaderCode
  25 #include <HYDROData_Object.h>
  26 %End
  27
  28 typedef int ObjectKind;
  29
  30 const ObjectKind KIND_UNKNOWN;
  31 const ObjectKind KIND_IMAGE;
  32 const ObjectKind KIND_POLYLINE;
  33 const ObjectKind KIND_VISUAL_STATE;
  34 const ObjectKind KIND_BATHYMETRY;
  35 const ObjectKind KIND_CALCULATION;
  36 const ObjectKind KIND_ZONE;
  37 const ObjectKind KIND_REGION;
  38
  39 class HYDROData_Object
  40 {
  41 %TypeHeaderCode
  42 #include <HYDROData_Object.h>
  43 %End
  44
  45 %ConvertToSubClassCode
  46     // HYDROData_Object sub-classes provide a unique kind ID.
  47     switch ( sipCpp->GetKind() )
  48     {
  49       case KIND_IMAGE:
  50         sipClass = sipClass_HYDROData_Image;
  51         break;
  52
  53       case KIND_POLYLINE:
  54         sipClass = sipClass_HYDROData_Polyline;
  55         break;
  56
  57       case KIND_BATHYMETRY:
  58         sipClass = sipClass_HYDROData_Bathymetry;
  59         break;
  60
  61       case KIND_CALCULATION:
  62         sipClass = sipClass_HYDROData_Calculation;
  63         break;
  64
  65       case KIND_ZONE:
  66         sipClass = sipClass_HYDROData_Zone;
  67         break;
  68
  69       case KIND_REGION:
  70         sipClass = sipClass_HYDROData_Region;
  71         break;
  72
  73       case KIND_UNKNOWN:
  74         sipClass = sipClass_HYDROData_Object;
  75         break;
  76
  77       default:
  78         // We don't recognise the type.
  79         sipClass = NULL;
  80     }
  81 %End
  82
  83 public:
  84
  85   /**
  86    * Returns the kind of this object. Must be redefined in all objects of known type.
  87    */
  88   const ObjectKind GetKind() const;
  89
  90   /**
  91    * Returns the name of this object.
  92    */
  93   QString GetName() const;
  94
  95   /**
  96    * Updates the name of this object.
  97    */
  98   void SetName(const QString& theName);
  99
 100   /**
 101    * Updates object state.
 102    * \param theIsForce force reupdating of data object
 103    */
 104   void Update(const bool theIsForce);
 105
 106   /**
 107    * Checks is object exists in the data structure.
 108    * \returns true is object is not exists in the data model
 109    */
 110   bool IsRemoved() const;
 111
 112   /**
 113    * Removes object from the data structure.
 114    */
 115   void Remove();
 116
 117   /**
 118    * Returns unique integer identifier of the object (may be used for ordering of objects)
 119    */
 120   int ID() const;
 121
 122   /**
 123    * Copies all properties of this to the destinated object.
 124    * Objects must be the same type.
 125    * \param theDestination initialized object (from any document) - target of copying
 126    */
 127   /*
 128   void CopyTo( HYDROData_Object theDestination ) const;
 129   */
 130
 131 protected:
 132
 133   /**
 134    * Creates new object in the internal data structure. Use higher level objects
 135    * to create objects with real content.
 136    */
 137   HYDROData_Object();
 138
 139   /**
 140    * Destructs properties of the object and object itself, removes it from the document.
 141    */
 142   virtual ~HYDROData_Object();
 143
 144 };