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