FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoIMeasureUnitReader Class Reference

#include <IMeasureUnitReader.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoIMeasureUnitReader:

[legend]
List of all members.

Detailed Description

The FdoIMeasureUnitReader interface provides forward-only, read-only functionality for enumerating measurement units. A reference to an FdoIMeasureUnitReader interface is returned from the GetMeasureUnits command. The initial position of the FdoIMeasureUnitReader is prior to the first item. Thus, you must call ReadNext to begin accessing any data.

Definition at line 35 of file IMeasureUnitReader.h.


Public Member Functions

virtual FDO_API void Close ()=0
 Closes the FdoIMeasureUnitReader object, freeing any resources it may be holding.
virtual FDO_API FdoStringGetAbbreviation ()=0
 Gets the abbreviation of the measure unit currently being read.
virtual FDO_API FdoBaseUnit GetBaseUnit ()=0
 Gets the base unit of the measure unit currently being read.
virtual FDO_API FdoStringGetDescription ()=0
 Gets the description of the measure unit currently being read.
virtual FDO_API FdoStringGetName ()=0
 Gets the name of the measure unit currently being read.
virtual FDO_API double GetScaleFactor ()=0
 Gets the scale factor of the measure unit currently being read.
virtual FDO_API bool ReadNext ()=0
 Advances the reader to the next item. The default position of the reader is prior to the first item. Thus, you must call ReadNext to begin accessing any data.

Member Function Documentation

virtual FDO_API void FdoIMeasureUnitReader::Close  )  [pure virtual]
 

Closes the FdoIMeasureUnitReader object, freeing any resources it may be holding.

Returns:
Returns nothing

virtual FDO_API FdoString* FdoIMeasureUnitReader::GetAbbreviation  )  [pure virtual]
 

Gets the abbreviation of the measure unit currently being read.

Returns:
Returns the abbreviation of the measure unit

virtual FDO_API FdoBaseUnit FdoIMeasureUnitReader::GetBaseUnit  )  [pure virtual]
 

Gets the base unit of the measure unit currently being read.

Returns:
Returns the base unit

virtual FDO_API FdoString* FdoIMeasureUnitReader::GetDescription  )  [pure virtual]
 

Gets the description of the measure unit currently being read.

Returns:
Returns the description of the measure unit

virtual FDO_API FdoString* FdoIMeasureUnitReader::GetName  )  [pure virtual]
 

Gets the name of the measure unit currently being read.

Returns:
Returns the name of the measure unit

virtual FDO_API double FdoIMeasureUnitReader::GetScaleFactor  )  [pure virtual]
 

Gets the scale factor of the measure unit currently being read.

Returns:
Returns the scale factor of the measure unit

virtual FDO_API bool FdoIMeasureUnitReader::ReadNext  )  [pure virtual]
 

Advances the reader to the next item. The default position of the reader is prior to the first item. Thus, you must call ReadNext to begin accessing any data.

Returns:
Returns true if there is a next item

The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.