gnsstk::RefFrame Class Reference

Detailed Description

Class for keeping track of specific reference frame system and realization pairs.

Definition at line 53 of file RefFrame.hpp.

#include <RefFrame.hpp>

Public Member Functions
RefFrameRlz	getRealization () const noexcept
	Return the reference frame realization represented by this object. More...
RefFrameSys	getSystem () const noexcept
	Return the reference frame system represented by this object. More...
bool	operator!= (const RefFrame &right) const noexcept
	Compare this with right. More...
bool	operator< (const RefFrame &right) const noexcept
	Ordering for maps etc. More...
bool	operator== (const RefFrame &right) const noexcept
	Compare this with right. More...
bool	operator== (ReferenceFrame orf) const noexcept
	RefFrame ()
	Set both system and realization to Unknown. More...
	RefFrame (const std::string &str, const gnsstk::CommonTime &when)
	RefFrame (ReferenceFrame orf, const gnsstk::CommonTime &when)
	RefFrame (RefFrameRlz rlz)
	RefFrame (RefFrameSys sys, const gnsstk::CommonTime &when)

Private Attributes
RefFrameRlz	realization
	The reference frame realization this object represents. More...
RefFrameSys	system
	The reference frame system this object represents. More...

Friends
std::ostream &	operator<< (std::ostream &s, const RefFrame &rf)

Constructor & Destructor Documentation

RefFrame() [1/5]

gnsstk::RefFrame::RefFrame

(

)

Set both system and realization to Unknown.

Definition at line 45 of file RefFrame.cpp.

RefFrame() [2/5]

gnsstk::RefFrame::RefFrame

(

RefFrameRlz

rlz

)

Construct a RefFrame from a RefFrameRlz. The system is set from an assumption based on the specified realization.

See also

getRefFrameSys().

Postcondition

system and realization are set.

Parameters

[in]

rlz

The reference frame realization being used.

Definition at line 53 of file RefFrame.cpp.

RefFrame() [3/5]

gnsstk::RefFrame::RefFrame	(	RefFrameSys	sys,
		const gnsstk::CommonTime &	when
	)

Construct a RefFrame from a RefFrameSys and a time stamp. The realization is set based on the time of publication.

See also

getRefFrameRlz().

Postcondition

system and realization are set.

Parameters

[in]	sys	The reference frame system being used.
[in]	when	The timestamp when the reference frame system was being used, maps to a realization.

Definition at line 61 of file RefFrame.cpp.

RefFrame() [4/5]

gnsstk::RefFrame::RefFrame	(	const std::string &	str,
		const gnsstk::CommonTime &	when
	)

Construct from a string representation of a realization (e.g. from an SP3 file header).

Postcondition

system and realization are set.

Parameters

[in]	str	The string representation of the ref frame realization
[in]	when	The time the reference frame is being used. If str is insufficient on its own to translate to a realization, str will be treated as a system and an attempt will be made to convert the system + when to a realization.

Definition at line 69 of file RefFrame.cpp.

RefFrame() [5/5]

gnsstk::RefFrame::RefFrame	(	ReferenceFrame	orf,
		const gnsstk::CommonTime &	when
	)

Deprecated:

This is a temporary implementation to maintain some usability of the original HelmertTransform class and will be removed in the future.

Definition at line 114 of file RefFrame.cpp.

Member Function Documentation

getRealization()

RefFrameRlz gnsstk::RefFrame::getRealization ( ) const

inlinenoexcept

Return the reference frame realization represented by this object.

Definition at line 95 of file RefFrame.hpp.

getSystem()

RefFrameSys gnsstk::RefFrame::getSystem ( ) const

inlinenoexcept

Return the reference frame system represented by this object.

Definition at line 92 of file RefFrame.hpp.

operator!=()

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

inlinenoexcept

Compare this with right.

Definition at line 87 of file RefFrame.hpp.

operator<()

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

noexcept

Ordering for maps etc.

Definition at line 86 of file RefFrame.cpp.

operator==() [1/2]

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

inlinenoexcept

Compare this with right.

Definition at line 84 of file RefFrame.hpp.

operator==() [2/2]

bool gnsstk::RefFrame::operator== ( ReferenceFrame  orf ) const

noexcept

Deprecated:

This is a temporary implementation to maintain some usability of the original HelmertTransform class and will be removed in the future.

Definition at line 96 of file RefFrame.cpp.

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  s, const RefFrame &  rf  )

friend

Stream output operator for RefFrame, obviously.

Parameters

[in,out]	s	The stream to write to.
[in]	rf	The RefFrame object to write.

Returns

the reference s, after writing.

Definition at line 124 of file RefFrame.hpp.

Member Data Documentation

realization

RefFrameRlz gnsstk::RefFrame::realization

private

The reference frame realization this object represents.

Definition at line 110 of file RefFrame.hpp.

system

RefFrameSys gnsstk::RefFrame::system

private

The reference frame system this object represents.

Definition at line 108 of file RefFrame.hpp.

---

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

• RefFrame.hpp
• RefFrame.cpp