code::IndexRecordInformation Class Reference

List of all members.

Detailed Description

The Index::Record provides only the most reliable functionality.

The IndexRecordInformation class provides more functionality, some of which may be unavailable in a data source.

Client applications that use the IndexRecordInformation class should be prepared to deal with the InfoNotAvailable exception.

See also:
InfoNotAvailableException

Index::Record

Author:
Lakshman
Version:
Id
code_IndexRecordInformation.h,v 1.5 2009/06/02 20:17:39 lakshman Exp


Public Member Functions

 IndexRecordInformation (const Index::Record &rec) throw (InfoImplNotAvailableException)
 The InfoImplNotAvailable exception is thrown if the data source encoded in the record doesn't have an implementation of this class associated with it.
const Index::RecordgetRecord ()
 Obtain the record for which information is being provided.
const std::string & getTimeStamp () const
 Time stamp associated with the record.
const TimegetTime () const
 The time at which the product referred to by this record was created.
std::string getDataType () const throw (InfoNotAvailableException)
 The name of the data type, e.g: Reflectivity.
Angle getElevation () const throw (InfoNotAvailableException)
 The elevation angle of the sweep -- elevation to a tangent to the earth's surface.
int getVolume () const throw (InfoNotAvailableException)
 The volume number, usually assigned by a RPG or radar data source Valid numbers start at 1.
int getSweep () const throw (InfoNotAvailableException)
 The sweep number (the index of the elevation angle).


Constructor & Destructor Documentation

code::IndexRecordInformation::IndexRecordInformation ( const Index::Record rec  )  throw (InfoImplNotAvailableException)

The InfoImplNotAvailable exception is thrown if the data source encoded in the record doesn't have an implementation of this class associated with it.


Member Function Documentation

std::string code::IndexRecordInformation::getDataType (  )  const throw (InfoNotAvailableException) [inline]

The name of the data type, e.g: Reflectivity.

Angle code::IndexRecordInformation::getElevation (  )  const throw (InfoNotAvailableException) [inline]

The elevation angle of the sweep -- elevation to a tangent to the earth's surface.

const Index::Record& code::IndexRecordInformation::getRecord (  )  [inline]

Obtain the record for which information is being provided.

int code::IndexRecordInformation::getSweep (  )  const throw (InfoNotAvailableException) [inline]

The sweep number (the index of the elevation angle).

The lowest valid sweep is 1. A sweep number of zero is assigned by convention to products valid for the entire volume

const Time& code::IndexRecordInformation::getTime (  )  const [inline]

The time at which the product referred to by this record was created.

const std::string& code::IndexRecordInformation::getTimeStamp (  )  const [inline]

Time stamp associated with the record.

The formatting of this string will vary depending on the data source. You should rely on the getTime() method to get the exact time.

int code::IndexRecordInformation::getVolume (  )  const throw (InfoNotAvailableException) [inline]

The volume number, usually assigned by a RPG or radar data source Valid numbers start at 1.


Generated on Fri May 4 13:40:13 2012 for WDSS-IIw2 by  doxygen 1.4.7