Pegasus CIM Object Broker Documentation

Contents

Introduction
Objectives
Overview
Credits
Pegasus Architecture
Design Goals
The Broker
Pegasus Providers.
Extension Services
Pegasus Clients.
Functional Flow
Pegasus Components
Component Descriptions
Pegasus Directory Structure
Pegasus Utilization
Pegasus Availability
Pegasus Installation
Pegasus Operation
Pegasus CIM Clients
Pegasus Providers
Pegasus MOF Compiler
Programming Pegasus
CIM Objects in Pegasus
CIM Object Table
Class Definitions
Pegasus Interfaces
CIM Operations over HTTP
Pegasus Client Interfaces
Pegasus Provider Interfaces
Pegasus Service Extension Interfaces
Repository Interfaces
Writing Providers.
Glossary
Pegasus Code Examples
Client Examples
Client Coding Examples
Provider Coding Examples
Document References
Pegausus FAQ

• Alphabetic index
• Hierarchy of classes

The CIMInstance class represents the DMTF standard CIM instance definition.

Documentation

The CIMInstance class represents the DMTF standard CIM instance definition.

The CIMInstance class uses a shared representation model, such that multiple CIMInstance objects may refer to the same data copy. Assignment and copy operators create new references to the same data, not distinct copies. An update to a CIMInstance object affects all the CIMInstance objects that refer to the same data copy. The data remains valid until all the CIMInstance objects that refer to it are destructed. A separate copy of the data may be created using the clone method.

Inheritance:

Public Methods

	CIMInstance () Constructs an uninitialized CIMInstance object.
	CIMInstance (const CIMInstance& x) Constructs a CIMInstance object from the value of a specified CIMInstance object, so that both objects refer to the same data copy.
explicit	CIMInstance (const CIMObject& x) Constructs a CIMInstance object from the value of a specified CIMObject object, so that both objects refer to the same data copy.
	CIMInstance (const CIMName& className) Constructs a CIMInstance object with the specified class name.
CIMInstance&	operator= (const CIMInstance& x) Assigns the value of the specified CIMInstance object to this object, so that both objects refer to the same data copy.
	~CIMInstance () Destructs the CIMInstance object
const CIMName&	getClassName () const Gets the class name of the instance.
const CIMObjectPath&	getPath () const Gets the object path for the instance.
void	setPath (const CIMObjectPath & path) Sets the object path for the instance.
CIMInstance&	addQualifier (const CIMQualifier& qualifier) Adds a qualifier to the instance.
Uint32	findQualifier (const CIMName& name) const Finds a qualifier by name.
CIMQualifier	getQualifier (Uint32 index) Gets the qualifier at the specified index.
CIMConstQualifier	getQualifier (Uint32 index) const Gets the qualifier at the specified index.
void	removeQualifier (Uint32 index) Removes a qualifier from the instance.
Uint32	getQualifierCount () const Gets the number of qualifiers in the instance.
CIMInstance&	addProperty (const CIMProperty& x) Adds a property to the instance.
Uint32	findProperty (const CIMName& name) const Finds a property by name.
CIMProperty	getProperty (Uint32 index) Gets the property at the specified index.
CIMConstProperty	getProperty (Uint32 index) const Gets the property at the specified index.
void	removeProperty (Uint32 index) Removes a property from the instance.
Uint32	getPropertyCount () const Gets the number of properties in the instance.
CIMObjectPath	buildPath (const CIMConstClass& cimClass) const Builds the object path for this instance, based on the class name and property values in the instance and the Key qualifiers on the properties in the class definition.
CIMInstance	clone () const Makes a deep copy of the instance.
Boolean	identical (const CIMConstInstance& x) const Compares the CIMInstance with a specified CIMConstInstance.
Boolean	isUninitialized () const Determines whether the object has been initialized.

CIMInstance()

Constructs an uninitialized CIMInstance object. A method invocation on an uninitialized object will result in the throwing of an UninitializedObjectException. An uninitialized object may be converted into an initialized object only by using the assignment operator with an initialized object.

CIMInstance(const CIMInstance& x)

Constructs a CIMInstance object from the value of a specified CIMInstance object, so that both objects refer to the same data copy.

Parameters:

x - The CIMInstance object from which to construct a new CIMInstance object.

explicit CIMInstance(const CIMObject& x)

Constructs a CIMInstance object from the value of a specified CIMObject object, so that both objects refer to the same data copy.

Throws:

DynamicCastFailedException If a CIMInstance can not be created from the given CIMObject.

Parameters:

x - The CIMObject object from which to construct the CIMInstance object.

CIMInstance(const CIMName& className)

Constructs a CIMInstance object with the specified class name.

Parameters:

className - A CIMName specifying the class name of the instance.

CIMInstance& operator=(const CIMInstance& x)

Assigns the value of the specified CIMInstance object to this object, so that both objects refer to the same data copy.

Parameters:

x - The CIMInstance object from which to assign this CIMInstance object.

Returns:

A reference to this CIMInstance object.

~CIMInstance()

