Class CIMInstance - The CIMInstance class represents the instance of a CIM class in Pegasus.

Documentation

Class CIMInstance - The CIMInstance class represents the instance of a CIM class in Pegasus. It is used manipulate instances and the characteristics of instances

Inheritance:

Public Methods

	CIMInstance () Constructor - Create a CIM Instance object.
	CIMInstance (const CIMInstance& x) Constructor - Create a CIMInstance object from another Instance.
CIMInstance&	operator= (const CIMInstance& x) Constructor.
	CIMInstance (const String& className) Constructor - Creates an Instance object with the classname from the input parameters
	~CIMInstance () Destructor.
const String&	getClassName () const getClassName - Returns the class name of the instance
CIMInstance&	addQualifier (const CIMQualifier& qualifier) addQualifier - Adds the CIMQualifier object to the instance.
Uint32	findQualifier (const String& name) findQualifier - Searches the instance for the qualifier object defined by the input parameter.
Uint32	existsQualifier (const String& name) existsQualifier - Searches the instance for the qualifier object defined by the input parameter.
CIMQualifier	getQualifier (Uint32 pos) getQualifier - Retrieves the qualifier object defined by the index input parameter.
CIMConstQualifier	getQualifier (Uint32 pos) const getQualifier - Retrieves the qualifier object defined by the index input parameter.
Uint32	getQualifierCount () const getQualifierCount - Gets the numbercount of CIMQualifierobjects defined for this CIMInstance.
CIMInstance&	addProperty (const CIMProperty& x) addProperty - Adds a property object defined by the input parameter to the CIMInstance
Uint32	findProperty (const String& name) findProperty - Searches the CIMProperty objects installed in the CIMInstance for property objects with the name defined by the input.
Boolean	existsProperty (const String& name) existsPropery - Determines if a property object with the name defined by the input parameter exists in the class.
CIMProperty	getProperty (Uint32 pos) getProperty - Gets the CIMproperty object in the CIMInstance defined by the input index parameter.
CIMConstProperty	getProperty (Uint32 pos) const getProperty - Gets the CIMproperty object in the CIMInstance defined by the input index parameter.
void	removeProperty (Uint32 pos) removeProperty - Removes the property represented by the position input parameter from the instance.
Uint32	getPropertyCount () const getPropertyCount - Gets the numbercount of CIMProperty objects defined for this CIMInstance.
	operator int () const operator int() - ATTN:
void	resolve (DeclContext* declContext, const String& nameSpace) resolve - ATTN:
void	toXml (Array<Sint8>& out) const toXml - Creates an XML transformation of the CIMInstance compatiblewith the DMTF CIM Operations over HTTP defintions.
void	print (PEGASUS_STD(ostream) &o=PEGASUS_STD(cout)) const prints the class in XML format.
Boolean	identical (const CIMConstInstance& x) const identical - Compares the CIMInstance with another CIMInstance defined by the input parameter for equality of all components.
CIMInstance	clone () const CIMMethod
CIMReference	getInstanceName (const CIMConstClass& cimClass) const getInstnaceName - Get the instance name of this instance.

CIMInstance()

Constructor - Create a CIM Instance object.

Returns:

Instance created

CIMInstance(const CIMInstance& x)

Constructor - Create a CIMInstance object from another Instance.

Parameters:

Instance - object from which the new instance is created.

Returns:

New instance

CIMInstance& operator=(const CIMInstance& x)

Constructor.

CIMInstance(const String& className)

Constructor - Creates an Instance object with the classname from the input parameters

Throws:

Throws IllegalName if className argument not legal CIM identifier. ATTN: Clarify the defintion of legal CIM identifier.

Parameters:

- - String className to be used with new instance object

Returns:

The new instance object

~CIMInstance()

Destructor.

const String& getClassName() const

getClassName - Returns the class name of the instance

Returns:

String with the class name.

CIMInstance& addQualifier(const CIMQualifier& qualifier)

addQualifier - Adds the CIMQualifier object to the instance. Thows an exception of the CIMQualifier already exists in the instance

Throws:

Throws AlreadyExists.

Parameters:

- CIMQualifier object to add to instance

Returns:

ATTN:

Uint32 findQualifier(const String& name)

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

Parameters:

