The CIMObject class is the superclass for the CIMInstance and CIMClass classes.

Documentation

The CIMObject class is the superclass for the CIMInstance and CIMClass classes.

The CIMObjectRep data member points to either a CIMInstanceRep or CIMClassRep.

Inheritance:

Public Methods

	CIMObject () Creates CIMObject instance with null values (default constructor)
	CIMObject (const CIMObject& x) Creates a new CIMObject instance (copy constructor).
	CIMObject (const CIMClass& x) Construction of a CIMObject instance based on the CIMClass object
	CIMObject (const CIMInstance& x) Construction of a CIMObject instance based on the CIMInstance object
CIMObject&	operator= (const CIMObject& x) Assign the values of the CIMObject instance to CIMObject.
	~CIMObject () Destroys CIMObject
const CIMName&	getClassName () const Gets the ClassName of the object.
const CIMObjectPath&	getPath () const REVIEWERS: Insert description here
void	setPath (const CIMObjectPath & path) Sets the object path for the object.
CIMObject&	addQualifier (const CIMQualifier& qualifier) Adds the CIMQualifier object to the instance.
Uint32	findQualifier (const CIMName& name) const Searches the instance for the qualifier object defined by the input parameter.
CIMQualifier	getQualifier (Uint32 index) Retrieves the qualifier object defined by the input parameter.
CIMConstQualifier	getQualifier (Uint32 index) const Retrieves the qualifier object defined by the input parameter.
void	removeQualifier (Uint32 index) REVIEWERS: Insert description here
Uint32	getQualifierCount () const Gets the number of CIMQualifier objects defined for this CIMObject.
CIMObject&	addProperty (const CIMProperty& x) Adds a property object defined by the input parameter to the CIMObject.
Uint32	findProperty (const CIMName& name) const Searches the CIMProperty objects in the CIMObject for a property object with the name defined by the input parameter.
CIMProperty	getProperty (Uint32 index) Gets the CIMProperty object in the CIMObject defined by the input parameter.
CIMConstProperty	getProperty (Uint32 index) const Gets the CIMproperty object in the CIMObject defined by the input parameter.
void	removeProperty (Uint32 index) Remove the specified property from the instance.
Uint32	getPropertyCount () const Gets the number of CIMProperty objects defined for this CIMObject.
CIMObject	clone () const Makes a deep copy (clone) of the given object.
Boolean	identical (const CIMConstObject& x) const Compares with another CIM Object.
Boolean	isUninitialized () const Determines if the object has not been initialized.
String	toString () const Returns a string representing the value of the CIMObject.
Boolean	isClass () const Determines if the object represents a CIMClass.
Boolean	isInstance () const Determines if the object represents a CIMInstance.

CIMObject()

Creates CIMObject instance with null values (default constructor)

CIMObject(const CIMObject& x)

Creates a new CIMObject instance (copy constructor).

Parameters:

x - Specifies the name of the CIMObject instance to create.

CIMObject(const CIMClass& x)

Construction of a CIMObject instance based on the CIMClass object

CIMObject(const CIMInstance& x)

Construction of a CIMObject instance based on the CIMInstance object

CIMObject& operator=(const CIMObject& x)

Assign the values of the CIMObject instance to CIMObject.

Parameters:

x - Specifies the name of the CIMObject instance.

~CIMObject()

Destroys CIMObject

const CIMName& getClassName() const

Gets the ClassName of the object.

Returns:

ClassName of the object in a CIMName parameter. For example,

CIMName className;
CIMClass myclass("myclass", "superclass");
className = myclass.getClassName;

const CIMObjectPath& getPath() const

REVIEWERS: Insert description here

void setPath(const CIMObjectPath & path)

Sets the object path for the object.

Parameters:

path - Specifies the CIMObjectPath that contains the object path.

CIMObject& addQualifier(const CIMQualifier& qualifier)

Adds the CIMQualifier object to the instance.

Throws:

AlreadyExistsException True if the CIMQualifier already exists in the instance; otherwise, false.

Parameters:

qualifier - CIMQualifier object to add to instance.

Returns:

The resulting CIMObject.

Uint32 findQualifier(const CIMName& name) const

Searches the instance for the qualifier object defined by the input parameter.

Parameters:

name - CIMName that defines the qualifier object to be found.

Returns:

Position of the qualifier to use in subsequent operations or PEG_NOT_FOUND if the qualifier is not found.

