#include <HYDROData_Entity.h>
+// IDL includes
+#include <SALOMEconfig.h>
+#include CORBA_SERVER_HEADER(GEOM_Gen)
+
+class gp_XY;
+
+class TopoDS_Shape;
+class TopoDS_Shell;
+class TopTools_ListOfShape;
+
class Handle(HYDROData_Object);
class Handle(HYDROData_Region);
class Handle(HYDROData_Zone);
+class Handle(HYDROData_PolylineXY);
+class Handle(HYDROData_ShapesGroup);
+class Handle(HYDROData_SplittedShapesGroup);
DEFINE_STANDARD_HANDLE(HYDROData_CalculationCase, HYDROData_Entity)
*/
class HYDROData_CalculationCase : public HYDROData_Entity
{
+public:
+
+ enum PointClassification
+ {
+ POINT_OUT, ///< point is out of zone face
+ POINT_IN, ///< point is inside of zone face
+ POINT_ON ///< point is on the edge of zone face
+ };
protected:
DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
DataTag_GeometryObject, ///< reference geometry objects
DataTag_ChildRegion, ///< child regions
- DataTag_Region ///< reference regions
+ DataTag_Region, ///< reference regions
+ DataTag_Polyline, ///< reference boundary polyline
+ DataTag_GeometryGroup, ///< reference geometry groups
+ DataTag_SplittedGroups, ///< reference splitted groups
};
public:
*/
HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_CALCULATION; }
+ /**
+ * Updates the name of this object.
+ * Reimplemented to update the names of regions, zones and splitted groups.
+ */
+ HYDRODATA_EXPORT virtual void SetName( const QString& theName );
/**
* Dump Calculation object to Python script representation.
*/
HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
-public:
- // Public methods to work with Calculation
+ /**
+ * Update the calcualtion case object.
+ * Call this method whenever you made changes for object data.
+ */
+ HYDRODATA_EXPORT virtual void Update();
/**
- * Split reference geometry objects to non-intersected regions.
+ * Returns the list of all reference objects of this object.
*/
- HYDRODATA_EXPORT virtual void SplitGeometryObjects();
+ HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
+public:
+ // Public methods to work with Calculation
/**
* Add new one reference geometry object for calculation case.
HYDRODATA_EXPORT virtual void RemoveGeometryObjects();
+ /**
+ * Add new one reference geometry group for calculation case.
+ */
+ HYDRODATA_EXPORT virtual bool AddGeometryGroup( const Handle(HYDROData_ShapesGroup)& theGroup );
+
+ /**
+ * Returns all reference geometry groups of calculation case.
+ */
+ HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGeometryGroups() const;
+
+ /**
+ * Removes reference geometry group from calculation case.
+ */
+ HYDRODATA_EXPORT virtual void RemoveGeometryGroup( const Handle(HYDROData_ShapesGroup)& theGroup );
+
+ /**
+ * Removes all reference geometry groups from calculation case.
+ */
+ HYDRODATA_EXPORT virtual void RemoveGeometryGroups();
+
+
+ /**
+ * Sets reference boundary polyline object for calculation case.
+ */
+ HYDRODATA_EXPORT virtual void SetBoundaryPolyline( const Handle(HYDROData_PolylineXY)& thePolyline );
+
+ /**
+ * Returns reference boundary polyline object of calculation case.
+ */
+ HYDRODATA_EXPORT virtual Handle(HYDROData_PolylineXY) GetBoundaryPolyline() const;
+
+ /**
+ * Remove reference boundary polyline object from calculation case.
+ */
+ HYDRODATA_EXPORT virtual void RemoveBoundaryPolyline();
+
+
/**
* Add new one child region for calculation case.
* The new region is added into the list of reference regions.
*/
HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetRegions() const;
+ /**
+ * Updates names of regions to correct order.
+ */
+ HYDRODATA_EXPORT virtual void UpdateRegionsOrder();
+
/**
* Removes reference region from calculation case.
*/
*/
HYDRODATA_EXPORT virtual void RemoveRegions();
+
+ /**
+ * Returns all reference geometry groups of calculation case.
+ */
+ HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetSplittedGroups() const;
+
+ /**
+ * Removes all reference geometry groups from calculation case.
+ */
+ HYDRODATA_EXPORT virtual void RemoveSplittedGroups();
+
+
+ /**
+ * Exports the calculation case data (shell and groups) to GEOM module.
+ * \param theGeomEngine GEOM module engine
+ * \param theStudy SALOMEDS study, is used for publishing of GEOM objects
+ * \return true in case of success
+ */
+ HYDRODATA_EXPORT virtual bool Export( GEOM::GEOM_Gen_var theGeomEngine,
+ SALOMEDS::Study_ptr theStudy );
+
+public:
+ // Public methods to work with Calculation services
+
+ /**
+ * Returns altitude for given point.
+ * \param thePoint the point to examine
+ * \return result altitude value
+ */
+ HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint ) const;
+
+ /**
+ * Returns zone to which the point is belongs.
+ * \param thePoint the point to examine
+ * \return result zone
+ */
+ HYDRODATA_EXPORT virtual Handle(HYDROData_Zone) GetZoneFromPoint( const gp_XY& thePoint ) const;
+
+ /**
+ * Returns classification of point for given zone.
+ * \param thePoint the point to examine
+ * \param theZone the zone to examine
+ * \return result classification
+ */
+ HYDRODATA_EXPORT virtual PointClassification GetPointClassification(
+ const gp_XY& thePoint,
+ const Handle(HYDROData_Zone)& theZone ) const;
+
private:
/**
*/
HYDRODATA_EXPORT virtual Handle(HYDROData_Region) addNewRegion();
+ /**
+ * Add new one splitted edges group for calculation case.
+ */
+ HYDRODATA_EXPORT virtual Handle(HYDROData_SplittedShapesGroup) addNewSplittedGroup();
+
+ /**
+ * Exports the given faces as shell and the given groups to GEOM module.
+ * \param theGeomEngine GEOM module engine
+ * \param theStudy SALOMEDS study, is used for publishing of GEOM objects
+ * \param theFaces the list of faces to make shell
+ * \param theSplittedGroups the list of groups
+ * \return true in case of success
+ */
+ HYDRODATA_EXPORT bool Export( GEOM::GEOM_Gen_var theGeomEngine,
+ SALOMEDS::Study_ptr theStudy,
+ const TopTools_ListOfShape& theFaces,
+ const HYDROData_SequenceOfObjects& theSplittedGroups );
+
+ /**
+ * Publish the given shape in GEOM as a GEOM object.
+ * \param theGeomEngine GEOM module engine
+ * \param theStudy SALOMEDS study, used for publishing of the shape
+ * \param theShape the shape to publish as a GEOM object
+ * \param theName the name of the published object
+ * \return the published GEOM object
+ */
+ GEOM::GEOM_Object_ptr publishShapeInGEOM( GEOM::GEOM_Gen_var theGeomEngine,
+ SALOMEDS::Study_ptr theStudy,
+ const TopoDS_Shape& theShape,
+ const QString& theName );
protected:
* Creates new object in the internal data structure. Use higher level objects
* to create objects with real content.
*/
- HYDROData_CalculationCase();
+ HYDRODATA_EXPORT HYDROData_CalculationCase();
/**
* Destructs properties of the object and object itself, removes it from the document.
*/
- ~HYDROData_CalculationCase();
+ HYDRODATA_EXPORT ~HYDROData_CalculationCase();
};
#endif
