- Main Page
- Related Pages
- Modules
- Classes
- Files

# ParameterValue.h

Go to the documentation of this file.

    00001 #ifndef _PARAMETERVALUE_H_
    00002 #define _PARAMETERVALUE_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/Expression/LiteralValue.h>
    00028 #include <Fdo/Expression/StringValue.h>
    00029
    00030 /// \brief
    00031 /// The FdoParameterValue class specifies a value for a particular parameter.
    00032 /// Instances of this class are used to specify a value to bind to a parameter
    00033 /// when a command is executed.
    00034 class FdoParameterValue : public FdoIDisposable
    00035 {
    00036 /// \cond DOXYGEN-IGNORE
    00037 protected:
    00038     /// Constructs a default instance of a ParameterValue.
    00039     FdoParameterValue();
    00040
    00041     /// Constructs an instance of a ParameterValue using the specified arguments.
    00042     FdoParameterValue(FdoString* name);
    00043
    00044     /// Constructs an instance of a ParameterValue using the specified arguments.
    00045     FdoParameterValue(FdoString* name, FdoLiteralValue* value);
    00046
    00047     virtual ~FdoParameterValue();
    00048
    00049     virtual void Dispose();
    00050 /// \endcond
    00051
    00052 public:
    00053     /// \brief
    00054     /// Constructs a default instance of an FdoParameterValue.
    00055     ///
    00056     /// \return
    00057     /// Returns FdoParameterValue
    00058     ///
    00059     FDO_API static FdoParameterValue* Create();
    00060
    00061     /// \brief
    00062     /// Constructs an instance of an FdoParameterValue using the specified arguments.
    00063     ///
    00064     /// \param name
    00065     /// Input name
    00066     ///
    00067     /// \return
    00068     /// Returns FdoParameterValue
    00069     ///
    00070     FDO_API static FdoParameterValue* Create(FdoString* name);
    00071
    00072     /// \brief
    00073     /// Constructs an instance of an FdoParameterValue using the specified arguments.
    00074     ///
    00075     /// \param name
    00076     /// Input name
    00077     /// \param value
    00078     /// Input literal value
    00079     ///
    00080     /// \return
    00081     /// Returns FdoParameterValue
    00082     ///
    00083     FDO_API static FdoParameterValue* Create(FdoString* name, FdoLiteralValue* value);
    00084
    00085     /// \brief
    00086     /// Gets the parameter name the value should bind to as a string.
    00087     ///
    00088     /// \return
    00089     /// Returns parameter name
    00090     ///
    00091     FDO_API FdoString* GetName();
    00092
    00093     /// \brief
    00094     /// Sets the parameter name the value should bind to as a string.
    00095     ///
    00096     /// \param value
    00097     /// Input parameter name
    00098     ///
    00099     /// \return
    00100     /// Returns nothing
    00101     ///
    00102     FDO_API void SetName(FdoString* value);
    00103
    00104     /// \brief
    00105     /// Gets the value to bind to the parameter as an FdoLiteralValue.
    00106     ///
    00107     /// \return
    00108     /// Returns literal value
    00109     ///
    00110     FDO_API FdoLiteralValue* GetValue();
    00111
    00112     /// \brief
    00113     /// Sets the value to bind to the parameter as an FdoLiteralValue.
    00114     ///
    00115     /// \param value
    00116     /// Input literal value
    00117     ///
    00118     /// \return
    00119     /// Returns nothing
    00120     ///
    00121     FDO_API void SetValue(FdoLiteralValue* value);
    00122
    00123     /// \brief
    00124     /// Sets the value to bind to the parameter as a string.
    00125     ///
    00126     /// \param value
    00127     /// Input string
    00128     ///
    00129     /// \return
    00130     /// Returns nothing
    00131     ///
    00132     FDO_API void SetValue(FdoString* value);
    00133
    00134 protected:
    00135 /// \cond DOXYGEN-IGNORE
    00136     wchar_t*            m_name;
    00137     FdoLiteralValue*    m_value;
    00138 /// \endcond
    00139 };
    00140 #endif
    00141
    00142

Please send us your comment about this page