CARMA C++
carma::pipeline::CorrelatorVisBrickReader Class Reference

Reads Correlator Data from a specifiec file. More...

#include <carma/pipeline/VisBrickReader.h>

Public Member Functions

 CorrelatorVisBrickReader (const std::string &filename, bool continueOnFileErrors=false)
 Constructor. More...
 
bool fileErrorDetected () const
 Was a file error detected while extracting correlator data records? More...
 
RecordsByFrameMap getRecordsKeyedByFrame ()
 Retrieve a map of all records keyed by frame time. More...
 
const
carma::correlator::lib::CorrelatorData
readOne ()
 Read a single record from file. More...
 
virtual ~CorrelatorVisBrickReader ()
 Destructor. More...
 

Detailed Description

Reads Correlator Data from a specifiec file.

Definition at line 31 of file VisBrickReader.h.

Constructor & Destructor Documentation

carma::pipeline::CorrelatorVisBrickReader::CorrelatorVisBrickReader ( const std::string &  filename,
bool  continueOnFileErrors = false 
)
explicit

Constructor.

Parameters
filenameSpecifies input visbrick filename.
continueOnFileErrorsExtract as many records as possible from visbrick and continue (if possible) while logging error to logs.
virtual carma::pipeline::CorrelatorVisBrickReader::~CorrelatorVisBrickReader ( )
virtual

Destructor.

Member Function Documentation

bool carma::pipeline::CorrelatorVisBrickReader::fileErrorDetected ( ) const

Was a file error detected while extracting correlator data records?

See Also
CorrelatorVisBrickReader::CorrelatorVisBrickReader
RecordsByFrameMap carma::pipeline::CorrelatorVisBrickReader::getRecordsKeyedByFrame ( )

Retrieve a map of all records keyed by frame time.

const carma::correlator::lib::CorrelatorData& carma::pipeline::CorrelatorVisBrickReader::readOne ( )

Read a single record from file.

Exceptions
EOFExceptionWhen read fails due to end-of-file.
exceptionwhen there is an error reading file
Deprecated:
Use getRecordsKeyedByFrame

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