Public Member Functions | Public Attributes | Protected Member Functions | Friends | List of all members
gnsstk::Sinex::BlockBase Class Referenceabstract

Detailed Description

Base class for all SINEX blocks; the common base allows blocks of varying types to be stored in a vector. Specific block types are realized by the derived Block class defined below.

Definition at line 63 of file SinexBlock.hpp.

#include <SinexBlock.hpp>

Inheritance diagram for gnsstk::Sinex::BlockBase:
Inheritance graph
[legend]

Public Member Functions

virtual size_t getSize () const =0
 
virtual std::string getTitle () const =0
 
virtual ~BlockBase ()
 

Public Attributes

std::string comment
 Comments that apply to an entire block. More...
 

Protected Member Functions

virtual size_t getBlock (Sinex::Stream &s)=0
 
virtual size_t putBlock (Sinex::Stream &s) const =0
 

Friends

class Data
 

Constructor & Destructor Documentation

◆ ~BlockBase()

virtual gnsstk::Sinex::BlockBase::~BlockBase ( )
inlinevirtual

Definition at line 71 of file SinexBlock.hpp.

Member Function Documentation

◆ getBlock()

virtual size_t gnsstk::Sinex::BlockBase::getBlock ( Sinex::Stream s)
protectedpure virtual

Reads a record from the given SinexStream; if an error is encountered in retrieving the record, the stream is reset to its original position and its fail-bit is set.

Parameters
sStream from which to read
Returns
Number of lines read
Exceptions
std::exception
StringExceptionwhen a StringUtils function fails
FFStreamErrorwhen exceptions(failbit) is set and a read or formatting error occurs. This also resets the stream to its pre-read position.

Implemented in gnsstk::Sinex::Block< T >.

◆ getSize()

virtual size_t gnsstk::Sinex::BlockBase::getSize ( ) const
pure virtual

Returns the number of lines in the block

Implemented in gnsstk::Sinex::Block< T >.

◆ getTitle()

virtual std::string gnsstk::Sinex::BlockBase::getTitle ( ) const
pure virtual

Returns the block title

Implemented in gnsstk::Sinex::Block< T >.

◆ putBlock()

virtual size_t gnsstk::Sinex::BlockBase::putBlock ( Sinex::Stream s) const
protectedpure virtual

Writes the formatted block to the SinexStream.

Parameters
sStream to which to write
Returns
Number of lines written
Exceptions
std::exception
FFStreamError
StringUtils::StringException

Implemented in gnsstk::Sinex::Block< T >.

Friends And Related Function Documentation

◆ Data

friend class Data
friend

Definition at line 67 of file SinexBlock.hpp.

Member Data Documentation

◆ comment

std::string gnsstk::Sinex::BlockBase::comment

Comments that apply to an entire block.

Definition at line 74 of file SinexBlock.hpp.


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


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