OW_CIMObjectPath.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_CIMOBJECTPATH_HPP_INCLUDE_GUARD_
#define OW_CIMOBJECTPATH_HPP_INCLUDE_GUARD_
#include "OW_config.h"
#include "OW_COWIntrusiveReference.hpp"
#include "OW_CIMBase.hpp"
#include "OW_CIMFwd.hpp"
#include "OW_CIMNULL.hpp"
#include "OW_CIMName.hpp" // necessary for implicit conversion (const char* -> CIMName) to work

namespace OW_NAMESPACE
{

class OW_COMMON_API CIMObjectPath : public CIMBase
{
private:
   struct OPData;
   friend bool operator<(const CIMObjectPath::OPData& x, 
         const CIMObjectPath::OPData& y);
public:
   static String escape(const String& inString);
   static String unEscape(const String& inString);
   CIMObjectPath();
   explicit CIMObjectPath(CIMNULL_t);
   explicit CIMObjectPath(const CIMName& className);
   explicit CIMObjectPath(const char* className);
   CIMObjectPath(const CIMName& className, const String& nspace);
   CIMObjectPath(const CIMName& className,
      const CIMPropertyArray& keys);
   CIMObjectPath(const String& ns,
      const CIMInstance& inst);
   CIMObjectPath(const CIMObjectPath& arg);
   ~CIMObjectPath();
   virtual void setNull();
   CIMObjectPath& operator= (const CIMObjectPath& arg);
   CIMObjectPath& addKey(const CIMName& keyname, const CIMValue& value) OW_DEPRECATED; // in 3.0.0
   CIMObjectPath& addKey(const CIMProperty& key) OW_DEPRECATED; // in 3.0.0
   CIMPropertyArray getKeys() const;
   CIMProperty getKey(const CIMName& keyName) const;
   CIMProperty getKeyT(const CIMName& keyName) const;
   CIMValue getKeyValue(const CIMName& name) const;
   bool keyHasValue(const CIMName& name) const;
   CIMObjectPath& setKeys(const CIMPropertyArray& newKeys);
   CIMObjectPath& setKeys(const CIMInstance& instance);
   CIMObjectPath& setKeyValue(const CIMName& name, const CIMValue& value);
   String getNameSpace() const;
   CIMUrl getNameSpaceUrl() const;
   String getHost() const;
   String getObjectName() const OW_DEPRECATED; // in 3.0.0
   String getClassName() const;
   static CIMObjectPath parse(const String& instanceName);
   CIMObjectPath& setHost(const String& host);
   CIMObjectPath& setNameSpace(const String& ns);
   CIMObjectPath& setObjectName(const CIMName& className) OW_DEPRECATED; // in 3.0.0
   CIMObjectPath& setClassName(const CIMName& className);
   bool equals(const CIMObjectPath& op) const;

   typedef COWIntrusiveReference<OPData> CIMObjectPath::*safe_bool;
   operator safe_bool () const
      {  return m_pdata ? &CIMObjectPath::m_pdata : 0; }
   bool operator!() const
      {  return !m_pdata; }
   bool operator== (const CIMObjectPath& op) const
   {
      return equals(op);
   }

   bool operator!= (const CIMObjectPath& op) const
   {
      return !equals(op);
   }
   CIMNameSpace getFullNameSpace() const;
   bool isClassPath() const;
   bool isInstancePath() const;
   virtual String toString() const;
   virtual String modelPath() const;
   virtual String toMOF() const;
   virtual void readObject(std::istream& istrm);
   virtual void writeObject(std::ostream& ostrm) const;

   CIMObjectPath& syncWithClass(const CIMClass& theClass);

private:

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

   COWIntrusiveReference<OPData> m_pdata;

#ifdef OW_WIN32
#pragma warning (pop)
#endif

   friend OW_COMMON_API bool operator<(const CIMObjectPath& lhs, const CIMObjectPath& rhs);
};

} // end namespace OW_NAMESPACE

#endif

---