nidas  v1.2-1520
Public Member Functions | List of all members
nidas::core::CalFileHandler Class Referenceabstract

This is the interface for handling CalFile records as they are read by a VariableConverter. More...

#include <VariableConverter.h>

Inheritance diagram for nidas::core::CalFileHandler:
Inheritance graph
[legend]

Public Member Functions

 CalFileHandler ()
 
virtual bool handleCalFileRecord (nidas::core::CalFile *)=0
 
virtual ~CalFileHandler ()
 

Detailed Description

This is the interface for handling CalFile records as they are read by a VariableConverter.

The handler method accepts a CalFile* as the sole argument, and it should return true if it handled the record, or false if the record should be handled by VariableConverter::parseFields(), the default record handler. When the handler is called, the current fields and time from the CalFile record can be retrieved with CalFile::getCurrentFields() and CalFile::getCurrentTime().

See makeCalFileHandler() and the CalFileHandlerFunction template for a simple way to create implementations of this interface which call existing functions, such as class methods.

Constructor & Destructor Documentation

nidas::core::CalFileHandler::CalFileHandler ( )
inline
virtual nidas::core::CalFileHandler::~CalFileHandler ( )
inlinevirtual

Member Function Documentation

virtual bool nidas::core::CalFileHandler::handleCalFileRecord ( nidas::core::CalFile )
pure virtual

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