OW_CIMClass.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_CIMCLASS_HPP_INCLUDE_GUARD_
#define OW_CIMCLASS_HPP_INCLUDE_GUARD_
#include "OW_config.h"
#include "OW_COWIntrusiveReference.hpp"
#include "OW_CIMElement.hpp"
#include "OW_CIMFwd.hpp"
#include "OW_String.hpp"
#include "OW_Array.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 CIMClass : public CIMElement
{
public:
   struct CLSData;
   static const char* const NAMESPACECLASS OW_DEPRECATED; // in 3.1.0

   enum { SERIALIZATION_VERSION = 2 };
   CIMClass();
   explicit CIMClass(CIMNULL_t);
   explicit CIMClass(const CIMName& name);
   explicit CIMClass(const char* name);
   CIMClass(const CIMClass& x);
   
   ~CIMClass();
   CIMClass& operator=(const CIMClass& x);
   virtual void setNull();
   String getSuperClass() const;
   String getKeyClass() const;
   CIMClass& setSuperClass(const CIMName& pname);
   bool isKeyed() const;
   CIMClass& setIsAssociation(bool isAssocFlag);
   CIMClass& setIsKeyed(bool isKeyedParm=true);
   CIMPropertyArray getKeys() const;
   CIMQualifier getQualifier(const CIMName& name) const;
   CIMProperty getProperty(const CIMName& name) const;
   CIMProperty getProperty(const CIMName& name,
      const CIMName& originClass) const;
   CIMMethod getMethod(const CIMName& name) const;
   CIMMethod getMethod(const CIMName& name,
      const CIMName& originClass) const;
   bool isAssociation() const;
   CIMQualifierArray getQualifiers() const;
   CIMPropertyArray getAllProperties() const;
   CIMPropertyArray getProperties() const;
   CIMMethodArray getAllMethods() const;
   CIMMethodArray getMethods() const;
   CIMClass& addProperty(const CIMProperty& prop);
   int numberOfProperties() const;
   CIMClass& setProperties(const CIMPropertyArray& props);
   CIMClass& setProperty(const CIMProperty& prop);
   CIMClass& addQualifier(const CIMQualifier& qual);
   bool hasQualifier(const CIMQualifier& qual) const;
   int numberOfQualifiers() const;
   bool removeQualifier(const CIMQualifier& qual);
   bool removeQualifier(const CIMName& name);
   bool removeProperty(const CIMName& name);
   CIMClass& setQualifiers(const CIMQualifierArray& quals);
   CIMClass& setQualifier(const CIMQualifier& qual);
   CIMClass& addMethod(const CIMMethod& meth);
   CIMClass& setMethods(const CIMMethodArray& meths);
   CIMClass& setMethod(const CIMMethod& meth);
   CIMInstance newInstance() const;
   CIMClass clone(
      WBEMFlags::ELocalOnlyFlag localOnly = WBEMFlags::E_NOT_LOCAL_ONLY,
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_INCLUDE_QUALIFIERS,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin = WBEMFlags::E_INCLUDE_CLASS_ORIGIN,
      const StringArray& propertyList=StringArray(),
      bool noProps=false) const;
   CIMClass filterProperties(const StringArray& propertyList,
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin) const;
   StringArray getCloneProps(
      WBEMFlags::ELocalOnlyFlag localOnly,
      WBEMFlags::EDeepFlag deep,
      const StringArray* propertyList,
      const CIMClass& requestedClass) const;
   
   StringArray getCloneProps(WBEMFlags::ELocalOnlyFlag localOnly,
      const StringArray* propertyList) const;
   // CIMElement implementation

   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<CLSData> CIMClass::*safe_bool;
   operator safe_bool () const
   {
      return m_pdata ? &CIMClass::m_pdata : 0;
   }
   bool operator!() const
   {
      return !this->m_pdata;
   }
private:

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

   COWIntrusiveReference<CLSData> m_pdata;

#ifdef OW_WIN32
#pragma warning (pop)
#endif

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

OW_COMMON_API bool operator<=(const CIMClass& x, const CIMClass& y);
OW_COMMON_API bool operator>(const CIMClass& x, const CIMClass& y);
OW_COMMON_API bool operator>=(const CIMClass& x, const CIMClass& y);
OW_COMMON_API bool operator!=(const CIMClass& x, const CIMClass& y);

} // end namespace OW_NAMESPACE

#endif

---