CmpiInstance Class Reference

#include <cmpi/CmpiInstance.h>

Inheritance diagram for CmpiInstance:

List of all members.

Public Member Functions
	CmpiInstance (const CmpiObjectPath &op)
CmpiBoolean	instanceIsA (const char *className)
unsigned int	getPropertyCount ()
CmpiData	getProperty (const char *name) const
CmpiData	getProperty (const int index, CmpiString *name=NULL)
void	setProperty (const char *name, const CmpiData data)
void	setPropertyFilter (const char **properties, const char **keys)
CmpiObjectPath	getObjectPath () const
Protected Member Functions
	CmpiInstance (const CMPIInstance *enc)
CMPIInstance *	getEnc () const
Private Member Functions
	CmpiInstance ()
void *	makeInstance (CMPIBroker *mb, const CmpiObjectPath &cop)
CmpiBoolean	doInstanceIsA (CMPIBroker *mb, const char *className)
Friends
class	CmpiBroker
class	CmpiResult
class	CmpiInstanceMI
class	CmpiMethodMI
class	CmpiData

---

Detailed Description

This class represents the instance of a CIM class. It is used manipulate instances and their parts.

---

Constructor & Destructor Documentation

CmpiInstance::CmpiInstance (  const CMPIInstance *  enc  )  [protected]

Protected constructor used by MIDrivers to encapsulate CMPIInstance.

CmpiInstance::CmpiInstance (   )  [private]

Constructor - Should not be called

CmpiInstance::CmpiInstance (  const CmpiObjectPath &  op  )

Constructor - Creates an Instance object with the classname from the input parameter. Parameters: op  defining classname and namespace Returns: The new Instance object

---

Member Function Documentation

CmpiBoolean CmpiInstance::doInstanceIsA (  CMPIBroker *  mb, const char *  className )  [private]

CMPIInstance * CmpiInstance::getEnc (   )  const [protected]

Gets the encapsulated CMPIInstance.

CmpiObjectPath CmpiInstance::getObjectPath (   )  const

getObjectPath - generates an ObjectPath out of the namespace, classname and key propeties of this Instance Returns: the generated ObjectPath.

CmpiData CmpiInstance::getProperty (  const int  index, CmpiString *  name = NULL )

getProperty - Gets the CmpiData object defined by the input index parameter. Parameters: index  Index into the Property array. name  Optional output parameter returning the property name. Returns: CmpiData value object corresponding to the index.

CmpiData CmpiInstance::getProperty (  const char *  name  )  const

getProperty - Gets the CmpiData object representing the value associated with the property name Parameters: name  Property name. Returns: CmpiData value object associated with the property.

unsigned int CmpiInstance::getPropertyCount (   )

getPropertyCount - Gets the number of Properties defined for this Instance. Returns: Number of Properties of this instance.

CmpiBoolean CmpiInstance::instanceIsA (  const char *  className  )

instanceIsA - Tests whether this CIM Instance is of type <className>. Parameters: className  CIM classname to be tested for. Returns: True or False

void * CmpiInstance::makeInstance (  CMPIBroker *  mb, const CmpiObjectPath &  cop )  [private]

Internal make function

void CmpiInstance::setProperty (  const char *  name, const CmpiData  data )

setProperty - adds/replaces a property value defined by the input parameter to the Instance Parameters: name  Property name. data  Type and Value to be added.

void CmpiInstance::setPropertyFilter (  const char **  properties, const char **  keys )

setPropertyFilter - specifies the list of properties that is accepted for setProperty operestions. Parameters: properties  List of properties keys  List of key properties (required)

---

Friends And Related Function Documentation

friend class CmpiBroker [friend]

Reimplemented from CmpiObject.

friend class CmpiData [friend]

friend class CmpiInstanceMI [friend]

friend class CmpiMethodMI [friend]

friend class CmpiResult [friend]

---

The documentation for this class was generated from the following files:

• cmpi/CmpiInstance.h
• CmpiImpl.cpp

---