Destructs the CIMInstance object

const CIMName& getClassName() const

Gets the class name of the instance.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A CIMName containing the class name.

const CIMObjectPath& getPath() const

Gets the object path for the instance.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A CIMObjectPath containing the object path.

void setPath(const CIMObjectPath & path)

Sets the object path for the instance.

Throws:

UninitializedObjectException If the object is not initialized.

Parameters:

path - A CIMObjectPath containing the object path.

CIMInstance& addQualifier(const CIMQualifier& qualifier)

Adds a qualifier to the instance.

Throws:

AlreadyExistsException If a qualifier with the same name already exists in the CIMInstance.
UninitializedObjectException If the object is not initialized.

Parameters:

qualifier - The CIMQualifier to be added.

Returns:

A reference to this CIMInstance object.

Uint32 findQualifier(const CIMName& name) const

Finds a qualifier by name.

Throws:

UninitializedObjectException If the object is not initialized.

Parameters:

name - A CIMName specifying the name of the qualifier to be found.

Returns:

Index of the qualifier if found or PEG_NOT_FOUND if not found.

CIMQualifier getQualifier(Uint32 index)

Gets the qualifier at the specified index.

Throws:

IndexOutOfBoundsException If the index is outside the range of qualifiers available for the CIMInstance.
UninitializedObjectException If the object is not initialized.

Parameters:

index - The index of the qualifier to be retrieved.

Returns:

The CIMQualifier at the specified index.

CIMConstQualifier getQualifier(Uint32 index) const

Gets the qualifier at the specified index.

Throws:

IndexOutOfBoundsException If the index is outside the range of qualifiers available for the CIMInstance.
UninitializedObjectException If the object is not initialized.

Parameters:

index - The index of the qualifier to be retrieved.

Returns:

The CIMConstQualifier at the specified index.

void removeQualifier(Uint32 index)

Removes a qualifier from the instance.

Throws:

IndexOutOfBoundsException If the index is outside the range of qualifiers available for the CIMInstance.
UninitializedObjectException If the object is not initialized.

Parameters:

index - The index of the qualifier to remove.

Uint32 getQualifierCount() const

Gets the number of qualifiers in the instance.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

An integer count of the qualifiers in the CIMInstance.

CIMInstance& addProperty(const CIMProperty& x)

Adds a property to the instance.

Throws:

AlreadyExistsException If a property with the same name already exists in the CIMInstance.
UninitializedObjectException If the object is not initialized.

Parameters:

x - The CIMProperty to be added.

Returns:

A reference to this CIMInstance object.

Uint32 findProperty(const CIMName& name) const

Finds a property by name.

Throws:

UninitializedObjectException If the object is not initialized.

Parameters:

name - A CIMName specifying the name of the property to be found.

Returns:

Index of the property if found or PEG_NOT_FOUND if not found.

CIMProperty getProperty(Uint32 index)

Gets the property at the specified index.

Throws:

IndexOutOfBoundsException If the index is outside the range of properties available for the CIMInstance.
UninitializedObjectException If the object is not initialized.

Parameters:

index - The index of the property to be retrieved.

Returns:

The CIMProperty at the specified index.

CIMConstProperty getProperty(Uint32 index) const

Gets the property at the specified index.

Throws:

IndexOutOfBoundsException If the index is outside the range of properties available for the CIMInstance.
UninitializedObjectException If the object is not initialized.

Parameters:

index - The index of the property to be retrieved.

Returns:

The CIMConstProperty at the specified index.

void removeProperty(Uint32 index)

Removes a property from the instance.

Throws:

IndexOutOfBoundsException If the index is outside the range of properties available for the CIMInstance.
UninitializedObjectException If the object is not initialized.

Parameters:

index - The index of the property to remove.

Uint32 getPropertyCount() const

Gets the number of properties in the instance.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

An integer count of the properties in the CIMInstance.

CIMObjectPath buildPath(const CIMConstClass& cimClass) const

Builds the object path for this instance, based on the class name and property values in the instance and the Key qualifiers on the properties in the class definition. The returned object path does not include hostname and namespace attributes. Note that this method does not update the path attribute of the CIMInstance.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A CIMObjectPath containing the object path for the instance.

CIMInstance clone() const

Makes a deep copy of the instance. This creates a new copy of all the instance attributes including qualifiers and properties.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A new copy of the CIMInstance object.

Boolean identical(const CIMConstInstance& x) const

Compares the CIMInstance with a specified CIMConstInstance.

Throws:

UninitializedObjectException If the object is not initialized.

Parameters:

x - The CIMConstInstance to be compared.

Returns:

True if this instance is identical to the one specified, false otherwise.

Boolean isUninitialized() const

Determines whether the object has been initialized.

Returns:

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

This class has no child classes.

Friends:

class CIMConstInstance
class CIMObject
class CIMConstObject
class Resolver
class XmlWriter
class MofWriter
class BinaryStreamer
class CIMClassRep
class SCMOInstance
class SCMOClass

Alphabetic index HTML hierarchy of classes or Java