OW_CIMMethod.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2001-2004 Vintela, Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of source code must retain the above copyright notice,
*    this list of conditions and the following disclaimer.
*
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this list of conditions and the following disclaimer in the documentation
*    and/or other materials provided with the distribution.
*
*  - Neither the name of Vintela, Inc. nor the names of its
*    contributors may be used to endorse or promote products derived from this
*    software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL Vintela, Inc. OR THE CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/

#ifndef OW_CIMMETHOD_HPP_INCLUDE_GUARD_
#define OW_CIMMETHOD_HPP_INCLUDE_GUARD_
#include "OW_config.h"
#include "OW_COWIntrusiveReference.hpp"
#include "OW_CIMElement.hpp"
#include "OW_CIMFwd.hpp"
#include "OW_CIMNULL.hpp"
#include "OW_WBEMFlags.hpp"
#include "OW_CIMName.hpp" // necessary for implicit conversion (const char* -> CIMName) to work

namespace OW_NAMESPACE
{

class OW_COMMON_API CIMMethod : public CIMElement
{
public:
   struct METHData;
   CIMMethod();
   explicit CIMMethod(CIMNULL_t);
   explicit CIMMethod(const CIMName& name);
   explicit CIMMethod(const char* name);
   CIMMethod(const CIMMethod& arg);
   ~CIMMethod();
   virtual void setNull();
   CIMMethod& operator= (const CIMMethod& arg);
   CIMMethod& setQualifiers(const CIMQualifierArray& quals);
   CIMMethod& addQualifier(const CIMQualifier& qual);
   CIMQualifierArray getQualifiers() const;
   CIMQualifier getQualifier(const CIMName& name) const;
   String getOriginClass() const;
   CIMMethod& setOriginClass(const CIMName& originCls);
   
   CIMMethod& addParameter(const CIMParameter& param);
   CIMMethod& setParameters(const CIMParameterArray& inParms);
   CIMParameterArray getParameters() const;
   CIMParameterArray getINParameters() const;
   CIMParameterArray getOUTParameters() const;
   CIMMethod& setReturnType(const CIMDataType& type);
   CIMDataType getReturnType() const;
   Int32 getReturnDataSize() const;
   CIMMethod& setOverridingMethod(const CIMName& omname);
   String getOverridingMethod() const;
   CIMMethod& setPropagated(bool propagated=true);
   bool getPropagated() const;
   CIMMethod clone(
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_INCLUDE_QUALIFIERS,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin = WBEMFlags::E_INCLUDE_CLASS_ORIGIN) const;
   virtual String getName() const;
   virtual void setName(const CIMName& name);
   virtual void readObject(std::istream &istrm);
   virtual void writeObject(std::ostream &ostrm) const;
   virtual String toMOF() const;
   virtual String toString() const;

   typedef COWIntrusiveReference<METHData> CIMMethod::*safe_bool;
   operator safe_bool () const
      {  return m_pdata ? &CIMMethod::m_pdata : 0; }
   bool operator!() const
      {  return !m_pdata; }
protected:

#ifdef OW_WIN32
#pragma warning (push)
#pragma warning (disable: 4251)
#endif

   COWIntrusiveReference<METHData> m_pdata;

#ifdef OW_WIN32
#pragma warning (pop)
#endif

   friend OW_COMMON_API bool operator<(const CIMMethod& x, const CIMMethod& y);
};

} // end namespace OW_NAMESPACE

#endif

---