Public Member Functions | Public Attributes | Private Member Functions | List of all members
gnsstk::SP3Stream Class Reference

Detailed Description

This class performs file I/O on an SP3 file for the SP3Header and SP3Data classes.

Note
the file format (a, b or c) is stored in the SP3Header (only). On input it is set by SP3Header::reallyGetRecord() by the file content; for output it may be set (SP3Header::setVersion()) before streaming.

Definition at line 61 of file SP3Stream.hpp.

#include <SP3Stream.hpp>

Inheritance diagram for gnsstk::SP3Stream:
Inheritance graph
[legend]

Public Member Functions

virtual void close (void)
 
virtual void open (const char *filename, std::ios::openmode mode)
 
 SP3Stream ()
 Default constructor. More...
 
 SP3Stream (const char *filename, std::ios::openmode mode=std::ios::in)
 
virtual ~SP3Stream ()
 destructor; override to force 'close' More...
 
- Public Member Functions inherited from gnsstk::FFTextStream
 FFTextStream ()
 Default constructor. More...
 
 FFTextStream (const char *fn, std::ios::openmode mode=std::ios::in)
 
 FFTextStream (const std::string &fn, std::ios::openmode mode=std::ios::in)
 
void formattedGetLine (std::string &line, const bool expectEOF=false)
 
virtual void open (const std::string &fn, std::ios::openmode mode)
 Overrides open to reset the line number. More...
 
virtual ~FFTextStream ()
 Destructor. More...
 
- Public Member Functions inherited from gnsstk::FFStream
void conditionalThrow (void)
 
void dumpState (std::ostream &s=std::cout) const
 A function to help debug FFStreams. More...
 
 FFStream ()
 Default constructor, initialize internal data. More...
 
 FFStream (const char *fn, std::ios::openmode mode=std::ios::in)
 
 FFStream (const std::string &fn, std::ios::openmode mode=std::ios::in)
 
virtual ~FFStream ()
 Virtual destructor, close the stream etc. More...
 

Public Attributes

CommonTime currentEpoch
 Time from last epoch record read. More...
 
SP3Header header
 SP3Header for this file. More...
 
std::string lastLine
 Last line read, perhaps not yet processed. More...
 
std::vector< std::string > warnings
 warnings produced by reallyGetRecord()s More...
 
bool writingMode
 True if the stream is open in 'out', not 'in', mode. More...
 
bool wroteEOF
 True if the final 'EOF' has been read. More...
 
- Public Attributes inherited from gnsstk::FFTextStream
unsigned int lineNumber
 
- Public Attributes inherited from gnsstk::FFStream
std::string filename
 file name More...
 
FFStreamError mostRecentException
 This stores the most recently thrown exception. More...
 
unsigned int recordNumber
 keeps track of the number of records read More...
 

Private Member Functions

void init (std::ios::openmode)
 Initialize internal data structures according to file mode. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from gnsstk::FFStream
static bool isFFStream (std::istream &i)
 Check if the input stream is the kind of RinexObsStream. More...
 
- Protected Member Functions inherited from gnsstk::FFTextStream
virtual void tryFFStreamGet (FFData &rec)
 
virtual void tryFFStreamPut (const FFData &rec)
 

Constructor & Destructor Documentation

◆ SP3Stream() [1/2]

gnsstk::SP3Stream::SP3Stream ( )

Default constructor.

Definition at line 49 of file SP3Stream.cpp.

◆ SP3Stream() [2/2]

gnsstk::SP3Stream::SP3Stream ( const char *  filename,
std::ios::openmode  mode = std::ios::in 
)

Common constructor: open (default: to read)

Parameters
[in]filenamethe name of the ASCII SP3 format file to be opened
[in]modethe ios::openmode to be used

Definition at line 58 of file SP3Stream.cpp.

◆ ~SP3Stream()

gnsstk::SP3Stream::~SP3Stream ( )
virtual

destructor; override to force 'close'

Definition at line 67 of file SP3Stream.cpp.

Member Function Documentation

◆ close()

void gnsstk::SP3Stream::close ( void  )
virtual

override close() to write EOF line

Exceptions
Exception

Definition at line 74 of file SP3Stream.cpp.

◆ init()

void gnsstk::SP3Stream::init ( std::ios::openmode  mode)
private

Initialize internal data structures according to file mode.

Definition at line 102 of file SP3Stream.cpp.

◆ open()

void gnsstk::SP3Stream::open ( const char *  filename,
std::ios::openmode  mode 
)
virtual

override open() to reset the header

Parameters
[in]filenamethe name of the ASCII SP3 format file to be opened
[in]modethe ios::openmode to be used

Reimplemented from gnsstk::FFTextStream.

Definition at line 95 of file SP3Stream.cpp.

Member Data Documentation

◆ currentEpoch

CommonTime gnsstk::SP3Stream::currentEpoch

Time from last epoch record read.

Definition at line 91 of file SP3Stream.hpp.

◆ header

SP3Header gnsstk::SP3Stream::header

SP3Header for this file.

Definition at line 88 of file SP3Stream.hpp.

◆ lastLine

std::string gnsstk::SP3Stream::lastLine

Last line read, perhaps not yet processed.

Definition at line 92 of file SP3Stream.hpp.

◆ warnings

std::vector<std::string> gnsstk::SP3Stream::warnings

warnings produced by reallyGetRecord()s

Definition at line 93 of file SP3Stream.hpp.

◆ writingMode

bool gnsstk::SP3Stream::writingMode

True if the stream is open in 'out', not 'in', mode.

Definition at line 90 of file SP3Stream.hpp.

◆ wroteEOF

bool gnsstk::SP3Stream::wroteEOF

True if the final 'EOF' has been read.

Definition at line 89 of file SP3Stream.hpp.


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


gnsstk
Author(s):
autogenerated on Wed Oct 25 2023 02:40:46