CDataTimeValidity Class Reference

Time data validity. More...

#include <data/CDataTimeValidity.hpp>

Inheritance diagram for CDataTimeValidity:

Public Member Functions
	CDataTimeValidity ()
virtual	~CDataTimeValidity ()
void	setValidityTime (double _fdTimeLastTime, double _fdErrorTime, bool _bInvalidTime=false)
	Sets the time's validity parameters. More...
double	getTimeLastTime () const
	Returns the time's last-set time, in seconds from Unix epoch. More...
double	getErrorTime () const
	Returns the time's error, in seconds. More...
bool	isInvalidTime () const
	Returns the time's (forced) invalidity status. More...
bool	isValidTime () const
	Returns the time's (global) validity status. More...

Private Attributes
double	fdTimeLastTime
	Time last-set time, in seconds from Unix epoch. More...
double	fdErrorTime
	Time error, in seconds. More...
bool	bInvalidTime
	Time (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

Time data validity.

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

Author

Cedric Dufour http://cedric.dufour.name

Definition at line 32 of file CDataTimeValidity.hpp.

Constructor & Destructor Documentation

CDataTimeValidity()

CDataTimeValidity::CDataTimeValidity

(

)

Definition at line 31 of file CDataTimeValidity.cpp.

~CDataTimeValidity()

virtual CDataTimeValidity::~CDataTimeValidity ( )

inlinevirtual

Definition at line 57 of file CDataTimeValidity.hpp.

Member Function Documentation

setValidityTime()

void CDataTimeValidity::setValidityTime ( double  _fdTimeLastTime, double  _fdErrorTime, bool  _bInvalidTime = false  )

inline

Sets the time's validity parameters.

Definition at line 67 of file CDataTimeValidity.hpp.

getTimeLastTime()

double CDataTimeValidity::getTimeLastTime ( ) const

inline

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

Definition at line 73 of file CDataTimeValidity.hpp.

getErrorTime()

double CDataTimeValidity::getErrorTime ( ) const

inline

Returns the time's error, in seconds.

Definition at line 75 of file CDataTimeValidity.hpp.

isInvalidTime()

bool CDataTimeValidity::isInvalidTime ( ) const

inline

Returns the time's (forced) invalidity status.

Definition at line 77 of file CDataTimeValidity.hpp.

isValidTime()

bool CDataTimeValidity::isValidTime

(

)

const

Returns the time's (global) validity status.

NOTE: this take into account the time's error, based on application settings

Definition at line 46 of file CDataTimeValidity.cpp.

Member Data Documentation

fdTimeLastTime

double CDataTimeValidity::fdTimeLastTime

private

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

See also

setValidityTime(), getTimeLastTime()

Definition at line 42 of file CDataTimeValidity.hpp.

fdErrorTime

double CDataTimeValidity::fdErrorTime

private

Time error, in seconds.

See also

setValidityTime(), getErrorTime()

Definition at line 45 of file CDataTimeValidity.hpp.

bInvalidTime

bool CDataTimeValidity::bInvalidTime

private

Time (forced) invalidity status.

See also

setValidityTime(), isInvalidTime()

Definition at line 48 of file CDataTimeValidity.hpp.

---

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

• data/CDataTimeValidity.hpp
• data/CDataTimeValidity.cpp