src/HYDROData/HYDROData_Stream.h

   1
   2 #ifndef HYDROData_Stream_HeaderFile
   3 #define HYDROData_Stream_HeaderFile
   4
   5 #include "HYDROData_NaturalObject.h"
   6
   7 DEFINE_STANDARD_HANDLE(HYDROData_Stream, HYDROData_NaturalObject)
   8
   9 class Handle(HYDROData_PolylineXY);
  10 class Handle(HYDROData_Profile);
  11
  12 /**\class HYDROData_Stream
  13  * \brief
  14  *
  15  */
  16 class HYDROData_Stream : public HYDROData_NaturalObject
  17 {
  18 protected:
  19   /**
  20    * Enumeration of tags corresponding to the persistent object parameters.
  21    */
  22   enum DataTag
  23   {
  24     DataTag_First = HYDROData_NaturalObject::DataTag_First + 100, ///< first tag, to reserve
  25     DataTag_HydraulicAxis,     ///< reference hydraulic axis
  26     DataTag_Profile,           ///< reference profiles
  27   };
  28
  29 public:
  30   DEFINE_STANDARD_RTTI(HYDROData_Stream);
  31
  32   /**
  33    * Returns the kind of this object. Must be redefined in all objects of known type.
  34    */
  35   HYDRODATA_EXPORT virtual const ObjectKind GetKind() const {return KIND_STREAM;}
  36
  37   /**
  38    * Dump object to Python script representation.
  39    */
  40   HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
  41
  42   /**
  43    * Returns the top shape of the object.
  44    */
  45   HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
  46
  47   /**
  48    * Returns the 3d shape of the object.
  49    */
  50   HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
  51
  52   /**
  53    * Update the shape presentations of stream.
  54    * Call this method whenever you made changes for stream data.
  55    */
  56   HYDRODATA_EXPORT virtual void Update();
  57
  58
  59 public:
  60   // Public methods to work with Stream
  61
  62   /**
  63    * Sets reference hydraulic axis object for stream.
  64    */
  65   HYDRODATA_EXPORT virtual bool SetHydraulicAxis( const Handle(HYDROData_PolylineXY)& theAxis );
  66
  67   /**
  68    * Returns reference hydraulic axis object of stream.
  69    */
  70   HYDRODATA_EXPORT virtual Handle(HYDROData_PolylineXY) GetHydraulicAxis() const;
  71
  72   /**
  73    * Remove reference hydraulic axis object from stream.
  74    */
  75   HYDRODATA_EXPORT virtual void RemoveHydraulicAxis();
  76
  77
  78   /**
  79    * Returns true if profile has the intersection with reference hydraulic axis.
  80    */
  81   HYDRODATA_EXPORT virtual bool HasIntersection( const Handle(HYDROData_Profile)& theProfile ) const;
  82
  83
  84   /**
  85    * Add new one reference profile object for stream.
  86    */
  87   HYDRODATA_EXPORT virtual bool AddProfile( const Handle(HYDROData_Profile)& theProfile );
  88
  89   /**
  90    * Returns all reference profile objects of stream.
  91    */
  92   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetProfiles() const;
  93
  94   /**
  95    * Removes reference profile object from stream.
  96    */
  97   HYDRODATA_EXPORT virtual bool RemoveProfile( const Handle(HYDROData_Profile)& theProfile );
  98
  99   /**
 100    * Removes all reference profile objects from stream.
 101    */
 102   HYDRODATA_EXPORT virtual void RemoveProfiles();
 103
 104
 105 protected:
 106
 107   /**
 108    * Insert one profile in to the stream profiles order.
 109    */
 110   void insertProfileInToOrder( const Handle(HYDROData_Profile)& theProfile );
 111
 112   /**
 113    * Fully recompute the order of all profiles in accordance with reference hydraulic axis.
 114    * If hydraulic axis is not set all profiles will be removed from order.
 115    */
 116   void updateProfilesOrder();
 117
 118 protected:
 119
 120   friend class HYDROData_Iterator;
 121
 122   /**
 123    * Creates new object in the internal data structure. Use higher level objects
 124    * to create objects with real content.
 125    */
 126   HYDRODATA_EXPORT HYDROData_Stream();
 127
 128   /**
 129    * Destructs properties of the object and object itself, removes it from the document.
 130    */
 131   virtual HYDRODATA_EXPORT ~HYDROData_Stream();
 132 };
 133
 134 #endif