# MI - Fimex: MetNoFimex::GribFileMessage Class Reference

# MetNoFimex::GribFileMessage Class Reference

`#include <GribFileIndex.h>`

List of all members.

## Public Member Functions

| GribFileMessage ()
| GribFileMessage (boost::shared_ptr< grib_handle > gh, const std::string &fileURL, long filePos, long msgPos)
| GribFileMessage (boost::shared_ptr< XMLDoc >, std::string nsPrefix, xmlNodePtr node)
| ~GribFileMessage ()
bool | isValid () const
| test if this is a proper GribFileMessage or just the default constructor
std::string | toString () const
| give a xml-string representation
const long | getEdition () const
| accessors
const std::string & | getFileURL () const
const size_t | getFilePosition () const
const size_t | getMessageNumber () const
| messages number within a multi-message
const std::string & | getName () const
const std::string & | getShortName () const
boost::posix_time::ptime | getValidTime () const
boost::posix_time::ptime | getReferenceTime () const
long | getLevelNumber () const
long | getLevelType () const
const std::vector< long > & | getParameterIds () const
const std::string & | getTypeOfGrid () const
const GridDefinition & | getGridDefinition () const
size_t | readData (std::vector< double > &data, double missingValue) const

## Constructor & Destructor Documentation

MetNoFimex::GribFileMessage::GribFileMessage | ( |  | ) |

MetNoFimex::GribFileMessage::GribFileMessage | ( | boost::shared_ptr< grib_handle > | gh,
|  | const std::string & | fileURL,
|  | long | filePos,
|  | long | msgPos |
| ) |  |  |

MetNoFimex::GribFileMessage::GribFileMessage | ( | boost::shared_ptr< XMLDoc > | ,
|  | std::string | nsPrefix,
|  | xmlNodePtr | node |
| ) |  |  |

MetNoFimex::GribFileMessage::~GribFileMessage | ( |  | ) |

## Member Function Documentation

bool MetNoFimex::GribFileMessage::isValid | ( |  | ) | const`[inline]`

test if this is a proper GribFileMessage or just the default constructor

std::string MetNoFimex::GribFileMessage::toString | ( |  | ) | const

give a xml-string representation

const long MetNoFimex::GribFileMessage::getEdition | ( |  | ) | const

accessors

Referenced by MetNoFimex::GribFileMessageEqualLevelTime::operator()().

const std::string& MetNoFimex::GribFileMessage::getFileURL | ( |  | ) | const

const size_t MetNoFimex::GribFileMessage::getFilePosition | ( |  | ) | const

const size_t MetNoFimex::GribFileMessage::getMessageNumber | ( |  | ) | const

messages number within a multi-message

const std::string& MetNoFimex::GribFileMessage::getName | ( |  | ) | const

const std::string& MetNoFimex::GribFileMessage::getShortName | ( |  | ) | const

boost::posix_time::ptime MetNoFimex::GribFileMessage::getValidTime | ( |  | ) | const

Referenced by MetNoFimex::GribFileMessageEqualLevelTime::operator()(), and MetNoFimex::GribFileMessageEqualTime::operator()().

boost::posix_time::ptime MetNoFimex::GribFileMessage::getReferenceTime | ( |  | ) | const

long MetNoFimex::GribFileMessage::getLevelNumber | ( |  | ) | const

Referenced by MetNoFimex::GribFileMessageEqualLevelTime::operator()().

long MetNoFimex::GribFileMessage::getLevelType | ( |  | ) | const

Referenced by MetNoFimex::GribFileMessageEqualLevelTime::operator()().

const std::vector<long>& MetNoFimex::GribFileMessage::getParameterIds | ( |  | ) | const

Get the parameter ids as list with the following meanings:

- ed1: indicatorOfParameter, gribTablesVersionNo, identificationOfOriginatingGeneratingCentre;
- ed2: parameterNumber, paramterCategory, discipline

const std::string& MetNoFimex::GribFileMessage::getTypeOfGrid | ( |  | ) | const

const GridDefinition& MetNoFimex::GribFileMessage::getGridDefinition | ( |  | ) | const

size_t MetNoFimex::GribFileMessage::readData | ( | std::vector< double > & | data,
|  | double | missingValue |
| ) |  |  | const

Read the data from the underlying source to the vector data. Data of at maximum data.size() will be read.

Parameters:

  | data | the storage the data will be read to
  | missingValue | the missing- / fill-value the returned data will have

Returns:
  the actual amount of data read

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

- include/fimex/GribFileIndex.h