Detailed Description

This class encapsulates the "Unix Timeval" time representation.

Definition at line 67 of file UnixTime.hpp.

#include <UnixTime.hpp>

Inheritance diagram for gnsstk::UnixTime:

Public Member Functions
UnixTime Basic Operations
Default and Copy Constructors, Assignment Operator and Destructor.
	UnixTime (int sec=0, int usec=0, TimeSystem ts=TimeSystem::Unknown)

	UnixTime (struct timeval t, TimeSystem ts=TimeSystem::Unknown)

	UnixTime (const UnixTime &right)

	UnixTime (const TimeTag &right)

	UnixTime (const CommonTime &right)

UnixTime &	operator= (const UnixTime &right)

virtual	~UnixTime ()
	Virtual Destructor. More...

virtual CommonTime	convertToCommonTime () const

virtual void	convertFromCommonTime (const CommonTime &ct)

virtual std::string	printf (const std::string &fmt) const

virtual std::string	printError (const std::string &fmt) const

virtual bool	setFromInfo (const IdToValue &info)

virtual std::string	getPrintChars () const

virtual std::string	getDefaultFormat () const
	Return a string containing the default format to use in printing. More...

virtual bool	isValid () const
	Returns true if this object's members are valid, false otherwise. More...

virtual void	reset ()
	Reset this object to the default state. More...

Public Member Functions inherited from gnsstk::TimeTag
virtual std::string	asString () const

bool	changeTimeSystem (TimeSystem timeSys)

bool	changeTimeSystem (TimeSystem timeSys, TimeSystemConverter *conv)

TimeSystem	getTimeSystem () const
	Obtain time system info (enum). More...

virtual	operator CommonTime () const

virtual void	scanf (const std::string &str, const std::string &fmt)

void	setTimeSystem (const TimeSystem &timeSys)
	Set method for internal variable timeSystem (enum). More...

	TimeTag ()
	Default constructor. More...

	TimeTag (const TimeSystem &ts)
	Constructor. More...

virtual	~TimeTag ()
	Virtual Destructor. More...

UnixTime Comparison Operators
All comparison operators have a parameter "right" which corresponds to the UnixTime object to the right of the symbol. All comparison operators are const and return true on success and false on failure.
struct timeval	tv

virtual bool	operator== (const UnixTime &right) const

virtual bool	operator!= (const UnixTime &right) const

virtual bool	operator< (const UnixTime &right) const

virtual bool	operator> (const UnixTime &right) const

virtual bool	operator<= (const UnixTime &right) const

virtual bool	operator>= (const UnixTime &right) const

Additional Inherited Members
Public Types inherited from gnsstk::TimeTag
typedef std::map< char, std::string >	IdToValue

Static Public Member Functions inherited from gnsstk::TimeTag
static void	checkTimeSystem (TimeSystem ts1, TimeSystem ts2)

static std::string	getError ()
	This returns the default error string for the TimeTag classes. More...

static std::string	getFormatPrefixFloat ()

static std::string	getFormatPrefixInt ()

static void	getInfo (const std::string &str, const std::string &fmt, IdToValue &info)

Protected Attributes inherited from gnsstk::TimeTag
TimeSystem	timeSystem
	time system (representation) of the data More...

Constructor & Destructor Documentation

◆ UnixTime() [1/5]

gnsstk::UnixTime::UnixTime	(	int	sec = `0`,
		int	usec = `0`,
		TimeSystem	ts = `TimeSystem::Unknown`
	)

inline

Default Constructor. All elements are initialized to zero.

Definition at line 80 of file UnixTime.hpp.

◆ UnixTime() [2/5]

gnsstk::UnixTime::UnixTime	(	struct timeval	t,
		TimeSystem	ts = `TimeSystem::Unknown`
	)

inline

struct timeval Constructor. Sets time according to the given struct timeval.

Definition at line 88 of file UnixTime.hpp.

◆ UnixTime() [3/5]

gnsstk::UnixTime::UnixTime ( const UnixTime & right )

inline

Copy Constructor.

Parameters

right a reference to the UnixTime object to copy

Definition at line 98 of file UnixTime.hpp.

◆ UnixTime() [4/5]

gnsstk::UnixTime::UnixTime ( const TimeTag & right )

inline

Alternate Copy Constructor. Takes a const TimeTag reference and copies its contents via conversion to CommonTime.

Parameters

right a const reference to the BasicTime object to copy

Exceptions

InvalidRequest on over-/under-flow

Definition at line 109 of file UnixTime.hpp.

◆ UnixTime() [5/5]

gnsstk::UnixTime::UnixTime ( const CommonTime & right )

inline

Alternate Copy Constructor. Takes a const CommonTime reference and copies its contents via the convertFromCommonTime method.

Parameters

right a const reference to the CommonTime object to copy

Exceptions

InvalidRequest on over-/under-flow

Definition at line 121 of file UnixTime.hpp.

◆ ~UnixTime()

virtual gnsstk::UnixTime::~UnixTime ( )

inlinevirtual

