profile.h

Go to the documentation of this file.

 
#ifndef PROFILE_H
#define PROFILE_H
/* ===============================================================================================================================
 
   This file is part of CoastalME, the Coastal Modelling Environment.
 
   CoastalME is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
 
   This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 
   You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
===============================================================================================================================*/
#include <vector>
using std::vector;
 
#include "2d_point.h"
#include "2di_point.h"
#include "multi_line.h"
#include "raster_grid.h"
 
class CGeomProfile : public CGeomMultiLine
{
 private:
   bool m_bStartOfCoast;

   bool m_bEndOfCoast;

   bool m_bCShoreProblem;

   bool m_bHitLand;

   bool m_bHitIntervention;

   bool m_bHitCoast;

   bool m_bTooShort;

   bool m_bTruncated;

   bool m_bHitAnotherProfile;

   bool m_bIntervention;

   int m_nCoast;

   int m_nCoastPoint;

   int m_nCoastID;

   int m_nGlobalID;

   double m_dDeepWaterWaveHeight;

   double m_dDeepWaterWaveAngle;

   double m_dDeepWaterWavePeriod;

   CGeom2DIPoint PtiStart;

   CGeom2DIPoint PtiEnd;

   CGeomProfile* m_pUpCoastAdjacentProfile;

   CGeomProfile* m_pDownCoastAdjacentProfile;

   vector<CGeom2DIPoint> m_VCellInProfile;
 
   // The following have the same length as m_VCellInProfile
   vector<CGeom2DPoint> m_VCellInProfileExtCRS;
 
   // Is this profile point part of a multi-line?
   // vector<bool> m_bVShared;
 
 protected:
 public:
   explicit CGeomProfile(int const, int const, int const, int const, CGeom2DIPoint const*, CGeom2DIPoint const*, bool const);
   ~CGeomProfile(void) override;
 
   int nGetCoastID(void) const;
   int nGetGlobalID(void) const;
   int nGetCoastPoint(void) const;
 
   CGeom2DIPoint* pPtiGetStartPoint(void);
   void SetEndPoint(CGeom2DIPoint const*);
   CGeom2DIPoint* pPtiGetEndPoint(void);
 
   void SetStartOfCoast(bool const);
   bool bStartOfCoast(void) const;
   void SetEndOfCoast(bool const);
   bool bEndOfCoast(void) const;
 
   void SetCShoreProblem(bool const);
   bool bCShoreProblem(void) const;
 
   void SetHitLand(bool const);
   bool bHitLand(void) const;
   void SetHitIntervention(bool const);
   bool bHitIntervention(void) const;
   void SetHitCoast(bool const);
   bool bHitCoast(void) const;
   void SetTooShort(bool const);
   bool bTooShort(void) const;
   void SetTruncated(bool const);
   bool bTruncated(void) const;
   void SetHitAnotherProfile(bool const);
   bool bHitAnotherProfile(void) const;
 
   bool bProfileOK(void) const;
   bool bProfileOKIncTruncated(void) const;
   bool bOKIncStartAndEndOfCoast(void) const;
   // bool bOKIncStartOfCoast(void) const;
 
   void SetPointsInProfile(vector<CGeom2DPoint> const*);
   void SetPointInProfile(int const, double const, double const);
   void AppendPointInProfile(double const, double const);
   void AppendPointInProfile(CGeom2DPoint const*);
   void TruncateProfile(int const);
   // void TruncateAndSetPointInProfile(int const, double const, double const);
   bool bInsertIntersection(double const, double const, int const);
   // void ShowProfile(void) const;
   int nGetProfileSize(void) const;
   CGeom2DPoint* pPtGetPointInProfile(int const);
   CGeom2DIPoint* pPtiGetLastCellInProfile(void);
   vector<CGeom2DPoint> PtVGetThisPointAndAllAfter(int const);
   // void RemoveLineSegment(int const);
   bool bIsPointInProfile(double const, double const);
   bool bIsPointInProfile(double const, double const, int&);
   // int nFindInsertionLineSeg(double const, double const);
 
   // void AppendPointShared(bool const);
   // bool bPointShared(int const) const;
 
   void SetUpCoastAdjacentProfile(CGeomProfile*);
   CGeomProfile* pGetUpCoastAdjacentProfile(void) const;
   void SetDownCoastAdjacentProfile(CGeomProfile*);
   CGeomProfile* pGetDownCoastAdjacentProfile(void) const;
 
   void AppendCellInProfile(CGeom2DIPoint const*);
   void AppendCellInProfile(int const, int const);
   // void SetCellsInProfile(vector<CGeom2DIPoint>*);
   vector<CGeom2DIPoint>* pPtiVGetCellsInProfile(void);
   CGeom2DIPoint* pPtiGetCellInProfile(int const);
   int nGetNumCellsInProfile(void) const;
 
   void AppendCellInProfileExtCRS(double const, double const);
   void AppendCellInProfileExtCRS(CGeom2DPoint const*);
   // vector<CGeom2DPoint>* PtVGetCellsInProfileExtCRS(void);
 
   int nGetCellGivenDepth(CGeomRasterGrid const*, double const);
 
   void SetProfileDeepWaterWaveHeight(double const);
   double dGetProfileDeepWaterWaveHeight(void) const;
 
   void SetProfileDeepWaterWaveAngle(double const);
   double dGetProfileDeepWaterWaveAngle(void) const;
 
   void SetProfileDeepWaterWavePeriod(double const);
   double dGetProfileDeepWaterWavePeriod(void) const;
 
   bool bIsIntervention(void) const;
};
#endif // PROFILE_H