Public Member Functions | Protected Member Functions | List of all members
gnsstk::BinexStream Class Reference

Detailed Description

This class performs file i/o on a BINEX file for the BinexData classes.

See also
binex_read_write.cpp for an example.
binex_test.cpp for an example.
BinexData.

Definition at line 63 of file BinexStream.hpp.

#include <BinexStream.hpp>

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

Public Member Functions

 BinexStream ()
 Default constructor. More...
 
 BinexStream (const char *fn, std::ios::openmode mode=std::ios::in|std::ios::binary)
 
virtual ~BinexStream ()
 Destructor. More...
 
- Public Member Functions inherited from gnsstk::FFBinaryStream
 FFBinaryStream ()
 Default constructor. More...
 
 FFBinaryStream (const char *fn, std::ios::openmode mode=std::ios::in|std::ios::binary)
 
void getData (char *buff, size_t length)
 
void getData (double &v)
 
void getData (float &v)
 
void getData (int16_t &v)
 
void getData (int32_t &v)
 
void getData (int64_t &v)
 
void getData (int8_t &v)
 
void getData (uint16_t &v)
 
void getData (uint32_t &v)
 
void getData (uint64_t &v)
 
void getData (uint8_t &v)
 
virtual void open (const char *fn, std::ios::openmode mode)
 Overrides open to ensure binary mode opens. More...
 
void writeData (const char *buff, size_t length)
 
void writeData (double v)
 
void writeData (float v)
 
void writeData (int16_t v)
 
void writeData (int32_t v)
 
void writeData (int64_t v)
 
void writeData (int8_t v)
 
void writeData (uint16_t v)
 
void writeData (uint32_t v)
 
void writeData (uint64_t v)
 
void writeData (uint8_t v)
 
virtual ~FFBinaryStream ()
 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 void open (const std::string &fn, std::ios::openmode mode)
 
virtual ~FFStream ()
 Virtual destructor, close the stream etc. More...
 

Protected Member Functions

virtual bool isStreamLittleEndian () const noexcept
 
- Protected Member Functions inherited from gnsstk::FFStream
virtual void tryFFStreamGet (FFData &rec)
 
virtual void tryFFStreamPut (const FFData &rec)
 

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...
 
- 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...
 

Constructor & Destructor Documentation

◆ ~BinexStream()

virtual gnsstk::BinexStream::~BinexStream ( )
inlinevirtual

Destructor.

Definition at line 67 of file BinexStream.hpp.

◆ BinexStream() [1/2]

gnsstk::BinexStream::BinexStream ( )
inline

Default constructor.

Definition at line 70 of file BinexStream.hpp.

◆ BinexStream() [2/2]

gnsstk::BinexStream::BinexStream ( const char *  fn,
std::ios::openmode  mode = std::ios::in | std::ios::binary 
)
inline

Constructor Opens a file named fn using ios::openmode mode.

Definition at line 75 of file BinexStream.hpp.

Member Function Documentation

◆ isStreamLittleEndian()

virtual bool gnsstk::BinexStream::isStreamLittleEndian ( ) const
inlineprotectedvirtualnoexcept
Warning
This is used by FFBinaryStream's getData and writeData methods to determine how to write binary encoded data. BINEX can be either big-endian or little-endian so this isn't really useful. As such, DO NOT USE writeData or getData in the implementation of BinexData.

Implements gnsstk::FFBinaryStream.

Definition at line 85 of file BinexStream.hpp.


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


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