Qt Virtual Chart Table (QVCT)
Public Member Functions | Private Attributes | List of all members
CDataPositionValidity Class Reference

Position data validity. More...

#include <data/CDataPositionValidity.hpp>

Inheritance diagram for CDataPositionValidity:
CDataValidity CVesselPoint

Public Member Functions

 CDataPositionValidity ()
 
virtual ~CDataPositionValidity ()
 
void setValidityPosition (double _fdTimeLastPosition, double _fdErrorPosition, bool _bInvalidPosition=false)
 Sets the position's validity parameters. More...
 
void setValidityElevation (double _fdTimeLastElevation, double _fdErrorElevation, bool _bInvalidElevation=false)
 Sets the elevation's validity parameters. More...
 
double getTimeLastPosition () const
 Returns the position's last-set time, in seconds from Unix epoch. More...
 
double getErrorPosition () const
 Returns the position's error, in seconds. More...
 
bool isInvalidPosition () const
 Returns the position's (forced) invalidity status. More...
 
bool isValidPosition () const
 Returns the position's (global) validity status. More...
 
double getTimeLastElevation () const
 Returns the elevation's last-set time, in seconds from Unix epoch. More...
 
double getErrorElevation () const
 Returns the elevation's error, in seconds. More...
 
bool isInvalidElevation () const
 Returns the elevation's (forced) invalidity status. More...
 
bool isValidElevation () const
 Returns the elevation's (global) validity status. More...
 

Private Attributes

double fdTimeLastPosition
 Position last-set time, in seconds from Unix epoch. More...
 
double fdErrorPosition
 Position error, in meters. More...
 
bool bInvalidPosition
 Position (forced) invalidity status. More...
 
double fdTimeLastElevation
 Elevation last-set time, in seconds from Unix epoch. More...
 
double fdErrorElevation
 Elevation error, in meters. More...
 
bool bInvalidElevation
 Elevation (forced) invalidity status. More...
 

Additional Inherited Members

- Static Public Attributes inherited from CDataValidity
static constexpr double UNDEFINED_VALUE = -9999999
 
- Protected Member Functions inherited from CDataValidity
 CDataValidity ()
 
virtual ~CDataValidity ()
 

Detailed Description

Position data validity.

This class gathers all parameters and methods that allow to manage the validity of position data.

Author
Cedric Dufour http://cedric.dufour.name

Definition at line 32 of file CDataPositionValidity.hpp.

Constructor & Destructor Documentation

◆ CDataPositionValidity()

CDataPositionValidity::CDataPositionValidity ( )

Definition at line 31 of file CDataPositionValidity.cpp.

◆ ~CDataPositionValidity()

virtual CDataPositionValidity::~CDataPositionValidity ( )
inlinevirtual

Definition at line 67 of file CDataPositionValidity.hpp.

Member Function Documentation

◆ setValidityPosition()

void CDataPositionValidity::setValidityPosition ( double  _fdTimeLastPosition,
double  _fdErrorPosition,
bool  _bInvalidPosition = false 
)
inline

Sets the position's validity parameters.

Definition at line 77 of file CDataPositionValidity.hpp.

◆ setValidityElevation()

void CDataPositionValidity::setValidityElevation ( double  _fdTimeLastElevation,
double  _fdErrorElevation,
bool  _bInvalidElevation = false 
)
inline

Sets the elevation's validity parameters.

Definition at line 80 of file CDataPositionValidity.hpp.

◆ getTimeLastPosition()

double CDataPositionValidity::getTimeLastPosition ( ) const
inline

Returns the position's last-set time, in seconds from Unix epoch.

Definition at line 86 of file CDataPositionValidity.hpp.

◆ getErrorPosition()

double CDataPositionValidity::getErrorPosition ( ) const
inline

Returns the position's error, in seconds.

Definition at line 88 of file CDataPositionValidity.hpp.

◆ isInvalidPosition()

bool CDataPositionValidity::isInvalidPosition ( ) const
inline

Returns the position's (forced) invalidity status.

Definition at line 90 of file CDataPositionValidity.hpp.

◆ isValidPosition()

bool CDataPositionValidity::isValidPosition ( ) const

Returns the position's (global) validity status.

NOTE: this take into account the position's last-set time and error, based on application settings

Definition at line 49 of file CDataPositionValidity.cpp.

◆ getTimeLastElevation()

double CDataPositionValidity::getTimeLastElevation ( ) const
inline

Returns the elevation's last-set time, in seconds from Unix epoch.

Definition at line 96 of file CDataPositionValidity.hpp.

◆ getErrorElevation()

double CDataPositionValidity::getErrorElevation ( ) const
inline

Returns the elevation's error, in seconds.

Definition at line 98 of file CDataPositionValidity.hpp.

◆ isInvalidElevation()

bool CDataPositionValidity::isInvalidElevation ( ) const
inline

Returns the elevation's (forced) invalidity status.

Definition at line 100 of file CDataPositionValidity.hpp.

◆ isValidElevation()

bool CDataPositionValidity::isValidElevation ( ) const

Returns the elevation's (global) validity status.

NOTE: this take into account the elevation's last-set time and error, based on application settings

Definition at line 57 of file CDataPositionValidity.cpp.

Member Data Documentation

◆ fdTimeLastPosition

double CDataPositionValidity::fdTimeLastPosition
private

Position last-set time, in seconds from Unix epoch.

See also
setValidityPosition(), getTimeLastPosition()

Definition at line 42 of file CDataPositionValidity.hpp.

◆ fdErrorPosition

double CDataPositionValidity::fdErrorPosition
private

Position error, in meters.

See also
setValidityPosition(), getErrorPosition()

Definition at line 45 of file CDataPositionValidity.hpp.

◆ bInvalidPosition

bool CDataPositionValidity::bInvalidPosition
private

Position (forced) invalidity status.

See also
setValidityPosition(), isInvalidPosition()

Definition at line 48 of file CDataPositionValidity.hpp.

◆ fdTimeLastElevation

double CDataPositionValidity::fdTimeLastElevation
private

Elevation last-set time, in seconds from Unix epoch.

See also
setValidityElevation(), getTimeLastElevation()

Definition at line 52 of file CDataPositionValidity.hpp.

◆ fdErrorElevation

double CDataPositionValidity::fdErrorElevation
private

Elevation error, in meters.

See also
setValidityElevation(), getErrorElevation()

Definition at line 55 of file CDataPositionValidity.hpp.

◆ bInvalidElevation

bool CDataPositionValidity::bInvalidElevation
private

Elevation (forced) invalidity status.

See also
setValidityElevation(), isInvalidElevation()

Definition at line 58 of file CDataPositionValidity.hpp.

The documentation for this class was generated from the following files: