Detailed Description
Provide an abstract base class for tools that can transform between coordinate systems, e.g. HelmertTransformer.
Definition at line 57 of file Transformer.hpp.
#include <Transformer.hpp>
Public Member Functions | |
| const CommonTime & | getEpoch () const noexcept |
| const RefFrame & | getFromFrame () const noexcept |
| Return the RefFrame this Transformer will convert from. More... | |
| const RefFrame & | getToFrame () const noexcept |
| Return the RefFrame this Transformer will convert to. More... | |
| virtual bool | transform (const Position &fromPos, Position &toPos) const noexcept=0 |
| virtual bool | transform (const Triple &fromPos, const RefFrame &srcFrame, Triple &toPos) const noexcept=0 |
| virtual bool | transform (const Vector< double > &fromPos, const RefFrame &srcFrame, Vector< double > &toPos) const noexcept=0 |
| virtual bool | transform (const Xvt &fromPos, Xvt &toPos) const noexcept=0 |
| virtual bool | transform (double fx, double fy, double fz, const RefFrame &srcFrame, double &tx, double &ty, double &tz) const noexcept=0 |
| Transformer () | |
Protected Attributes | |
| CommonTime | epoch |
| When this Transformer was first applicable. More... | |
| RefFrame | fromFrame |
| The reference frame we can transform from. More... | |
| RefFrame | toFrame |
| The reference frame we can transform to. More... | |
Constructor & Destructor Documentation
◆ Transformer()
|
inline |
Definition at line 61 of file Transformer.hpp.
Member Function Documentation
◆ getEpoch()
|
inlinenoexcept |
Return the first time this Transformer is applicable. This is not the reference frame publication date. This is to allow the use of transformation sources that use the same reference frame realizations, but the transformation parameters change over time.
Definition at line 153 of file Transformer.hpp.
◆ getFromFrame()
Return the RefFrame this Transformer will convert from.
Definition at line 143 of file Transformer.hpp.
◆ getToFrame()
Return the RefFrame this Transformer will convert to.
Definition at line 146 of file Transformer.hpp.
◆ transform() [1/5]
|
pure virtualnoexcept |
Convert a position from the reference frame in fromPos to that in toPos.
- Precondition
- RefFrame must be set in both fromPos and toPos.
- Coordinates must be set in fromPos.
- Postcondition
- Coordinates in toPos reference frame realization are set in toPos.
- Parameters
-
[in] fromPos The Position to be converted. [in,out] toPos The Position to store the converted position.
- Returns
- true on success, false on failure (typically if the Position RefFrame objects don't match the ones in this Transformer).
Implemented in gnsstk::HelmertTransformer, and FakeTransformer.
◆ transform() [2/5]
|
pure virtualnoexcept |
Convert a position in fromPos from the reference frame in srcFrame to that in tgtFrame.
- Precondition
- Coordinates must be set in fromPos.
- Postcondition
- Coordinates in toFrame reference frame realization are set in toPos. Velocity and clock offset are unaffected.
- Parameters
-
[in] fromPos The Vector whose position is to be converted. [in] srcFrame The RefFrame of the coordinates in fromPos. [out] toPos The Vector to store the converted position.
- Returns
- true on success, false on failure (typically if srcFrame doesn't match fromFrame).
Implemented in gnsstk::HelmertTransformer, and FakeTransformer.
◆ transform() [3/5]
|
pure virtualnoexcept |
Convert a position from the reference frame in fromPos to that in toPos.
- Precondition
- Coordinates must be set in fromPos.
- Postcondition
- Coordinates in toFrame reference frame realization are set in toPos. Velocity and clock offset are unaffected.
- Parameters
-
[in] fromPos The Vector whose position is to be converted. [in] srcFrame The RefFrame of the coordinates in fromPos. [out] toPos The Vector to store the converted position.
- Returns
- true on success, false on failure (typically if srcFrame doesn't match fromFrame).
Implemented in gnsstk::HelmertTransformer, and FakeTransformer.
◆ transform() [4/5]
|
pure virtualnoexcept |
Convert a position from the reference frame in fromPos to that in toPos.
- Precondition
- RefFrame must be set in both fromPos and toPos.
- Coordinates must be set in fromPos.
- Postcondition
- Coordinates in toPos reference frame realization are set in toPos. Velocity and clock offset are unaffected.
- Parameters
-
[in] fromPos The Xvt whose position is to be converted. [in,out] toPos The Xvt to store the converted position.
- Returns
- true on success, false on failure (typically if the Xvt RefFrame objects don't match the ones in this Transformer).
Implemented in gnsstk::HelmertTransformer, and FakeTransformer.
◆ transform() [5/5]
|
pure virtualnoexcept |
Convert 3 doubles from the reference frame in srcFrame to that in tgtFrame.
- Precondition
- Coordinates must be set in fromPos.
- Postcondition
- Coordinates in toFrame reference frame realization are set in toPos. Velocity and clock offset are unaffected.
- Parameters
-
[in] fx ECEF x coordinate in meters in srcFrame. [in] fy ECEF y coordinate in meters in srcFrame. [in] fz ECEF z coordinate in meters in srcFrame. [in] srcFrame The RefFrame of the coordinates in fromPos. [out] tx ECEF x coordinate in meters in srcFrame. [out] ty ECEF y coordinate in meters in srcFrame. [out] tz ECEF z coordinate in meters in srcFrame.
- Returns
- true on success, false on failure (typically if srcFrame doesn't match fromFrame).
Implemented in gnsstk::HelmertTransformer, and FakeTransformer.
Member Data Documentation
◆ epoch
|
protected |
When this Transformer was first applicable.
Definition at line 159 of file Transformer.hpp.
◆ fromFrame
|
protected |
The reference frame we can transform from.
Definition at line 157 of file Transformer.hpp.
◆ toFrame
|
protected |
The reference frame we can transform to.
Definition at line 158 of file Transformer.hpp.
The documentation for this class was generated from the following file: