CmpiObjectPath Class Reference

The ObjectPath class represents the value of a Instance reference. More...

#include <CmpiObjectPath.h>

Inheritance diagram for CmpiObjectPath:

Inheritance graph
[legend]
Collaboration diagram for CmpiObjectPath:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 CmpiObjectPath (CMPIObjectPath *c)
 Protected constructor used by MIDrivers to encapsulate CMPIObjectPathes.
CMPIObjectPathgetEnc () const
 Gets the encapsulated CMPIObjectPath.
 CmpiObjectPath ()
 Constructor - Should not be called.
void * makeObjectPath (CMPIBroker *mb, const char *ns, const char *cls)
void * makeObjectPath (CMPIBroker *mb, const CmpiString &ns, const char *cls)
CMPIBoolean doClassPathIsA (CMPIBroker *mb, const char *className)
 CmpiObjectPath (const char *ns, const char *cls)
 Constructor - Creates an ObjectPath object with the classname from the input parameter.
 CmpiObjectPath (const CmpiString &ns, const char *cls)
CMPIBoolean classPathIsA (const char *className)
 classPathIsA - Tests whether this CIM ObjectPath is a reference to a CIM class is of type <className>.
CmpiString getHostname () const
 getHostname - returns the hostname component of the ObjectPath
void setHostname (const char *hn)
 setHostname - Sets the hostname component.
void setHostname (CmpiString hn)
CmpiString getNameSpace () const
 getNameSpace - returns the namespace component of the ObjectPath
void setNameSpace (const char *ns)
 setNameSpace - Sets the namespace component.
void setNameSpace (CmpiString ns)
CmpiString getClassName () const
 getClassName - returns the classname component of the ObjectPath
void setClassName (const char *hn)
 setClassName - Sets the classname component.
void setClassName (CmpiString hn)
unsigned int getKeyCount () const
 getKeyCount - Gets the number of key properties defined for this ObjectPath.
CmpiData getKey (const char *name) const
 getKey - Gets the CmpiData object representing the value associated with the key
CmpiData getKey (const int index, CmpiString *name=NULL) const
 getKey - Gets the CmpiData object defined by the input index parameter.
void setKey (const char *name, CmpiData data)
 setKey - adds/replaces a key value defined by the input parameter to the ObjectPath

Friends

class CmpiBroker
class CmpiResult
class CmpiInstance
class CmpiInstanceMI
class CmpiMethodMI
class CmpiAssociationMI
class CmpiPropertyMI
class CmpiIndicationMI
class CmpiData

Detailed Description

The ObjectPath class represents the value of a Instance reference.

It constains the namespace, classname and key properties. ObjectPath can also be used to represent a class reference. In that case key properties will be ignored.

Definition at line 39 of file CmpiObjectPath.h.


Constructor & Destructor Documentation

CmpiObjectPath::CmpiObjectPath CMPIObjectPath c  )  [inline]
 

Protected constructor used by MIDrivers to encapsulate CMPIObjectPathes.

Definition at line 53 of file CmpiObjectPath.h.

CmpiObjectPath::CmpiObjectPath  )  [inline]
 

Constructor - Should not be called.

Definition at line 64 of file CmpiObjectPath.h.

CmpiObjectPath::CmpiObjectPath const char *  ns,
const char *  cls
[inline]
 

Constructor - Creates an ObjectPath object with the classname from the input parameter.

Parameters:
ns defining namespace or NULL
cls defining classname or NULL
Returns:
The new ObjectPath object

Definition at line 76 of file CmpiObjectPath.h.

References CmpiObject::enc, CmpiProviderBase::getBroker(), and makeObjectPath().

CmpiObjectPath::CmpiObjectPath const CmpiString ns,
const char *  cls
[inline]
 

Definition at line 79 of file CmpiObjectPath.h.

References CmpiObject::enc, CmpiProviderBase::getBroker(), makeObjectPath(), and ns.


Member Function Documentation

CMPIBoolean CmpiObjectPath::classPathIsA const char *  className  )  [inline]
 

classPathIsA - Tests whether this CIM ObjectPath is a reference to a CIM class is of type <className>.

Parameters:
className CIM classname to be tested for.
Returns:
True or False

Definition at line 88 of file CmpiObjectPath.h.

References doClassPathIsA(), and CmpiProviderBase::getBroker().

CMPIBoolean CmpiObjectPath::doClassPathIsA CMPIBroker mb,
const char *  className
 

Definition at line 814 of file CmpiImpl.cpp.

References _CMPIBrokerEncFT::classPathIsA, CMPI_RC_OK, CmpiBoolean, _CMPIBroker::eft, getEnc(), and _CMPIStatus::rc.

Referenced by classPathIsA().

CmpiString CmpiObjectPath::getClassName  )  const
 

getClassName - returns the classname component of the ObjectPath

Returns:
CmpiString containing the namespace.

Definition at line 845 of file CmpiImpl.cpp.

References CMPI_RC_OK, _CMPIObjectPath::ft, _CMPIObjectPathFT::getClassName, getEnc(), _CMPIStatus::rc, and s.

CMPIObjectPath* CmpiObjectPath::getEnc  )  const [inline]
 

Gets the encapsulated CMPIObjectPath.

Definition at line 58 of file CmpiObjectPath.h.

References CmpiObject::enc.

Referenced by doClassPathIsA(), getClassName(), getHostname(), getKey(), getKeyCount(), getNameSpace(), CmpiResult::returnData(), setClassName(), setHostname(), setKey(), and setNameSpace().

CmpiString CmpiObjectPath::getHostname  )  const
 

getHostname - returns the hostname component of the ObjectPath

Returns:
CmpiString containing the hostname.

Definition at line 833 of file CmpiImpl.cpp.

References CMPI_RC_OK, _CMPIObjectPath::ft, getEnc(), _CMPIObjectPathFT::getHostname, _CMPIStatus::rc, and s.

CmpiData CmpiObjectPath::getKey const int  index,
CmpiString name = NULL
const
 

getKey - Gets the CmpiData object defined by the input index parameter.

Parameters:
index Index into the key property array.
name Optional output parameter returning the key name.
Returns:
CmpiData value object corresponding to the index.

Definition at line 872 of file CmpiImpl.cpp.

References CMPI_RC_OK, CmpiData::data, _CMPIObjectPath::ft, getEnc(), _CMPIObjectPathFT::getKeyAt, name, _CMPIStatus::rc, and s.

CmpiData CmpiObjectPath::getKey const char *  name  )  const
 

getKey - Gets the CmpiData object representing the value associated with the key

Parameters:
name key name.
Returns:
CmpiData value object associated with the key.

Definition at line 857 of file CmpiImpl.cpp.

References CMPI_RC_OK, CmpiData::data, _CMPIObjectPath::ft, getEnc(), _CMPIObjectPathFT::getKey, and _CMPIStatus::rc.

unsigned int CmpiObjectPath::getKeyCount  )  const
 

getKeyCount - Gets the number of key properties defined for this ObjectPath.

Returns:
Number of key properties of this ObjectPath.

Definition at line 865 of file CmpiImpl.cpp.

References CMPI_RC_OK, _CMPIObjectPath::ft, getEnc(), _CMPIObjectPathFT::getKeyCount, and _CMPIStatus::rc.

CmpiString CmpiObjectPath::getNameSpace  )  const
 

getNameSpace - returns the namespace component of the ObjectPath

Returns:
CmpiString containing the namespace.

Definition at line 821 of file CmpiImpl.cpp.

References CMPI_RC_OK, _CMPIObjectPath::ft, getEnc(), _CMPIObjectPathFT::getNameSpace, _CMPIStatus::rc, and s.

void * CmpiObjectPath::makeObjectPath CMPIBroker mb,
const CmpiString ns,
const char *  cls
 

Definition at line 807 of file CmpiImpl.cpp.

