NAV::TimeSystem Class Reference

Time System defintions. More...

Public Types
enum class	TimeSystemEnum : uint8_t {   TimeSys_None ,   UTC ,   GPST ,   GLNT ,   GST ,   BDT ,   QZSST ,   IRNSST ,   COUNT }
	Continuous enum for the time systems. More...

Public Member Functions
TimeSystemEnum	getEnumValue () const
	Returns the enum value (only one must be set)
constexpr	operator bool ()=delete
	Prevent usage: if(...)
constexpr	operator int () const
	int conversion operator
	operator std::string () const
	std::string conversion operator
constexpr	operator TimeSystem_ () const
	Allow switch(TimeSystem_(type)) and comparisons.
constexpr TimeSystem &	operator= (TimeSystem_ v)
	Assignment operator from Value type.
constexpr	TimeSystem ()=default
	Default Constructor.
constexpr	TimeSystem (TimeSystem_ type)
	Implicit Constructor from Value type.
constexpr	TimeSystem (TimeSystemEnum timeSystem)
constexpr const char *	toString () const
	Converts the time system into a string.

Static Public Member Functions
static TimeSystem	fromString (const std::string &typeString)
	Construct new object from std::string.
static TimeSystemEnum	GetTimeSystemEnumValue (TimeSystem timeSystem)
	Returns the enum value (only one must be set)

Private Attributes
TimeSystem_	value
	Internal value.

Friends
constexpr bool	operator== (const TimeSystem &lhs, const TimeSystem &rhs)
	Equal compares values.

Detailed Description

Time System defintions.

Definition at line 39 of file TimeSystem.hpp.

Member Enumeration Documentation

TimeSystemEnum

enum class NAV::TimeSystem::TimeSystemEnum : uint8_t

strong

Continuous enum for the time systems.

Enumerator
TimeSys_None	No Time system.
UTC	Coordinated Universal Time.
GPST	GPS Time.
GLNT	GLONASS Time (GLONASST)
GST	Galileo System Time.
BDT	BeiDou Time.
QZSST	Quasi-Zenith Satellite System Time.
IRNSST	Indian Regional Navigation Satellite System Time.
COUNT	Amount of items in the enum.

Definition at line 138 of file TimeSystem.hpp.

Constructor & Destructor Documentation

TimeSystem() [1/3]

NAV::TimeSystem::TimeSystem ( )

constexprdefault

Default Constructor.

TimeSystem() [2/3]

NAV::TimeSystem::TimeSystem ( TimeSystem_ type )

inlineconstexpr

Implicit Constructor from Value type.

Parameters

[in]

type

Value type to construct from

Definition at line 47 of file TimeSystem.hpp.

TimeSystem() [3/3]

NAV::TimeSystem::TimeSystem ( TimeSystemEnum timeSystem )

inlineconstexpr

Constructor

Parameters

[in]

timeSystem

Time system enum value

Definition at line 160 of file TimeSystem.hpp.

Member Function Documentation

fromString()

TimeSystem NAV::TimeSystem::fromString ( const std::string & typeString )

inlinestatic

Construct new object from std::string.

Parameters

[in]

typeString

String representation of the TimeSystem

Definition at line 53 of file TimeSystem.hpp.

getEnumValue()

TimeSystem::TimeSystemEnum NAV::TimeSystem::getEnumValue ( ) const

nodiscard

Returns the enum value (only one must be set)

Definition at line 20 of file TimeSystem.cpp.

GetTimeSystemEnumValue()

TimeSystemEnum NAV::TimeSystem::GetTimeSystemEnumValue ( TimeSystem timeSystem )

static

Returns the enum value (only one must be set)

Parameters

timeSystem

Time system

operator bool()

NAV::TimeSystem::operator bool ( )

explicitconstexprdelete

Prevent usage: if(...)

operator int()

NAV::TimeSystem::operator int ( ) const

inlineexplicitconstexpr

int conversion operator

Returns

A int representation of the type

Definition at line 105 of file TimeSystem.hpp.

operator std::string()

NAV::TimeSystem::operator std::string ( ) const

inlineexplicit

std::string conversion operator

Returns

A std::string representation of the type

Definition at line 109 of file TimeSystem.hpp.

operator TimeSystem_()

NAV::TimeSystem::operator TimeSystem_ ( ) const

inlineexplicitconstexpr

Allow switch(TimeSystem_(type)) and comparisons.

Definition at line 99 of file TimeSystem.hpp.

operator=()

TimeSystem & NAV::TimeSystem::operator= ( TimeSystem_ v )

inlineconstexpr

Assignment operator from Value type.

Parameters

[in]

v

Value type to construct from

Returns

The Type type from the value type

Definition at line 90 of file TimeSystem.hpp.

toString()

const char * NAV::TimeSystem::toString ( ) const

inlinenodiscardconstexpr

Converts the time system into a string.

Definition at line 112 of file TimeSystem.hpp.

Friends And Related Symbol Documentation

operator==

bool operator== ( const TimeSystem & lhs, const TimeSystem & rhs )

friend

Equal compares values.

Parameters

[in]	lhs	Left-hand side of the operator
[in]	rhs	Right-hand side of the operator

Returns

Whether the comparison was successful

Definition at line 365 of file TimeSystem.hpp.

Field Documentation

value

TimeSystem_ NAV::TimeSystem::value

private

Internal value.

Definition at line 193 of file TimeSystem.hpp.

---

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

• /home/runner/work/INSTINCT/INSTINCT/src/Navigation/Time/TimeSystem.hpp
• /home/runner/work/INSTINCT/INSTINCT/src/Navigation/Time/TimeSystem.cpp