3 #ifndef HYDROData_CalculationCase_HeaderFile
4 #define HYDROData_CalculationCase_HeaderFile
6 #include <HYDROData_Entity.h>
10 class Handle(HYDROData_Object);
11 class Handle(HYDROData_Region);
12 class Handle(HYDROData_Zone);
13 class Handle(HYDROData_PolylineXY);
15 DEFINE_STANDARD_HANDLE(HYDROData_CalculationCase, HYDROData_Entity)
18 /**\class HYDROData_CalculationCase
19 * \brief Calculation case is defined by selection of Geometry objects with or without
\93Zone of water
\94.
22 class HYDROData_CalculationCase : public HYDROData_Entity
28 * Enumeration of tags corresponding to the persistent object parameters.
32 DataTag_First = HYDROData_Entity::DataTag_First + 100, ///< first tag, to reserve
33 DataTag_GeometryObject, ///< reference geometry objects
34 DataTag_ChildRegion, ///< child regions
35 DataTag_Region, ///< reference regions
36 DataTag_Polyline ///< reference boundary polyline
41 DEFINE_STANDARD_RTTI(HYDROData_CalculationCase);
44 * Returns the kind of this object. Must be redefined in all objects of known type.
46 HYDRODATA_EXPORT virtual const ObjectKind GetKind() const { return KIND_CALCULATION; }
49 * Updates the name of this object.
50 * Reimplemented to update the names of regions and zones.
52 HYDRODATA_EXPORT virtual void SetName( const QString& theName );
55 * Dump Calculation object to Python script representation.
57 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
60 * Update the calcualtion case object.
61 * Call this method whenever you made changes for object data.
63 HYDRODATA_EXPORT virtual void Update();
66 * Returns the list of all reference objects of this object.
68 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetAllReferenceObjects() const;
71 // Public methods to work with Calculation
74 * Add new one reference geometry object for calculation case.
76 HYDRODATA_EXPORT virtual bool AddGeometryObject( const Handle(HYDROData_Object)& theObject );
79 * Returns all reference geometry objects of calculation case.
81 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetGeometryObjects() const;
84 * Removes reference geometry object from calculation case.
86 HYDRODATA_EXPORT virtual void RemoveGeometryObject( const Handle(HYDROData_Object)& theObject );
89 * Removes all reference geometry objects from calculation case.
91 HYDRODATA_EXPORT virtual void RemoveGeometryObjects();
95 * Sets reference boundary polyline object for calculation case.
97 HYDRODATA_EXPORT virtual void SetBoundaryPolyline( const Handle(HYDROData_PolylineXY)& thePolyline );
100 * Returns reference boundary polyline object of calculation case.
102 HYDRODATA_EXPORT virtual Handle(HYDROData_PolylineXY) GetBoundaryPolyline() const;
105 * Remove reference boundary polyline object from calculation case.
107 HYDRODATA_EXPORT virtual void RemoveBoundaryPolyline();
111 * Add new one child region for calculation case.
112 * The new region is added into the list of reference regions.
113 * The label of theZone is changed during this operation
114 * because of new region becomes the new parent for this zone.
116 HYDRODATA_EXPORT virtual Handle(HYDROData_Region) AddNewRegion( const Handle(HYDROData_Zone)& theZone );
120 * Add new one reference region for calculation case.
121 * The label of theRegion is changed in case if old parent is not this calculation.
123 HYDRODATA_EXPORT virtual bool AddRegion( const Handle(HYDROData_Region)& theRegion );
126 * Returns all reference regions of calculation case.
128 HYDRODATA_EXPORT virtual HYDROData_SequenceOfObjects GetRegions() const;
131 * Updates names of regions to correct order.
133 HYDRODATA_EXPORT virtual void UpdateRegionsOrder();
136 * Removes reference region from calculation case.
138 HYDRODATA_EXPORT virtual void RemoveRegion( const Handle(HYDROData_Region)& theRegion );
141 * Removes all reference regions from calculation case.
143 HYDRODATA_EXPORT virtual void RemoveRegions();
146 * Returns shell containing faces which correspond to regions.
147 * \return shell as TopoDS_Shell
149 HYDRODATA_EXPORT virtual TopoDS_Shell GetShell();
154 * Add new one region for calculation case.
155 * The new region is added into the list of reference regions.
157 HYDRODATA_EXPORT virtual Handle(HYDROData_Region) addNewRegion();
162 friend class HYDROData_Iterator;
165 * Creates new object in the internal data structure. Use higher level objects
166 * to create objects with real content.
168 HYDRODATA_EXPORT HYDROData_CalculationCase();
171 * Destructs properties of the object and object itself, removes it from the document.
173 HYDRODATA_EXPORT ~HYDROData_CalculationCase();