FDO API Reference Feature Data Objects

IDestroyMeasureUnit.h

Go to the documentation of this file.
00001 #ifndef _IDESTROYMEASUREUNIT_H_
00002 #define _IDESTROYMEASUREUNIT_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/Connections/IConnection.h>
00028 #include <Fdo/Commands/ICommand.h>
00029 
00030 /// \brief
00031 /// The FdoIDestroyMeasureUnit interface defines the DestroyMeasureUnit command,
00032 /// which deletes a measurement unit. Input to the command is simply the
00033 /// abbreviation of the measure unit to be destroyed.
00034 class FdoIDestroyMeasureUnit : public FdoICommand
00035 {
00036     friend class FdoIConnection;
00037 
00038 public:
00039     /// \brief
00040     /// Gets the abbreviation of the measure unit to destroy as a string
00041     /// 
00042     /// \return
00043     /// Returns the abbreviation of the measure unit to be deleted.
00044     /// 
00045     FDO_API virtual FdoString* GetAbbreviation() = 0;
00046 
00047     /// \brief
00048     /// Sets the abbreviation of the measure unit to destroy as a string
00049     /// 
00050     /// \param value 
00051     /// Input the abbreviation of the measure unit to be deleted.
00052     /// 
00053     /// \return
00054     /// Returns nothing
00055     /// 
00056     FDO_API virtual void SetAbbreviation(FdoString* value) = 0;
00057 
00058     /// \brief
00059     /// Executes the DestroyMeasureUnit command.
00060     /// 
00061     /// \return
00062     /// Returns nothing
00063     /// 
00064     FDO_API virtual void Execute() = 0;
00065 };
00066 #endif
00067 
00068 

Comments or suggestions? Send us feedback.