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