FDO .NET API Reference Feature Data Objects

mgICreateMeasureUnit.h

Go to the documentation of this file.
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\mgICommand.h"
00022 
00023 #include "FDO\Commands\UnitOfMeasure\mgBaseUnit.h"
00024 
00025 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE
00026 
00027 /// \ingroup (OSGeoFDOCommandsUnitOfMeasure)
00028 /// \interface OSGeo::FDO::Commands::UnitOfMeasure::ICreateMeasureUnit
00029 /// \brief
00030 /// The ICreateMeasureUnit interface defines the CreateMeasureUnit command,
00031 /// which creates or updates a measurement unit. Input to the command includes
00032 /// the abbreviation, name, description, measure type, base unit, and scale
00033 /// factor that defines the measure unit. The update existing flag indicates how
00034 /// the command should behave in the presence of an existing measure unit. If it is 
00035 /// false, and the specified measure unit already exists, command execution will
00036 /// fail. If it is true, the command will either create a new measure unit or update an
00037 /// existing one.
00038 public __gc __interface ICreateMeasureUnit : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
00039 {
00040 public:
00041     /// \brief
00042     /// Gets the abbreviation of the measure unit to create or update as a
00043     /// string. Abbreviations must be unique because they define the identity of a
00044     /// measurement unit.
00045     /// 
00046     /// \return
00047     /// Returns the abbreviation for the measure unit
00048     /// 
00049     __property System::String* get_Abbreviation();
00050 
00051     /// \brief
00052     /// Sets the abbreviation of the measure unit to create or update as a
00053     /// string. Abbreviations must be unique because they define the identity of a
00054     /// measurement unit.
00055     /// 
00056     /// \param value 
00057     /// Input the abbreviation for the measure unit
00058     /// 
00059     /// \return
00060     /// Returns nothing
00061     /// 
00062     __property System::Void set_Abbreviation(System::String* value);
00063 
00064     /// \brief
00065     /// Gets the name of the measure unit to create or update as a string.
00066     /// 
00067     /// \return
00068     /// Returns the name for the measure unit
00069     /// 
00070     __property System::String* get_Name();
00071 
00072     /// \brief
00073     /// Sets the name of the measure unit to create or update as a string.
00074     /// 
00075     /// \param value 
00076     /// Input the name for the measure unit
00077     /// 
00078     /// \return
00079     /// Returns nothing
00080     /// 
00081     __property System::Void set_Name(System::String* value);
00082 
00083     /// \brief
00084     /// Gets the description of the measure unit to create or update as a string.
00085     /// 
00086     /// \return
00087     /// Returns the description for the measure unit
00088     /// 
00089     __property System::String* get_Description();
00090 
00091     /// \brief
00092     /// Sets the description of the measure unit to create or update as a string.
00093     /// 
00094     /// \param value 
00095     /// Input the description for the measure unit
00096     /// 
00097     /// \return
00098     /// Returns nothing
00099     /// 
00100     __property System::Void set_Description(System::String* value);
00101 
00102     /// \brief
00103     /// Gets the base units that define the measure unit to create or update
00104     /// as an BaseUnit value.
00105     /// 
00106     /// \return
00107     /// Returns the base units
00108     /// 
00109     __property NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE::BaseUnit get_BaseUnit();
00110 
00111     /// \brief
00112     /// Sets the base units that define the measure unit to create or update
00113     /// as an BaseUnit value.
00114     /// 
00115     /// \param value 
00116     /// Input the base units
00117     /// 
00118     /// \return
00119     /// Returns nothing
00120     /// 
00121     __property System::Void set_BaseUnit(NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE::BaseUnit value);
00122 
00123     /// \brief
00124     /// Gets the scale factor to be applied to the base unit in order to get
00125     /// one of the units being defined.
00126     /// 
00127     /// \return
00128     /// Returns the scale factor
00129     /// 
00130     __property System::Double get_ScaleFactor();
00131 
00132     /// \brief
00133     /// Sets the scale factor to be applied to the base unit in order to get
00134     /// one of the units being defined.
00135     /// 
00136     /// \param value 
00137     /// Input the scale factor
00138     /// 
00139     /// \return
00140     /// Returns nothing
00141     /// 
00142     __property System::Void set_ScaleFactor(System::Double value);
00143 
00144     /// \brief
00145     /// Gets a Boolean flag that indicates how the CreateMeasureUnit command
00146     /// should behave if the measure unit already exists. If update existing is
00147     /// true and a measure unit with the specified abbreviation already exists
00148     /// then it will be updated. If update existing is false and a measure unit
00149     /// with the specified abbreviation already exists, command execution
00150     /// will fail.
00151     /// 
00152     /// \return
00153     /// Returns true if the existing measure unit can be updated
00154     /// 
00155     __property System::Boolean get_UpdateExisting();
00156 
00157     /// \brief
00158     /// Sets a Boolean flag that indicates how the CreateMeasureUnit command
00159     /// should behave if the measure unit already exists. If update existing
00160     /// is true and a measure unit of the specified name already exists,
00161     /// it will be updated. If update existing is false and a measure unit of
00162     /// the specified name already exists, command execution will fail.
00163     /// 
00164     /// \param value 
00165     /// Input Indicates if the existing measure unit can be updated
00166     /// 
00167     /// \return
00168     /// Returns nothing
00169     /// 
00170     __property System::Void set_UpdateExisting(System::Boolean value);
00171 
00172     /// \brief
00173     /// Executes the CreateMeasureUnit command. If the measure unit already
00174     /// exists and the update existing flag is set to false, an exception is thrown.
00175     /// 
00176     /// \return
00177     /// Returns nothing
00178     /// 
00179     System::Void Execute();
00180 };
00181 
00182 END_NAMESPACE_OSGEO_FDO_COMMANDS_UNITOFMEASURE
00183 
00184 

Comments or suggestions? Send us feedback.