Formatted File I/O

Detailed Description

This module includes the data types used for File I/O of structured data formats, for example, RINEX.

Classes
class	gnsstk::AntexBase
class	gnsstk::AntexData
class	gnsstk::AntexStream
	This class reads an Antex files. More...
class	gnsstk::BinexData
class	gnsstk::BinexStream
class	gnsstk::Sinex::BlockBase
class	gnsstk::Sinex::Data
struct	gnsstk::Sinex::DataType
class	gnsstk::FFBinaryStream
class	gnsstk::FFStream
class	gnsstk::FFTextStream
class	gnsstk::Sinex::Header
class	gnsstk::IonexBase
class	gnsstk::IonexData
class	gnsstk::IonexHeader
class	gnsstk::IonexStore
class	gnsstk::IonexStream
class	gnsstk::IonoCorr
	Ionospheric Corrections. More...
class	gnsstk::Rinex3ClockBase
	This class is here to make readable inheritance diagrams. More...
class	gnsstk::Rinex3ClockData
class	gnsstk::Rinex3ClockHeader
class	gnsstk::Rinex3ClockStream
class	gnsstk::Rinex3NavBase
class	gnsstk::Rinex3NavData
struct	gnsstk::Rinex3NavDataOperatorLessThanFull
	This compares all elements of the Rinex3NavData with less than. More...
class	gnsstk::Rinex3NavStream
class	gnsstk::Rinex3ObsBase
class	gnsstk::Rinex3ObsData
struct	gnsstk::Rinex3ObsDataOperatorLessThanFull
class	gnsstk::Rinex3ObsStream
class	gnsstk::RinexClockBase
	Provide a base class for RinexClockData and RinexClockHeader. More...
class	gnsstk::RinexClockData
class	gnsstk::RinexClockHeader
class	gnsstk::RinexClockStream
class	gnsstk::RinexDatum
	Storage for single RINEX OBS data measurements. More...
class	gnsstk::RinexMetBase
class	gnsstk::RinexMetData
class	gnsstk::RinexMetHeader
class	gnsstk::RinexMetStream
class	gnsstk::RinexNavBase
class	gnsstk::RinexNavData
struct	gnsstk::RinexNavDataOperatorLessThanFull
	This compares all elements of the RinexNavData with less than. More...
class	gnsstk::RinexNavHeader
class	gnsstk::RinexNavStream
class	gnsstk::RinexObsBase
class	gnsstk::RinexObsData
struct	gnsstk::RinexObsDataOperatorLessThanFull
class	gnsstk::RinexObsStream
struct	gnsstk::RinexObsType
	RINEX Observation Types. More...
class	gnsstk::RinexSatID
class	gnsstk::SEMBase
class	gnsstk::SEMData
class	gnsstk::SEMHeader
class	gnsstk::SEMStream
class	gnsstk::SP3Base
	This class is here to make readable inheritance diagrams. More...
class	gnsstk::SP3Data
class	gnsstk::SP3Header
class	gnsstk::SP3SatID
class	gnsstk::SP3Stream
class	gnsstk::Sinex::Stream
class	gnsstk::YumaBase
class	gnsstk::YumaData
class	gnsstk::YumaHeader
class	gnsstk::YumaStream

Typedefs
typedef std::binary_function< BinexData, BinexData, bool >	gnsstk::BinexDataBinaryOperator
typedef std::unary_function< RinexMetHeader, bool >	gnsstk::RinexMetDataUnaryOperator

Enumerations
enum	gnsstk::IonexStoreStrategy {   gnsstk::IonexStoreStrategy::Unknown, gnsstk::IonexStoreStrategy::Nearest, gnsstk::IonexStoreStrategy::Consecutive, gnsstk::IonexStoreStrategy::ConsRot,   gnsstk::IonexStoreStrategy::Rotated, gnsstk::IonexStoreStrategy::Last }
	Enumeration used for IonexStore::getIonexValue(). More...

Functions
bool	gnsstk::isValidRinexObsID (const std::string &strID)
	gnsstk::NEW_EXCEPTION_CLASS (FFStreamError, gnsstk::Exception)
int	gnsstk::RegisterARLUTExtendedTypes (void)

RINEX OBS header implementation

For each header line type, the following are listed in the table below:

1. The label
2. Its usage in RINEX 2
3. Its usage in RINEX 3
4. The name for validity checking and header variable storage (see below)
5. Variables (data members) storing the header information

Header Field	v2	v3	Name	Variables
RINEX VERSION / TYPE	req	req	Version	version
				fileType
				fileSys
				fileSysSat
				preserveVerType
PGM / RUN BY / DATE	req	req	RunBy	fileProgram
				fileAgency
				date
				preserveDate
COMMENT	opt	opt	Comment	commentList
MARKER NAME	req	opt	MarkerName	markerName
MARKER NUMBER	opt	opt	MarkerNumber	markerNumber
MARKER TYPE	-	req	MarkerType	markerType
OBSERVER / AGENCY	req	req	Observer	observer
				agency
