src/HYDROData/HYDROData_Stream.h

   1
   2 #ifndef HYDROData_Stream_HeaderFile
   3 #define HYDROData_Stream_HeaderFile
   4
   5 #include "HYDROData_NaturalObject.h"
   6 #include <TopoDS_Face.hxx>
   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 list of all reference objects of this object.
  44    */
  45   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
  46
  47   /**
  48    * Returns the top shape of the object.
  49    */
  50   HYDRODATA_EXPORT virtual TopoDS_Shape GetTopShape() const;
  51
  52   /**
  53    * Returns the 3d shape of the object.
  54    */
  55   HYDRODATA_EXPORT virtual TopoDS_Shape GetShape3D() const;
  56
  57   /**
  58    * Update the shape presentations of stream.
  59    * Call this method whenever you made changes for stream data.
  60    */
  61   HYDRODATA_EXPORT virtual void Update();
  62
  63
  64 public:
  65   // Public methods to work with Stream
  66
  67   /**
  68    * Sets reference hydraulic axis object for stream.
  69    */
  70   HYDRODATA_EXPORT virtual bool SetHydraulicAxis( const Handle(HYDROData_PolylineXY)& theAxis );
  71
  72   /**
  73    * Returns reference hydraulic axis object of stream.
  74    */
  75   HYDRODATA_EXPORT virtual Handle(HYDROData_PolylineXY) GetHydraulicAxis() const;
  76
  77   /**
  78    * Remove reference hydraulic axis object from stream.
  79    */
  80   HYDRODATA_EXPORT virtual void RemoveHydraulicAxis();
  81
  82
  83   /**
  84    * Returns true if profile has the intersection with reference hydraulic axis.
  85    * Returns the parameter of inresection point on axis if axis is presented by one curve,
  86    * if axis presented by set of edges the <outPar> returns a common length of segments till the intersection point.
  87    */
  88   HYDRODATA_EXPORT virtual bool HasIntersection( const Handle(HYDROData_Profile)& theProfile, const TopoDS_Face& thePlane,
  89                                                                                                 Standard_Real& outPar) const;
  90
  91
  92   /**
  93    * Add new one reference profile object for stream.
  94    */
  95   HYDRODATA_EXPORT virtual bool AddProfile( const Handle(HYDROData_Profile)& theProfile );
  96
  97   /**
  98    * Returns all reference profile objects of stream.
  99    */
 100   HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetProfiles() const;
 101
 102   /**
 103    * Removes reference profile object from stream.
 104    */
 105   HYDRODATA_EXPORT virtual bool RemoveProfile( const Handle(HYDROData_Profile)& theProfile );
 106
 107   /**
 108    * Removes all reference profile objects from stream.
 109    */
 110   HYDRODATA_EXPORT virtual void RemoveProfiles();
 111
 112
 113 protected:
 114
 115   /**
 116    * Insert one profile in to the stream profiles order.
 117    */
 118   void insertProfileInToOrder( const Handle(HYDROData_Profile)& theProfile );
 119
 120   /**
 121    * Fully recompute the order of all profiles in accordance with reference hydraulic axis.
 122    * If hydraulic axis is not set all profiles will be removed from order.
 123    */
 124   void updateProfilesOrder();
 125
 126 protected:
 127
 128   friend class HYDROData_Iterator;
 129
 130   /**
 131    * Creates new object in the internal data structure. Use higher level objects
 132    * to create objects with real content.
 133    */
 134   HYDRODATA_EXPORT HYDROData_Stream();
 135
 136   /**
 137    * Destructs properties of the object and object itself, removes it from the document.
 138    */
 139   virtual HYDRODATA_EXPORT ~HYDROData_Stream();
 140 };
 141
 142 #endif