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_ALTITUDE;
  34 const ObjectKind KIND_IMMERSIBLE_ZONE;
  35 const ObjectKind KIND_RIVER;
  36 const ObjectKind KIND_STREAM;
  37 const ObjectKind KIND_CONFLUENCE;
  38 const ObjectKind KIND_CHANNEL;
  39 const ObjectKind KIND_OBSTACLE;
  40 const ObjectKind KIND_DIGUE;
  41 const ObjectKind KIND_PROFILE;
  42 const ObjectKind KIND_PROFILEUZ;
  43 const ObjectKind KIND_POLYLINEXY;
  44 const ObjectKind KIND_CALCULATION;
  45 const ObjectKind KIND_ZONE;
  46 const ObjectKind KIND_REGION;
  47
  48 class HYDROData_Entity
  49 {
  50 %TypeHeaderCode
  51 #include <HYDROData_Entity.h>
  52 %End
  53
  54 %ConvertToSubClassCode
  55     // HYDROData_Entity sub-classes provide a unique kind ID.
  56     switch ( sipCpp->GetKind() )
  57     {
  58       case KIND_IMAGE:
  59         sipClass = sipClass_HYDROData_Image;
  60         break;
  61
  62       case KIND_POLYLINEXY:
  63         sipClass = sipClass_HYDROData_PolylineXY;
  64         break;
  65
  66       case KIND_BATHYMETRY:
  67         sipClass = sipClass_HYDROData_Bathymetry;
  68         break;
  69
  70       case KIND_OBSTACLE_ALTITUDE:
  71         sipClass = sipClass_HYDROData_ObstacleAltitude;
  72         break;
  73
  74       case KIND_IMMERSIBLE_ZONE:
  75         sipClass = sipClass_HYDROData_ImmersibleZone;
  76         break;
  77
  78       case KIND_CALCULATION:
  79         sipClass = sipClass_HYDROData_CalculationCase;
  80         break;
  81
  82       case KIND_OBSTACLE:
  83         sipClass = sipClass_HYDROData_Obstacle;
  84         break;
  85
  86       case KIND_REGION:
  87         sipClass = sipClass_HYDROData_Region;
  88         break;
  89
  90       case KIND_ZONE:
  91         sipClass = sipClass_HYDROData_Zone;
  92         break;
  93
  94       case KIND_SHAPES_GROUP:
  95         sipClass = sipClass_HYDROData_ShapesGroup;
  96         break;
  97
  98       case KIND_UNKNOWN:
  99         sipClass = sipClass_HYDROData_Entity;
 100         break;
 101
 102       default:
 103         // We don't recognise the type.
 104         sipClass = NULL;
 105     }
 106 %End
 107
 108 public:
 109
 110   /**
 111    * Returns the kind of this object. Must be redefined in all objects of known type.
 112    */
 113   virtual const ObjectKind GetKind() const;
 114
 115   /**
 116    * Returns the name of this object.
 117    */
 118   virtual QString GetName() const;
 119
 120   /**
 121    * Updates the name of this object.
 122    */
 123   virtual void SetName(const QString& theName);
 124
 125   /**
 126    * Updates object state.
 127    */
 128   virtual void Update();
 129
 130   /**
 131    * Checks is object exists in the data structure.
 132    * \returns true is object is not exists in the data model
 133    */
 134   bool IsRemoved() const;
 135
 136   /**
 137    * Removes object from the data structure.
 138    */
 139   void Remove();
 140
 141   /**
 142    * Returns unique integer identifier of the object (may be used for ordering of objects)
 143    */
 144   int ID() const;
 145
 146   /**
 147    * Copies all properties of this to the destinated object.
 148    * Objects must be the same type.
 149    * \param theDestination initialized object (from any document) - target of copying
 150    */
 151   /*
 152   void CopyTo( HYDROData_Entity theDestination ) const;
 153   */
 154
 155   /**
 156    * Returns the list of all reference objects of this object.
 157    * Base implementation always return empty list.
 158    */
 159   virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
 160
 161 protected:
 162
 163   /**
 164    * Creates new object in the internal data structure. Use higher level objects
 165    * to create objects with real content.
 166    */
 167   HYDROData_Entity();
 168
 169   /**
 170    * Destructs properties of the object and object itself, removes it from the document.
 171    */
 172   virtual ~HYDROData_Entity();
 173
 174 };