| FDO API Reference | Feature Data Objects |
00001 #ifndef _IMEASUREUNITREADER_H_ 00002 #define _IMEASUREUNITREADER_H_ 00003 // 00004 00005 // 00006 // Copyright (C) 2004-2006 Autodesk, Inc. 00007 // 00008 // This library is free software; you can redistribute it and/or 00009 // modify it under the terms of version 2.1 of the GNU Lesser 00010 // General Public License as published by the Free Software Foundation. 00011 // 00012 // This library is distributed in the hope that it will be useful, 00013 // but WITHOUT ANY WARRANTY; without even the implied warranty of 00014 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00015 // Lesser General Public License for more details. 00016 // 00017 // You should have received a copy of the GNU Lesser General Public 00018 // License along with this library; if not, write to the Free Software 00019 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 00020 // 00021 00022 #ifdef _WIN32 00023 #pragma once 00024 #endif 00025 00026 #include <FdoStd.h> 00027 #include <Fdo/Commands/UnitOfMeasure/BaseUnit.h> 00028 00029 /// \brief 00030 /// The FdoIMeasureUnitReader interface provides forward-only, read-only 00031 /// functionality for enumerating measurement units. A reference to an 00032 /// FdoIMeasureUnitReader interface is returned from the GetMeasureUnits command. 00033 /// The initial position of the FdoIMeasureUnitReader is prior to the 00034 /// first item. Thus, you must call ReadNext to begin accessing any data. 00035 class FdoIMeasureUnitReader : public FdoIDisposable 00036 { 00037 public: 00038 /// \brief 00039 /// Gets the abbreviation of the measure unit currently being read. 00040 /// 00041 /// \return 00042 /// Returns the abbreviation of the measure unit 00043 /// 00044 FDO_API virtual FdoString* GetAbbreviation() = 0; 00045 00046 /// \brief 00047 /// Gets the name of the measure unit currently being read. 00048 /// 00049 /// \return 00050 /// Returns the name of the measure unit 00051 /// 00052 FDO_API virtual FdoString* GetName() = 0; 00053 00054 /// \brief 00055 /// Gets the description of the measure unit currently being read. 00056 /// 00057 /// \return 00058 /// Returns the description of the measure unit 00059 /// 00060 FDO_API virtual FdoString* GetDescription() = 0; 00061 00062 /// \brief 00063 /// Gets the base unit of the measure unit currently being read. 00064 /// 00065 /// \return 00066 /// Returns the base unit 00067 /// 00068 FDO_API virtual FdoBaseUnit GetBaseUnit() = 0; 00069 00070 /// \brief 00071 /// Gets the scale factor of the measure unit currently being read. 00072 /// 00073 /// \return 00074 /// Returns the scale factor of the measure unit 00075 /// 00076 FDO_API virtual double GetScaleFactor() = 0; 00077 00078 /// \brief 00079 /// Advances the reader to the next item. The default position of the 00080 /// reader is prior to the first item. Thus, you must call ReadNext 00081 /// to begin accessing any data. 00082 /// 00083 /// \return 00084 /// Returns true if there is a next item 00085 /// 00086 FDO_API virtual bool ReadNext() = 0; 00087 00088 /// \brief 00089 /// Closes the FdoIMeasureUnitReader object, freeing any resources it may be holding. 00090 /// 00091 /// \return 00092 /// Returns nothing 00093 /// 00094 FDO_API virtual void Close() = 0; 00095 }; 00096 #endif 00097 00098
| Comments or suggestions? Send us feedback. |