CIMQualifier getQualifier(Uint32 index)

Retrieves the qualifier object defined by the input parameter.

Throws:

IndexOutOfBoundsException True if the index is out of bounds; otherwise, false.

Parameters:

index - Specifies the index for the qualifier object. The index to qualifier objects is zero-origin and continuous so that incrementing loops can be used to get all qualifier objects in a CIMInstance.

Returns:

CIMQualifier object defined by the index.

CIMConstQualifier getQualifier(Uint32 index) const

Retrieves the qualifier object defined by the input parameter.

Throws:

IndexOutOfBoundsException True if the index is out of bounds; otherwise, false.

Parameters:

index - Specifies the index for the qualifier object. The index to qualifier objects is zero-origin and continuous so that incrementing loops can be used to get all qualifier objects in a CIMInstance.

Returns:

CIMConstQualifier object defined by the index.

void removeQualifier(Uint32 index)

REVIEWERS: Insert description here

Uint32 getQualifierCount() const

Gets the number of CIMQualifier objects defined for this CIMObject.

Returns:

Count of the number of CIMQualifier objects in the CIMObject.

CIMObject& addProperty(const CIMProperty& x)

Adds a property object defined by the input parameter to the CIMObject.

Throws:

AlreadyExistsException True if the property already exists otherwise, false.

Parameters:

x - Property Object to be added. See the CIM Property class for definition of the property object.

Returns:

The resulting CIMObject.

Uint32 findProperty(const CIMName& name) const

Searches the CIMProperty objects in the CIMObject for a property object with the name defined by the input parameter.

Parameters:

name - CIMName with the name of the property object to be found.

Returns:

Position in the CIM object of the property object if found or PEG_NOT_FOUND if no property object found with the name defined by the input parameter.

CIMProperty getProperty(Uint32 index)

Gets the CIMProperty object in the CIMObject defined by the input parameter.

Throws:

IndexOutOfBoundsException True if the index is out of bounds; otherwise, false.

Parameters:

index - Specifies the index to the property object in the CIMObject. The index to qualifier objects is zero-origin and continuous so that incrementing loops can be used to get all qualifier objects in a CIMObject.

Returns:

CIMProperty object corresponding to the index.

CIMConstProperty getProperty(Uint32 index) const

Gets the CIMproperty object in the CIMObject defined by the input parameter.

Throws:

IndexOutOfBoundsException True if the index is outside the range of properties in this object; otherwise, false.

Parameters:

index - Specifies the index to the property object in the CIMObject.

Returns:

CIMProperty object corresponding to the index.

void removeProperty(Uint32 index)

Remove the specified property from the instance.

Throws:

IndexOutOfBoundsException True if the index is outside the range of properties in this object; otherwise, false.

Parameters:

index - Specifies the index to the property to be removed from the instance. Normally this is obtained by findProperty();

Uint32 getPropertyCount() const

Gets the number of CIMProperty objects defined for this CIMObject.

Returns:

Count of the number of CIMProperty objects in the CIMObject. Zero indicates that no CIMProperty objects are contained in the CIMObject.

CIMObject clone() const

Makes a deep copy (clone) of the given object.

Returns:

Copy of the CIMObject.

Boolean identical(const CIMConstObject& x) const

Compares with another CIM Object.

Parameters:

x - CIM object for comparison.

Returns:

True if the objects are identical; otherwise, false.

Boolean isUninitialized() const

Determines if the object has not been initialized.

Returns:

True if the object has not been initialized; otherwise, false.

String toString() const

Returns a string representing the value of the CIMObject. With the inclusion of CIMObject as a CIMValue, the intent of the toString() method is to produce a "human-readable" string consistent with other CIMValue types. The string will be a MOF representation of the object (ie. either CIMClass or CIMInstance) using the _rep's toMof() method.

Returns:

String representing the CIMObject value.

Boolean isClass() const

Determines if the object represents a CIMClass.

Returns:

True if the object represents a CIMClass; otherwise, false.

Boolean isInstance() const

Determines if the object represents a CIMInstance.

Returns:

True if the object represents a CIMInstance; otherwise, false.

This class has no child classes.

Friends:

class CIMConstObject
class CIMClass
class CIMConstClass
class CIMInstance
class CIMConstInstance

Alphabetic index HTML hierarchy of classes or Java