REC # / TYPE / VERS	req	req	Receiver	recNo
				recType
				recVers
ANT # / TYPE	req	req	AntennaType	antNo
				antType
APPROX POSITION XYZ	req	req	AntennaPosition	antennaPosition
ANTENNA: DELTA H/E/N	req	req	AntennaDeltaHEN	antennaDeltaHEN
ANTENNA: DELTA X/Y/Z	-	opt	AntennaDeltaXYZ	antennaDeltaXYZ
ANTENNA: PHASECENTER	-	opt	AntennaPhaseCtr	antennaSatSys
				antennaObsCode
				antennaPhaseCtr
ANTENNA: B.SIGHT XYZ	-	opt	AntennaBsightXYZ	antennaBsightXYZ
ANTENNA: ZERODIR AZI	-	opt	AntennaZeroDirAzi	antennaZeroDirAzi
ANTENNA: ZERODIR XYZ	-	opt	AntennaZeroDirXYZ	antennaZeroDirXYZ
CENTER OF MASS: XYZ	-	opt	CenterOfMass	centerOfMass
# / TYPES OF OBSERV	req	n/a	NumObs
SYS / # / OBS TYPES	n/a	req	SystemNumObs	mapObsTypes
WAVELENGTH FACT L1/2	opt	-	WaveFact	wavelengthFactor
				extraWaveFactList
SIGNAL STRENGTH UNIT	-	opt	SigStrengthUnit	sigStrengthUnit
INTERVAL	opt	opt	Interval	interval
TIME OF FIRST OBS	req	req	FirstTime	firstObs
TIME OF LAST OBS	opt	opt	LastTime	lastObs
RCV CLOCK OFFS APPL	opt	opt	ReceiverOffset	receiverOffset
SYS / DCBS APPLIED	-	opt	SystemDCBSapplied	infoDCBS
SYS / PCVS APPLIED	-	opt	SystemPCVSapplied	infoPCVS
SYS / SCALE FACTOR	-	opt	SystemScaleFac	sysSfacMap
SYS / PHASE SHIFT	-	req	SystemPhaseShift	sysPhaseShift
GLONASS SLOT / FRQ #	-	req	GlonassSlotFreqNo	glonassFreqNo
GLONASS COD/PHS/BIS	-	req	GlonassCodPhsBias	glonassCodPhsBias
LEAP SECONDS	opt	opt	LeapSeconds	leapSeconds
# OF SATELLITES	opt	opt	NumSats	numSVs
PRN / # OF OBS	opt	opt	PrnObs	numObsForSat
END OF HEADER	req	req	EoH (header only)	-

The "Name" column in the above table is used for both validity flags and header strings. For the header strings, prepend "hs", e.g. "hsVersion" will give you the header field label. For validity flags, prepend valid, e.g. "validVersion" would indicate the presence of the "RINEX VERSION / TYPE" header record.

Typedef Documentation

BinexDataBinaryOperator

typedef std::binary_function<BinexData, BinexData, bool> gnsstk::BinexDataBinaryOperator

Definition at line 57 of file BinexFilterOperators.hpp.

RinexMetDataUnaryOperator

typedef std::unary_function<RinexMetHeader, bool> gnsstk::RinexMetDataUnaryOperator

Definition at line 59 of file RinexMetFilterOperators.hpp.

Enumeration Type Documentation

IonexStoreStrategy

enum gnsstk::IonexStoreStrategy

strong

Enumeration used for IonexStore::getIonexValue().

Enumerator
Unknown	Unknown or uninitialized stategy value.
Nearest	Take nearest map.
Consecutive	Interpolate between two consecutive maps.
ConsRot	Interpolate between two consecutive rotated maps.
Rotated	Take nearest rotated map.
Last	Used to create an iterator.

Definition at line 51 of file IonexStoreStrategy.hpp.

Function Documentation

isValidRinexObsID()

bool gnsstk::isValidRinexObsID

(

const std::string &

id

)

Todo:

determine if this really belongs with the RINEX files

Determine if the given ObsID is valid. If the input string is 3 characters long, the system is unknown and the string is tested with all RINEX If this string is 4 characters long, the first character is the system character as described in the Rinex 3 specification.

Definition at line 223 of file RinexObsID.cpp.

NEW_EXCEPTION_CLASS()

gnsstk::NEW_EXCEPTION_CLASS	(	FFStreamError	,
		gnsstk::Exception
	)

FFStreamError is an exception for when the file read doesn't match the specs for that file type.

RegisterARLUTExtendedTypes()

int gnsstk::RegisterARLUTExtendedTypes

(

void

)

Register commonly used extended Rinex observation types.

Returns

0 ok, or the return value of RegisterExtendedRinexObsType().

Definition at line 69 of file RinexUtilities.cpp.