Detailed Description
This class models the header for an ANTEX antenna file
- See also
- gnsstk::AntexData and gnsstk::AntexStream.
Definition at line 60 of file AntexHeader.hpp.
#include <AntexHeader.hpp>
Public Member Functions | |
| AntexHeader () | |
| Default and only constructor. More... | |
| void | clear () |
| Clear (empty out) header. More... | |
 Public Member Functions inherited from gnsstk::AntexBase | |
| virtual | ~AntexBase () |
| Destructor per the coding standards. More... | |
| Public Member Functions inherited from gnsstk::FFData | |
| void | getRecord (FFStream &s) |
| virtual bool | isData () const |
| void | putRecord (FFStream &s) const |
| virtual | ~FFData (void) |
| virtual desctuctor More... | |
AntexHeaderFormatStrings | |
| enum | validBits { versionValid = 0x01, systemValid = 0x02, pcvTypeValid = 0x04, commentValid = 0x08, endValid = 0x080000000, allValid13 = 0x080000007 } |
| static const GNSSTK_EXPORT std::string | versionString = "ANTEX VERSION / SYST" |
| "ANTEX VERSION / SYST" More... | |
| static const GNSSTK_EXPORT std::string | pcvTypeString = "PCV TYPE / REFANT" |
| "PCV TYPE / REFANT" More... | |
| static const GNSSTK_EXPORT std::string | headerCommentString = "COMMENT" |
| "COMMENT" More... | |
| static const GNSSTK_EXPORT std::string | endOfHeaderString = "END OF HEADER" |
| "END OF HEADER" More... | |
AntexHeaderValues | |
| unsigned long | valid |
| double | version |
| ANTEX VERSION & TYPE. More... | |
| char | system |
| The ANTEX satellite system. More... | |
| char | pcvType |
| The PCV type (A:absolute R:relative) More... | |
| std::string | refAntType |
| Reference antenna type. More... | |
| std::string | refAntSerNum |
| Reference antenna serial number. More... | |
| std::vector< std::string > | commentList |
| Comments in header (optional) More... | |
| virtual | ~AntexHeader () |
| Destructor. More... | |
| virtual bool | isHeader () const |
| AntexHeader is a "header" so this function always returns true. More... | |
| virtual void | dump (std::ostream &s) const |
| void | ParseHeaderRecord (std::string &line) |
| void | WriteHeaderRecords (FFStream &s) const |
| bool | isValid () const |
| Return boolean : is this a valid Rinex header? More... | |
| virtual void | reallyPutRecord (FFStream &s) const |
| virtual void | reallyGetRecord (FFStream &s) |
Additional Inherited Members |
Member Enumeration Documentation
◆ validBits
Validity bits for the ANTEX Header NB. if version is updated, add allValid<ver> and update isValid()
Definition at line 88 of file AntexHeader.hpp.
Constructor & Destructor Documentation
◆ AntexHeader()
|
inline |
Default and only constructor.
Definition at line 64 of file AntexHeader.hpp.
◆ ~AntexHeader()
|
inlinevirtual |
Destructor.
Definition at line 110 of file AntexHeader.hpp.
Member Function Documentation
◆ clear()
|
inline |
Clear (empty out) header.
Definition at line 66 of file AntexHeader.hpp.
◆ dump()
|
virtual |
This is a simple output function. It writes the version, name and antenna number of this ANTEX header.
Reimplemented from gnsstk::FFData.
Definition at line 263 of file AntexHeader.cpp.
◆ isHeader()
|
inlinevirtual |
AntexHeader is a "header" so this function always returns true.
Reimplemented from gnsstk::FFData.
Definition at line 114 of file AntexHeader.hpp.
◆ isValid()
|
inline |
Return boolean : is this a valid Rinex header?
Definition at line 138 of file AntexHeader.hpp.
◆ ParseHeaderRecord()
| void gnsstk::AntexHeader::ParseHeaderRecord | ( | std::string & | line | ) |
Parse a single header record, and modify valid accordingly. Used by reallyGetRecord for AntexHeader
- Exceptions
-
FFStreamError
Definition at line 144 of file AntexHeader.cpp.
◆ reallyGetRecord()
|
protectedvirtual |
This function retrieves the ANTEX Header from the given FFStream. If an stream error is encountered, the stream is reset to its original position and its fail-bit is set.
- Exceptions
-
std::exception StringException when a StringUtils function fails FFStreamError when exceptions(failbit) is set and a read or formatting error occurs. This also resets the stream to its pre-read position.
Implements gnsstk::FFData.
Definition at line 194 of file AntexHeader.cpp.
◆ reallyPutRecord()
|
protectedvirtual |
outputs this record to the stream correctly formatted.
- Exceptions
-
std::exception FFStreamError StringUtils::StringException
Implements gnsstk::FFData.
Definition at line 55 of file AntexHeader.cpp.
◆ WriteHeaderRecords()
| void gnsstk::AntexHeader::WriteHeaderRecords | ( | FFStream & | s | ) | const |
Write all valid header records to the given stream. Used by reallyPutRecord for AntexHeader
- Exceptions
-
FFSTreamError StringUtils::StringException
Definition at line 97 of file AntexHeader.cpp.
Member Data Documentation
◆ commentList
| std::vector<std::string> gnsstk::AntexHeader::commentList |
Comments in header (optional)
Definition at line 106 of file AntexHeader.hpp.
◆ endOfHeaderString
|
static |
"END OF HEADER"
Definition at line 83 of file AntexHeader.hpp.
◆ headerCommentString
|
static |
"COMMENT"
Definition at line 81 of file AntexHeader.hpp.
◆ pcvType
| char gnsstk::AntexHeader::pcvType |
The PCV type (A:absolute R:relative)
Definition at line 103 of file AntexHeader.hpp.
◆ pcvTypeString
|
static |
"PCV TYPE / REFANT"
Definition at line 79 of file AntexHeader.hpp.
◆ refAntSerNum
| std::string gnsstk::AntexHeader::refAntSerNum |
Reference antenna serial number.
Definition at line 105 of file AntexHeader.hpp.
◆ refAntType
| std::string gnsstk::AntexHeader::refAntType |
Reference antenna type.
Definition at line 104 of file AntexHeader.hpp.
◆ system
| char gnsstk::AntexHeader::system |
The ANTEX satellite system.
Definition at line 102 of file AntexHeader.hpp.
◆ valid
| unsigned long gnsstk::AntexHeader::valid |
Definition at line 100 of file AntexHeader.hpp.
◆ version
| double gnsstk::AntexHeader::version |
ANTEX VERSION & TYPE.
Definition at line 101 of file AntexHeader.hpp.
◆ versionString
|
static |
"ANTEX VERSION / SYST"
Definition at line 77 of file AntexHeader.hpp.
The documentation for this class was generated from the following files: