OW_CIMInstance.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_CIMINSTANCE_HPP_INCLUDE_GUARD_
#define OW_CIMINSTANCE_HPP_INCLUDE_GUARD_
#include "OW_config.h"
#include "OW_COWIntrusiveReference.hpp"
#include "OW_CIMElement.hpp"
#include "OW_CIMFwd.hpp"
#include "OW_CIMDataType.hpp" // for OW_CIMDataType::INVALID
#include "OW_WBEMFlags.hpp"
#include "OW_CIMName.hpp" // necessary for implicit conversion (const char* -> CIMName) to work
#include "OW_String.hpp" // for default parameter StringArray()
#include "OW_Array.hpp"

namespace OW_NAMESPACE
{

class OW_COMMON_API CIMInstance : public CIMElement
{
public:
   struct INSTData;
   
   enum { SERIALIZATION_VERSION = 2 };          // Version # for serialization
   
   enum EErrorCodes
   {
      E_INSTANCE_HAS_NO_SUCH_PROPERTY
   };

   CIMInstance();
   explicit CIMInstance(CIMNULL_t);
   CIMInstance(const CIMInstance& arg);
   explicit CIMInstance(const CIMName& name);
   explicit CIMInstance(const char* name);
   ~CIMInstance();
   virtual void setNull();
   CIMInstance& operator= (const CIMInstance& arg);
   String getClassName() const;
   CIMInstance& setKeys(const CIMPropertyArray& keys);
   CIMInstance& setClassName(const CIMName& name);
   String getLanguage() const;
   CIMInstance& setLanguage(const String& language);
   CIMQualifierArray getQualifiers() const;
   CIMQualifier getQualifier(const CIMName& qualName) const;
   CIMInstance& removeQualifier(const CIMName& qualName);
   CIMInstance& setQualifiers(const CIMQualifierArray& quals);
   CIMInstance& setQualifier(const CIMQualifier& qual);
   CIMPropertyArray getProperties(
      Int32 valueDataType = CIMDataType::INVALID) const;
   CIMInstance& setProperties(const CIMPropertyArray& props);
   CIMProperty getProperty(const CIMName& name,
      const CIMName& originClass) const;
   CIMProperty getProperty(const CIMName& name) const;
   CIMProperty getPropertyT(const CIMName& name) const;
   CIMValue getPropertyValue(const CIMName& name) const;
   bool propertyHasValue(const CIMName& name) const;
   CIMPropertyArray getKeyValuePairs() const;
   CIMInstance& updatePropertyValues(const CIMPropertyArray& props);
   CIMInstance& updatePropertyValue(const CIMProperty& prop);
   CIMInstance& updatePropertyValue(const CIMName& name, const CIMValue& cv);
   CIMInstance& setProperty(const CIMName& name, const CIMValue& cv);
   CIMInstance& setProperty(const CIMProperty& prop);
   CIMInstance& removeProperty(const CIMName& propName);
   CIMInstance filterProperties(const StringArray& propertyList,
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers, WBEMFlags::EIncludeClassOriginFlag includeClassOrigin,
      bool ignorePropertyList=false) const;
   CIMInstance clone(WBEMFlags::ELocalOnlyFlag localOnly, WBEMFlags::EIncludeQualifiersFlag includeQualifiers,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin,
      const StringArray& propertyList=StringArray(),
      bool noProps=false) const;
   CIMInstance clone(WBEMFlags::ELocalOnlyFlag localOnly, WBEMFlags::EIncludeQualifiersFlag includeQualifiers,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin, const StringArray* propertyList) const;
   CIMInstance clone(WBEMFlags::ELocalOnlyFlag localOnly, WBEMFlags::EDeepFlag deep, WBEMFlags::EIncludeQualifiersFlag includeQualifiers,
      WBEMFlags::EIncludeClassOriginFlag includeClassOrigin, const StringArray* propertyList,
      const CIMClass& requestedClass, const CIMClass& cimClass) const;
   CIMInstance& syncWithClass(const CIMClass& cc,
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers = WBEMFlags::E_INCLUDE_QUALIFIERS);
   CIMInstance createModifiedInstance(
      const CIMInstance& previousInstance,
      WBEMFlags::EIncludeQualifiersFlag includeQualifiers,
      const StringArray* propertyList,
      const CIMClass& theClass) const;
   virtual String getName() const;
   virtual void setName(const CIMName& name);
   CIMInstance& setNameSpace(const String& ns);
   String getNameSpace() const;
   virtual void readObject(std::istream &istrm);
   virtual void writeObject(std::ostream &ostrm) const;
   virtual String toMOF() const;
   virtual String toString() const;
   bool propertiesAreEqualTo(const CIMInstance& other) const;

   typedef COWIntrusiveReference<INSTData> CIMInstance::*safe_bool;
   operator safe_bool () const
      {  return m_pdata ? &CIMInstance::m_pdata : 0; }
   bool operator!() const
      {  return !m_pdata; }
   
protected:
   void _buildKeys();

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

   COWIntrusiveReference<INSTData> m_pdata;
   
#ifdef OW_WIN32
#pragma warning (pop)
#endif

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

} // end namespace OW_NAMESPACE

#endif

---