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 CIMConstObject class provides a const interface to a CIMObject object.

Documentation

The CIMConstObject class provides a const interface to a CIMObject object. This class is needed because the shared representation model used by CIMObject does not prevent modification to a const CIMObject object. Note that the value of a CIMConstObject object could still be modified by a CIMObject object that refers to the same data copy.

Inheritance:

Public Methods

	CIMConstObject () Constructs an uninitialized CIMConstObject object.
	CIMConstObject (const CIMConstObject& x) Constructs a CIMConstObject object from the value of a specified CIMConstObject object, so that both objects refer to the same data copy.
	CIMConstObject (const CIMObject& x) Constructs a CIMConstObject object from the value of a specified CIMObject object, so that both objects refer to the same data copy.
	CIMConstObject (const CIMClass& x) Constructs a CIMConstObject object from the value of a specified CIMClass object, so that both objects refer to the same data copy.
	CIMConstObject (const CIMInstance& x) Constructs a CIMConstObject object from the value of a specified CIMInstance object, so that both objects refer to the same data copy.
	CIMConstObject (const CIMConstClass& x) Constructs a CIMConstObject object from the value of a specified CIMConstClass object, so that both objects refer to the same data copy.
	CIMConstObject (const CIMConstInstance& x) Constructs a CIMConstObject object from the value of a specified CIMConstInstance object, so that both objects refer to the same data copy.
CIMConstObject&	operator= (const CIMConstObject& x) Assigns the value of the specified CIMConstObject object to this object, so that both objects refer to the same data copy.
	~CIMConstObject () Destructs the CIMConstObject object
const CIMName&	getClassName () const Gets the class name of the object.
const CIMObjectPath&	getPath () const Gets the object path for the object.
Uint32	findQualifier (const CIMName& name) const Finds a qualifier by name.
CIMConstQualifier	getQualifier (Uint32 index) const Gets the qualifier at the specified index.
Uint32	getQualifierCount () const Gets the number of qualifiers in the object.
Uint32	findProperty (const CIMName& name) const Finds a property by name.
CIMConstProperty	getProperty (Uint32 index) const Gets the property at the specified index.
Uint32	getPropertyCount () const Gets the number of properties in the object.
CIMObject	clone () const Makes a deep copy of the object.
Boolean	identical (const CIMConstObject& x) const Compares the CIMConstObject with a specified CIMConstObject.
Boolean	isUninitialized () const Determines whether the object has been initialized.
String	toString () const Generates a human-readable String representing the value of the CIMObject.
Boolean	isClass () const Indicates whether the object represents a CIMConstClass.
Boolean	isInstance () const Indicates whether the object represents a CIMConstInstance.

CIMConstObject()

Constructs an uninitialized CIMConstObject 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.

CIMConstObject(const CIMConstObject& x)

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

Parameters:

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

CIMConstObject(const CIMObject& x)

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

Parameters:

x - The CIMObject object from which to construct a new CIMConstObject object.

CIMConstObject(const CIMClass& x)

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

Parameters:

x - The CIMClass object from which to construct the CIMConstObject object.

CIMConstObject(const CIMInstance& x)

Constructs a CIMConstObject 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 the CIMConstObject object.

CIMConstObject(const CIMConstClass& x)

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

Parameters:

x - The CIMConstClass object from which to construct the CIMConstObject object.

CIMConstObject(const CIMConstInstance& x)

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

Parameters:

x - The CIMConstInstance object from which to construct the CIMConstObject object.

CIMConstObject& operator=(const CIMConstObject& x)

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

Parameters:

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

Returns:

A reference to this CIMConstObject object.

~CIMConstObject()

Destructs the CIMConstObject object

const CIMName& getClassName() const

Gets the class name of the object.

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 object.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A CIMObjectPath containing the object path.

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.

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 CIMConstObject.
UninitializedObjectException If the object is not initialized.

Parameters:

index - The index of the qualifier to be retrieved.

Returns:

The CIMConstQualifier at the specified index.

Uint32 getQualifierCount() const

Gets the number of qualifiers in the object.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

An integer count of the qualifiers in the CIMConstObject.

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.

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 CIMConstObject.
UninitializedObjectException If the object is not initialized.

Parameters:

index - The index of the property to be retrieved.

Returns:

The CIMConstProperty at the specified index.

Uint32 getPropertyCount() const

Gets the number of properties in the object.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

An integer count of the properties in the CIMConstObject.

CIMObject clone() const

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

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A CIMObject object with a separate copy of the CIMConstObject object.

Boolean identical(const CIMConstObject& x) const

Compares the CIMConstObject with a specified CIMConstObject.

Throws:

UninitializedObjectException If the object is not initialized.

Parameters:

x - The CIMConstObject to be compared.

Returns:

True if this object 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.

String toString() const

Generates a human-readable String representing the value of the CIMObject. The String may be in MOF format, but the format is not guaranteed and may change without notice.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A human-readable String representing the CIMObject value.

Boolean isClass() const

Indicates whether the object represents a CIMConstClass.

Returns:

True if the object represents a CIMConstClass; false otherwise.

Boolean isInstance() const

Indicates whether the object represents a CIMConstInstance.

Returns:

True if the object represents a CIMConstInstance; false otherwise.

This class has no child classes.

Friends:

class CIMObject
class CIMClass
class CIMConstClass
class CIMInstance
class CIMConstInstance

Alphabetic index HTML hierarchy of classes or Java