BIE::RecordInputStream_NetCDF Class Reference

A record stream that reads from a NetCDF file. More...

#include <RecordStream_NetCDF.h>

Inheritance diagram for BIE::RecordInputStream_NetCDF:

Collaboration diagram for BIE::RecordInputStream_NetCDF:

List of all members.

Public Member Functions

RecordInputStream_NetCDF (string filename)

Open the NetCDF file with the specified name and base the type of the stream on the meta data in this file.

void initialize ()

Initialization code called by constructor and by persistence Read routine.

~RecordInputStream_NetCDF ()

Destructor: Closes the NetCDF file that was created and deletes all dynamically created objects.

bool nextRecord ()

Reads next record from file and puts the values in the record buffer.

bool eos ()

Returns true if the end of the NetCDF file/stream has been reached.

bool error ()

Returns true if an error occured while reading this file/stream.

string toString ()

Returns a string representation of the stream.

Detailed Description

A record stream that reads from a NetCDF file.

Each field in the record stream is represented by a single dimensional array with "unlimited" length in netCDF. This means that we end up with a collection of array variables, each with this "unlimited" length, with a single record being stored across these arrays at a common index. Any files that do not have this format are rejected.

Supported types? Restrictions?

Constructor & Destructor Documentation

BIE::RecordInputStream_NetCDF::RecordInputStream_NetCDF ( string filename )

Open the NetCDF file with the specified name and base the type of the stream on the meta data in this file.

BIE::RecordInputStream_NetCDF::~RecordInputStream_NetCDF ( )

Destructor: Closes the NetCDF file that was created and deletes all dynamically created objects.

Member Function Documentation

void BIE::RecordInputStream_NetCDF::initialize ( )

Initialization code called by constructor and by persistence Read routine.

bool BIE::RecordInputStream_NetCDF::nextRecord ( ) [virtual]

Reads next record from file and puts the values in the record buffer.

Returns true if the operation was successful.

Reimplemented from BIE::RecordInputStream.

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

/home/weinberg/src/BIE/include/RecordStream_NetCDF.h