- String defining the qualifier object to be found.

Returns:

- Position of the qualifier to be used in subsequent operations or PEG_NOT_FOUND if the qualifier is not found.

Uint32 existsQualifier(const String& name)

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

Parameters:

- String defining the qualifier object to be found.

Returns:

- Returns True if the qualifier object exists or false if the qualifier is not found.

CIMQualifier getQualifier(Uint32 pos)

getQualifier - Retrieves the qualifier object defined by the index input parameter. @ 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 CIMInstnace.

Throws:

Throws the OutOfBounds exception if the index is out of bounds

Returns:

: Returns qualifier object defined by index.

CIMConstQualifier getQualifier(Uint32 pos) const

getQualifier - Retrieves the qualifier object defined by the index input parameter. @ 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 CIMInstnace.

Throws:

Throws the OutOfBounds exception if the index is out of bounds ATTN: What is effect of out of range index??? ATTN: Is the above statement correct???

Returns:

: Returns qualifier object defined by index.

Uint32 getQualifierCount() const

getQualifierCount - Gets the numbercount of CIMQualifierobjects defined for this CIMInstance.

Throws:

Throws the OutOfBounds exception if the index is out of bounds

Returns:

Count of the number of CIMQalifier objects in the CIMInstance.

CIMInstance& addProperty(const CIMProperty& x)

addProperty - Adds a property object defined by the input parameter to the CIMInstance

Throws:

Throws the exception AlreadyExists if the property already exists.

Parameters:

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

Returns:

ATTN:

Uint32 findProperty(const String& name)

findProperty - Searches the CIMProperty objects installed in the CIMInstance for property objects with the name defined by the input.

Parameters:

- String with the name of the property object to be found

Returns:

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

Boolean existsProperty(const String& name)

existsPropery - Determines if a property object with the name defined by the input parameter exists in the class. @parm String parameter with the property name.

Returns:

True if the property object exists.

CIMProperty getProperty(Uint32 pos)

getProperty - Gets the CIMproperty object in the CIMInstance defined by the input index parameter.

Throws:

Throws the OutOfBounds exception if the index is out of bounds ATTN: What is the effect of out of range?

Parameters:

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

Returns:

CIMProperty object corresponding to the index.

CIMConstProperty getProperty(Uint32 pos) const

getProperty - Gets the CIMproperty object in the CIMInstance defined by the input index parameter.

Throws:

Throws the OutOfBounds exception if the index is out of bounds ATTN: What is the effect of out of range?

Parameters:

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

Returns:

CIMProperty object corresponding to the index.

void removeProperty(Uint32 pos)

removeProperty - Removes the property represented by the position input parameter from the instance.

Throws:

Throws OutofBounds if index is not a property object

Parameters:

pos - Index to the property to be removed from the instance. Normally this is obtained by getProperty();

Uint32 getPropertyCount() const

getPropertyCount - Gets the numbercount of CIMProperty objects defined for this CIMInstance.

Throws:

Throws the OutOfBounds exception if the index is out of bounds

Returns:

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

operator int() const

operator int() - ATTN:

void resolve(DeclContext* declContext, const String& nameSpace)

resolve - ATTN:

void toXml(Array<Sint8>& out) const

toXml - Creates an XML transformation of the CIMInstance compatiblewith the DMTF CIM Operations over HTTP defintions.

Returns:

ATTN: This is incorrect and needs to be corrected.

void print(PEGASUS_STD(ostream) &o=PEGASUS_STD(cout)) const

prints the class in XML format.

Boolean identical(const CIMConstInstance& x) const

identical - Compares the CIMInstance with another CIMInstance defined by the input parameter for equality of all components.

Parameters:

- CIMInstance to be compared

Returns:

Boolean true if they are identical

CIMInstance clone() const

CIMMethod

CIMReference getInstanceName(const CIMConstClass& cimClass) const

getInstnaceName - Get the instance name of this instance. The class argument is used to determine which fields are keys. The instance name has this from:

	    ClassName.key1=value1,...,keyN=valueN
	

The instance name is in standard form (the class name and key name is all lowercase; the keys-value pairs appear in sorted order by key name).

This class has no child classes.

Friends:

class CIMConstInstance
class CIMObject

Alphabetic index HTML hierarchy of classes or Java