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 const ObjectKind KIND_SHAPES_GROUP;
  48 const ObjectKind KIND_SPLITTED_GROUP;
  49 const ObjectKind KIND_OBSTACLE_ALTITUDE;
  50
  51 class HYDROData_Entity
  52 {
  53 %TypeHeaderCode
  54 #include <HYDROData_Entity.h>
  55 %End
  56
  57 %ConvertToSubClassCode
  58     // HYDROData_Entity sub-classes provide a unique kind ID.
  59     switch ( sipCpp->GetKind() )
  60     {
  61       case KIND_IMAGE:
  62         sipClass = sipClass_HYDROData_Image;
  63         break;
  64
  65       case KIND_POLYLINE:
  66         sipClass = sipClass_HYDROData_Polyline3D;
  67         break;
  68
  69       case KIND_BATHYMETRY:
  70         sipClass = sipClass_HYDROData_Bathymetry;
  71         break;
  72
  73       case KIND_ALTITUDE:
  74         sipClass = sipClass_HYDROData_AltitudeObject;
  75         break;
  76
  77       case KIND_IMMERSIBLE_ZONE:
  78         sipClass = sipClass_HYDROData_ImmersibleZone;
  79         break;
  80
  81       case KIND_RIVER:
  82         sipClass = sipClass_HYDROData_River;
  83         break;
  84
  85       case KIND_STREAM:
  86         sipClass = sipClass_HYDROData_Stream;
  87         break;
  88
  89       case KIND_CONFLUENCE:
  90         sipClass = sipClass_HYDROData_Confluence;
  91         break;
  92
  93       case KIND_CHANNEL:
  94         sipClass = sipClass_HYDROData_Channel;
  95         break;
  96
  97       case KIND_OBSTACLE:
  98         sipClass = sipClass_HYDROData_Obstacle;
  99         break;
 100
 101       case KIND_DIGUE:
 102         sipClass = sipClass_HYDROData_Digue;
 103         break;
 104
 105       case KIND_PROFILE:
 106         sipClass = sipClass_HYDROData_Profile;
 107         break;
 108
 109       case KIND_PROFILEUZ:
 110         sipClass = sipClass_HYDROData_ProfileUZ;
 111         break;
 112
 113       case KIND_POLYLINEXY:
 114         sipClass = sipClass_HYDROData_PolylineXY;
 115         break;
 116
 117       case KIND_CALCULATION:
 118         sipClass = sipClass_HYDROData_CalculationCase;
 119         break;
 120
 121       case KIND_ZONE:
 122         sipClass = sipClass_HYDROData_Zone;
 123         break;
 124
 125       case KIND_REGION:
 126         sipClass = sipClass_HYDROData_Region;
 127         break;
 128
 129       case KIND_SHAPES_GROUP:
 130         sipClass = sipClass_HYDROData_ShapesGroup;
 131         break;
 132
 133       case KIND_SPLITTED_GROUP:
 134         sipClass = sipClass_HYDROData_SplittedShapesGroup;
 135         break;
 136
 137       case KIND_STREAM_ALTITUDE:
 138         sipClass = sipClass_HYDROData_StreamAltitude;
 139         break;
 140
 141       case KIND_OBSTACLE_ALTITUDE:
 142         sipClass = sipClass_HYDROData_ObstacleAltitude;
 143         break;
 144
 145       case KIND_UNKNOWN:
 146         sipClass = sipClass_HYDROData_Entity;
 147         break;
 148
 149       default:
 150         // We don't recognise the type.
 151         sipClass = NULL;
 152     }
 153 %End
 154
 155 public:
 156
 157   /**
 158    * Returns the kind of this object. Must be redefined in all objects of known type.
 159    */
 160   virtual const ObjectKind GetKind() const;
 161
 162   /**
 163    * Returns the name of this object.
 164    */
 165   virtual QString GetName() const;
 166
 167   /**
 168    * Updates the name of this object.
 169    */
 170   virtual void SetName(const QString& theName);
 171
 172   /**
 173    * Updates object state.
 174    */
 175   virtual void Update();
 176
 177   /**
 178    * Checks that object has 2D presentation. Base implementation returns false.
 179    */
 180   virtual bool IsHas2dPrs() const;
 181
 182   /**
 183    * Returns data of object wrapped to QVariant.
 184    * Base implementation returns null value.
 185    */
 186   virtual QVariant GetDataVariant();
 187
 188
 189   /**
 190    * Sets the "MustBeUpdated" flag: if object is depended on updated features.
 191    * \param theFlag is true for objects that must be updated, false for up-to-date
 192    */
 193   virtual void SetToUpdate( bool theFlag );
 194
 195   /**
 196    * Returns the "MustBeUpdated" flag: is object data must be updated or not
 197    * \returns false if object is up to date
 198    */
 199   virtual bool IsMustBeUpdated() const;
 200
 201   /**
 202    * Returns flag indicating that object is updateble or not.
 203    */
 204   virtual bool CanBeUpdated() const;
 205
 206
 207   /**
 208    * Checks is object exists in the data structure.
 209    * \returns true is object is not exists in the data model
 210    */
 211   bool IsRemoved() const;
 212
 213   /**
 214    * Removes object from the data structure.
 215    */
 216   virtual void Remove();
 217
 218
 219   /**
 220    * Copies all properties of this to the destinated object.
 221    * Objects must be the same type.
 222    * \param theDestination initialized object (from any document) - target of copying
 223    */
 224   void CopyTo( HYDROData_Entity theDestination ) const [void ( const Handle_HYDROData_Entity& )];
 225   %MethodCode
 226     Handle(HYDROData_Entity) aCopyTo = createHandle( a0 );
 227     if ( !aCopyTo.IsNull() )
 228     {
 229       Py_BEGIN_ALLOW_THREADS
 230       sipSelfWasArg ? sipCpp->HYDROData_Entity::CopyTo( aCopyTo ):
 231                       sipCpp->CopyTo( aCopyTo );
 232       Py_END_ALLOW_THREADS
 233     }
 234   %End
 235
 236   /**
 237    * Returns father object. For object created under root document label
 238    * this method always return NULL object.
 239    */
 240   HYDROData_Entity GetFatherObject() const [Handle_HYDROData_Entity ()];
 241   %MethodCode
 242     Handle(HYDROData_Entity) aFather;
 243
 244     Py_BEGIN_ALLOW_THREADS
 245     aFather = sipSelfWasArg ? sipCpp->HYDROData_Entity::GetFatherObject() :
 246                               sipCpp->GetFatherObject();
 247     Py_END_ALLOW_THREADS
 248
 249     sipRes = createPointer( aFather );
 250   %End
 251
 252   /**
 253    * Returns the list of all reference objects of this object.
 254    * Base implementation always return empty list.
 255    */
 256   virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
 257
 258
 259   /**
 260    * Returns the z-level for object presentation, -1 if no z-level.
 261    */
 262   virtual bool GetZLevel( int& theLevel ) const [Standard_Boolean ( Standard_Integer& )];
 263
 264   /**
 265    * Set the z-level for object presentation.
 266    */
 267   virtual void SetZLevel( const int& theLevel ) [void ( const Standard_Integer& )];
 268
 269   /**
 270    * Remove the z-level of object presentation.
 271    */
 272   virtual void RemoveZLevel();
 273
 274
 275 protected:
 276
 277   /**
 278    * Creates new object in the internal data structure. Use higher level objects
 279    * to create objects with real content.
 280    */
 281   HYDROData_Entity();
 282
 283   /**
 284    * Destructs properties of the object and object itself, removes it from the document.
 285    */
 286   virtual ~HYDROData_Entity();
 287
 288 };