src/HYDROPy/HYDROData_Entity.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_Entity.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_BATHYMETRY;
  34 const ObjectKind KIND_IMMERSIBLE_ZONE;
  35 const ObjectKind KIND_CALCULATION;
  36 const ObjectKind KIND_ZONE;
  37 const ObjectKind KIND_REGION;
  38
  39 class HYDROData_Entity
  40 {
  41 %TypeHeaderCode
  42 #include <HYDROData_Entity.h>
  43 %End
  44
  45 %ConvertToSubClassCode
  46     // HYDROData_Entity 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_IMMERSIBLE_ZONE:
  62         sipClass = sipClass_HYDROData_ImmersibleZone;
  63         break;
  64
  65       case KIND_CALCULATION:
  66         sipClass = sipClass_HYDROData_Calculation;
  67         break;
  68
  69       case KIND_REGION:
  70         sipClass = sipClass_HYDROData_Region;
  71         break;
  72
  73       case KIND_ZONE:
  74         sipClass = sipClass_HYDROData_Zone;
  75         break;
  76
  77       case KIND_UNKNOWN:
  78         sipClass = sipClass_HYDROData_Entity;
  79         break;
  80
  81       default:
  82         // We don't recognise the type.
  83         sipClass = NULL;
  84     }
  85 %End
  86
  87 public:
  88
  89   /**
  90    * Returns the kind of this object. Must be redefined in all objects of known type.
  91    */
  92   const ObjectKind GetKind() const;
  93
  94   /**
  95    * Returns the name of this object.
  96    */
  97   QString GetName() const;
  98
  99   /**
 100    * Updates the name of this object.
 101    */
 102   void SetName(const QString& theName);
 103
 104   /**
 105    * Updates object state.
 106    * \param theIsForce force reupdating of data object
 107    */
 108   void Update(const bool theIsForce);
 109
 110   /**
 111    * Checks is object exists in the data structure.
 112    * \returns true is object is not exists in the data model
 113    */
 114   bool IsRemoved() const;
 115
 116   /**
 117    * Removes object from the data structure.
 118    */
 119   void Remove();
 120
 121   /**
 122    * Returns unique integer identifier of the object (may be used for ordering of objects)
 123    */
 124   int ID() const;
 125
 126   /**
 127    * Copies all properties of this to the destinated object.
 128    * Objects must be the same type.
 129    * \param theDestination initialized object (from any document) - target of copying
 130    */
 131   /*
 132   void CopyTo( HYDROData_Entity theDestination ) const;
 133   */
 134
 135 protected:
 136
 137   /**
 138    * Creates new object in the internal data structure. Use higher level objects
 139    * to create objects with real content.
 140    */
 141   HYDROData_Entity();
 142
 143   /**
 144    * Destructs properties of the object and object itself, removes it from the document.
 145    */
 146   virtual ~HYDROData_Entity();
 147
 148 };