2 #ifndef HYDROData_Bathymetry_HeaderFile
3 #define HYDROData_Bathymetry_HeaderFile
5 #include <HYDROData_Object.h>
12 DEFINE_STANDARD_HANDLE(HYDROData_Bathymetry, HYDROData_Object)
15 /**\class HYDROData_Bathymetry
16 * \brief Class that stores/retreives information about the Bathymetry.
18 * The Bathymetry represents measurement of the altitude of points on the terrain.
20 class HYDROData_Bathymetry : public HYDROData_Object
24 typedef gp_XYZ AltitudePoint;
25 typedef QList<AltitudePoint> AltitudePoints;
30 * Enumeration of tags corresponding to the persistent object parameters.
34 DataTag_First = HYDROData_Object::DataTag_First + 100, ///< first tag, to reserve
35 DataTag_AltitudePoints, ///< altitude points, array of reals
36 DataTag_FilePath ///< bathymetry imported file path
41 DEFINE_STANDARD_RTTI(HYDROData_Bathymetry);
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_BATHYMETRY; }
50 * Dump Bathymetry object to Python script representation.
52 HYDRODATA_EXPORT virtual QStringList DumpToPython( MapOfTreatedObjects& theTreatedObjects ) const;
55 // Public methods to work with Bathymetry altitudes.
58 * Returns altitude points list.
61 HYDRODATA_EXPORT static double GetInvalidAltitude();
64 * Replace current altitude points by new one.
65 * \param thePoints the altitude points list
67 HYDRODATA_EXPORT virtual void SetAltitudePoints( const AltitudePoints& thePoints );
70 * Returns altitude points list.
73 HYDRODATA_EXPORT virtual AltitudePoints GetAltitudePoints() const;
76 * Remove all altitude points.
78 HYDRODATA_EXPORT virtual void RemoveAltitudePoints();
81 * Returns altitude for given point.
82 * \param thePoint the point to examine
83 * \return altitude value
85 HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const QPointF& thePoint ) const;
88 * Returns altitude for given point.
89 * \param thePoint the point to examine
90 * \return altitude value
92 HYDRODATA_EXPORT virtual double GetAltitudeForPoint( const gp_XY& thePoint ) const;
96 // Public methods to work with files.
99 * Stores the bathymetry file path
100 * \param theFilePath image file path
102 HYDRODATA_EXPORT void SetFilePath( const QString& theFilePath );
105 * Returns uploaded bathymetry file path
107 HYDRODATA_EXPORT QString GetFilePath() const;
110 * Imports Bathymetry data from file. The supported file types:
112 * \param theFileName the path to file
113 * \return \c true if file has been successfully read
115 HYDRODATA_EXPORT virtual bool ImportFromFile( const QString& theFileName );
121 * Imports Bathymetry data from 'XYZ' file.
123 bool importFromXYZFile( QFile& theFile,
124 AltitudePoints& thePoints );
128 friend class HYDROData_Iterator;
131 * Creates new object in the internal data structure. Use higher level objects
132 * to create objects with real content.
134 HYDROData_Bathymetry();
137 * Destructs properties of the object and object itself, removes it from the document.
139 ~HYDROData_Bathymetry();