References CMGetCharPtr, CMPI_RC_OK, _CMPIBroker::eft, _CMPIBrokerEncFT::newObjectPath, ns, and _CMPIStatus::rc.

void * CmpiObjectPath::makeObjectPath CMPIBroker mb,
const char *  ns,
const char *  cls
 

Definition at line 800 of file CmpiImpl.cpp.

References CMPI_RC_OK, _CMPIBroker::eft, _CMPIBrokerEncFT::newObjectPath, and _CMPIStatus::rc.

Referenced by CmpiObjectPath().

void CmpiObjectPath::setClassName CmpiString  hn  )  [inline]
 

Definition at line 128 of file CmpiObjectPath.h.

References CmpiString::charPtr(), and setClassName().

void CmpiObjectPath::setClassName const char *  hn  ) 
 

setClassName - Sets the classname component.

Parameters:
hn representing the hostname.

Definition at line 852 of file CmpiImpl.cpp.

References CMPI_RC_OK, _CMPIObjectPath::ft, getEnc(), _CMPIStatus::rc, and _CMPIObjectPathFT::setClassName.

Referenced by setClassName().

void CmpiObjectPath::setHostname CmpiString  hn  )  [inline]
 

Definition at line 102 of file CmpiObjectPath.h.

References CmpiString::charPtr(), and setHostname().

void CmpiObjectPath::setHostname const char *  hn  ) 
 

setHostname - Sets the hostname component.

Parameters:
hn representing the hostname.

Definition at line 840 of file CmpiImpl.cpp.

References CMPI_RC_OK, _CMPIObjectPath::ft, getEnc(), _CMPIStatus::rc, and _CMPIObjectPathFT::setHostname.

Referenced by setHostname().

void CmpiObjectPath::setKey const char *  name,
CmpiData  data
 

setKey - adds/replaces a key value defined by the input parameter to the ObjectPath

Parameters:
name key name.
data Type and Value to be added.

Definition at line 882 of file CmpiImpl.cpp.

References _CMPIObjectPathFT::addKey, _CMPIValue::chars, CMPI_chars, CMPI_RC_OK, CmpiData::data, _CMPIObjectPath::ft, getEnc(), _CMPIStatus::rc, _CMPIData::type, and _CMPIData::value.

void CmpiObjectPath::setNameSpace CmpiString  ns  )  [inline]
 

Definition at line 115 of file CmpiObjectPath.h.

References ns, and setNameSpace().

void CmpiObjectPath::setNameSpace const char *  ns  ) 
 

setNameSpace - Sets the namespace component.

Parameters:
ns representing the namespace.

Definition at line 828 of file CmpiImpl.cpp.

References CMPI_RC_OK, _CMPIObjectPath::ft, getEnc(), _CMPIStatus::rc, and _CMPIObjectPathFT::setNameSpace.

Referenced by setNameSpace().


Friends And Related Function Documentation

friend class CmpiAssociationMI [friend]
 

Definition at line 45 of file CmpiObjectPath.h.

friend class CmpiBroker [friend]
 

Reimplemented from CmpiObject.

Definition at line 40 of file CmpiObjectPath.h.

friend class CmpiData [friend]
 

Definition at line 48 of file CmpiObjectPath.h.

friend class CmpiIndicationMI [friend]
 

Definition at line 47 of file CmpiObjectPath.h.

friend class CmpiInstance [friend]
 

Reimplemented from CmpiObject.

Definition at line 42 of file CmpiObjectPath.h.

friend class CmpiInstanceMI [friend]
 

Definition at line 43 of file CmpiObjectPath.h.

friend class CmpiMethodMI [friend]
 

Definition at line 44 of file CmpiObjectPath.h.

friend class CmpiPropertyMI [friend]
 

Definition at line 46 of file CmpiObjectPath.h.

friend class CmpiResult [friend]
 

Definition at line 41 of file CmpiObjectPath.h.


The documentation for this class was generated from the following files:
Generated on Thu Feb 9 09:12:09 2006 for openwbem by  doxygen 1.4.6