Virtual Destructor.

Definition at line 134 of file UnixTime.hpp.

Member Function Documentation

◆ convertFromCommonTime()

void gnsstk::UnixTime::convertFromCommonTime ( const CommonTime & ct )

virtual

Exceptions

InvalidRequest if ct cannot be correctly represented in this TimeTag object.

This is the earliest CommonTime for which UnixTimes are valid.

This is the latest CommonTime for which UnixTimes are valid. (2^31 - 1) s and 999999 us

Implements gnsstk::TimeTag.

Definition at line 71 of file UnixTime.cpp.

◆ convertToCommonTime()

CommonTime gnsstk::UnixTime::convertToCommonTime ( ) const

virtual

Exceptions

InvalidRequest if this TimeTag cannot be correctly represented by a CommonTime object.

Implements gnsstk::TimeTag.

Definition at line 54 of file UnixTime.cpp.

◆ getDefaultFormat()

virtual std::string gnsstk::UnixTime::getDefaultFormat ( ) const

inlinevirtual

Return a string containing the default format to use in printing.

Implements gnsstk::TimeTag.

Definition at line 167 of file UnixTime.hpp.

◆ getPrintChars()

virtual std::string gnsstk::UnixTime::getPrintChars ( ) const

inlinevirtual

Return a string containing the characters that this class understands when printing times.

Implements gnsstk::TimeTag.

Definition at line 161 of file UnixTime.hpp.

◆ isValid()

bool gnsstk::UnixTime::isValid ( ) const

virtual

Returns true if this object's members are valid, false otherwise.

Implements gnsstk::TimeTag.

Definition at line 176 of file UnixTime.cpp.

◆ operator!=()

bool gnsstk::UnixTime::operator!= ( const UnixTime & right ) const

virtual

Definition at line 209 of file UnixTime.cpp.

◆ operator<()

bool gnsstk::UnixTime::operator< ( const UnixTime & right ) const

virtual

Any (wildcard) type exception allowed, otherwise must be same time systems

Definition at line 214 of file UnixTime.cpp.

◆ operator<=()

bool gnsstk::UnixTime::operator<= ( const UnixTime & right ) const

virtual

Definition at line 242 of file UnixTime.cpp.

◆ operator=()

UnixTime & gnsstk::UnixTime::operator= ( const UnixTime & right )

Assignment Operator.

Parameters

right a const reference to the UnixTime to copy

Returns: a reference to this UnixTime

Definition at line 46 of file UnixTime.cpp.

◆ operator==()

bool gnsstk::UnixTime::operator== ( const UnixTime & right ) const

virtual

Any (wildcard) type exception allowed, otherwise must be same time systems

Definition at line 193 of file UnixTime.cpp.

◆ operator>()

bool gnsstk::UnixTime::operator> ( const UnixTime & right ) const

virtual

Definition at line 237 of file UnixTime.cpp.

◆ operator>=()

bool gnsstk::UnixTime::operator>= ( const UnixTime & right ) const

virtual

Definition at line 248 of file UnixTime.cpp.

◆ printError()

std::string gnsstk::UnixTime::printError ( const std::string & fmt ) const

virtual

This function works similarly to printf. Instead of filling the format with data, it fills with error messages.

Implements gnsstk::TimeTag.

Definition at line 126 of file UnixTime.cpp.

◆ printf()

std::string gnsstk::UnixTime::printf ( const std::string & fmt ) const

virtual

This function formats this time to a string. The exceptions thrown would only be due to problems parsing the fmt string.

Implements gnsstk::TimeTag.

Definition at line 105 of file UnixTime.cpp.

◆ reset()

void gnsstk::UnixTime::reset ( )

virtual

Reset this object to the default state.

Implements gnsstk::TimeTag.

Definition at line 187 of file UnixTime.cpp.

◆ setFromInfo()

bool gnsstk::UnixTime::setFromInfo ( const IdToValue & info )

virtual

Set this object using the information provided in info.

Parameters

info	the IdToValue object to which this object shall be set.

Returns: true if this object was successfully set using the data in info, false if not.

Implements gnsstk::TimeTag.

Definition at line 147 of file UnixTime.cpp.

Member Data Documentation

◆ tv

struct timeval gnsstk::UnixTime::tv

Definition at line 192 of file UnixTime.hpp.

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

Detailed Description

Public Member Functions

UnixTime Comparison Operators

Additional Inherited Members

Constructor & Destructor Documentation

◆ UnixTime() [1/5]

◆ UnixTime() [2/5]

◆ UnixTime() [3/5]

◆ UnixTime() [4/5]

◆ UnixTime() [5/5]

◆ ~UnixTime()

Member Function Documentation

◆ convertFromCommonTime()

◆ convertToCommonTime()

◆ getDefaultFormat()

◆ getPrintChars()

◆ isValid()

◆ operator!=()

◆ operator<()

◆ operator<=()

◆ operator=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ printError()

◆ printf()

◆ reset()

◆ setFromInfo()

Member Data Documentation

◆ tv