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_PROFILEUZ:
  67         sipClass = sipClass_HYDROData_ProfileUZ;
  68         break;
  69
  70       case KIND_BATHYMETRY:
  71         sipClass = sipClass_HYDROData_Bathymetry;
  72         break;
  73
  74       case KIND_OBSTACLE_ALTITUDE:
  75         sipClass = sipClass_HYDROData_ObstacleAltitude;
  76         break;
  77
  78       case KIND_IMMERSIBLE_ZONE:
  79         sipClass = sipClass_HYDROData_ImmersibleZone;
  80         break;
  81
  82       case KIND_CHANNEL:
  83         sipClass = sipClass_HYDROData_Channel;
  84         break;
  85
  86       case KIND_CALCULATION:
  87         sipClass = sipClass_HYDROData_CalculationCase;
  88         break;
  89
  90       case KIND_OBSTACLE:
  91         sipClass = sipClass_HYDROData_Obstacle;
  92         break;
  93
  94       case KIND_POLYLINE:
  95         sipClass = sipClass_HYDROData_Polyline3D;
  96         break;
  97
  98       case KIND_PROFILE:
  99         sipClass = sipClass_HYDROData_Profile;
 100         break;
 101
 102       case KIND_REGION:
 103         sipClass = sipClass_HYDROData_Region;
 104         break;
 105
 106       case KIND_ZONE:
 107         sipClass = sipClass_HYDROData_Zone;
 108         break;
 109
 110       case KIND_SHAPES_GROUP:
 111         sipClass = sipClass_HYDROData_ShapesGroup;
 112         break;
 113
 114       case KIND_UNKNOWN:
 115         sipClass = sipClass_HYDROData_Entity;
 116         break;
 117
 118       default:
 119         // We don't recognise the type.
 120         sipClass = NULL;
 121     }
 122 %End
 123
 124 public:
 125
 126   /**
 127    * Returns the kind of this object. Must be redefined in all objects of known type.
 128    */
 129   virtual const ObjectKind GetKind() const;
 130
 131   /**
 132    * Returns the name of this object.
 133    */
 134   virtual QString GetName() const;
 135
 136   /**
 137    * Updates the name of this object.
 138    */
 139   virtual void SetName(const QString& theName);
 140
 141   /**
 142    * Updates object state.
 143    */
 144   virtual void Update();
 145
 146   /**
 147    * Returns data of object wrapped to QVariant.
 148    * Base implementation returns null value.
 149    */
 150   virtual QVariant GetDataVariant();
 151
 152
 153   /**
 154    * Sets the "MustBeUpdated" flag: if object is depended on updated features.
 155    * \param theFlag is true for objects that must be updated, false for up-to-date
 156    */
 157   virtual void SetToUpdate( bool theFlag );
 158
 159   /**
 160    * Returns the "MustBeUpdated" flag: is object data must be updated or not
 161    * \returns false if object is up to date
 162    */
 163   virtual bool IsMustBeUpdated() const;
 164
 165   /**
 166    * Returns flag indicating that object is updateble or not.
 167    */
 168   virtual bool CanBeUpdated() const;
 169
 170
 171   /**
 172    * Checks is object exists in the data structure.
 173    * \returns true is object is not exists in the data model
 174    */
 175   bool IsRemoved() const;
 176
 177   /**
 178    * Removes object from the data structure.
 179    */
 180   virtual void Remove();
 181
 182
 183   /**
 184    * Copies all properties of this to the destinated object.
 185    * Objects must be the same type.
 186    * \param theDestination initialized object (from any document) - target of copying
 187    */
 188   void CopyTo( HYDROData_Entity theDestination ) const [void ( const Handle_HYDROData_Entity& )];
 189   %MethodCode
 190     Handle(HYDROData_Entity) aCopyTo = createHandle( a0 );
 191     if ( !aCopyTo.IsNull() )
 192     {
 193       Py_BEGIN_ALLOW_THREADS
 194       sipSelfWasArg ? sipCpp->HYDROData_Entity::CopyTo( aCopyTo ):
 195                       sipCpp->CopyTo( aCopyTo );
 196       Py_END_ALLOW_THREADS
 197     }
 198   %End
 199
 200   /**
 201    * Returns father object. For object created under root document label
 202    * this method always return NULL object.
 203    */
 204   HYDROData_Entity GetFatherObject() const [Handle_HYDROData_Entity ()];
 205   %MethodCode
 206     Handle(HYDROData_Entity) aFather;
 207
 208     Py_BEGIN_ALLOW_THREADS
 209     aFather = sipSelfWasArg ? sipCpp->HYDROData_Entity::GetFatherObject() :
 210                               sipCpp->GetFatherObject();
 211     Py_END_ALLOW_THREADS
 212
 213     sipRes = createPointer( aFather );
 214   %End
 215
 216   /**
 217    * Returns the list of all reference objects of this object.
 218    * Base implementation always return empty list.
 219    */
 220   virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
 221
 222 protected:
 223
 224   /**
 225    * Creates new object in the internal data structure. Use higher level objects
 226    * to create objects with real content.
 227    */
 228   HYDROData_Entity();
 229
 230   /**
 231    * Destructs properties of the object and object itself, removes it from the document.
 232    */
 233   virtual ~HYDROData_Entity();
 234
 235 };