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 CIMObject class represents the DMTF standard CIM object definition, which may represent a CIMClass or a CIMInstance.

Documentation

The CIMObject class represents the DMTF standard CIM object definition, which may represent a CIMClass or a CIMInstance.

The CIMObject class uses a shared representation model, such that multiple CIMObject 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 CIMObject object affects all the CIMObject objects that refer to the same data copy. The data remains valid until all the CIMObject objects that refer to it are destructed. A separate copy of the data may be created using the clone method.

Inheritance:

Public Methods

	CIMObject () Constructs an uninitialized CIMObject object.
	CIMObject (const CIMObject& x) Constructs a CIMObject object from the value of a specified CIMObject object, so that both objects refer to the same data copy.
	CIMObject (const CIMClass& x) Constructs a CIMObject object from the value of a specified CIMClass object, so that both objects refer to the same data copy.
	CIMObject (const CIMInstance& x) Constructs a CIMObject object from the value of a specified CIMInstance object, so that both objects refer to the same data copy.
CIMObject&	operator= (const CIMObject& x) Assigns the value of the specified CIMObject object to this object, so that both objects refer to the same data copy.
	~CIMObject () Destructs the CIMObject object
const CIMName&	getClassName () const Gets the class name of the object.
const CIMObjectPath&	getPath () const Gets the object path for the object.
void	setPath (const CIMObjectPath & path) Sets the object path for the object.
CIMObject&	addQualifier (const CIMQualifier& qualifier) Adds a qualifier to the object.
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 object.
Uint32	getQualifierCount () const Gets the number of qualifiers in the object.
CIMObject&	addProperty (const CIMProperty& x) Adds a property to the object.
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 object.
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 CIMObject 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 CIMClass.
Boolean	isInstance () const Indicates whether the object represents a CIMInstance.

CIMObject()

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

CIMObject(const CIMObject& x)

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

CIMObject(const CIMClass& x)

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

CIMObject(const CIMInstance& x)

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

CIMObject& operator=(const CIMObject& x)

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

Parameters:

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

Returns:

A reference to this CIMObject object.

~CIMObject()

Destructs the CIMObject 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.

void setPath(const CIMObjectPath & path)

Sets the object path for the object.

Throws:

UninitializedObjectException If the object is not initialized.

Parameters:

path - A CIMObjectPath containing the object path.

CIMObject& addQualifier(const CIMQualifier& qualifier)

Adds a qualifier to the object.

Throws:

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

Parameters:

qualifier - The CIMQualifier to be added.

Returns:

A reference to this CIMObject 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 CIMObject.
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 CIMObject.
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 object.

Throws:

IndexOutOfBoundsException If the index is outside the range of qualifiers available for the CIMObject.
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 object.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

An integer count of the qualifiers in the CIMObject.

CIMObject& addProperty(const CIMProperty& x)

Adds a property to the object.

Throws:

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

Parameters:

x - The CIMProperty to be added.

Returns:

A reference to this CIMObject 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 CIMObject.
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 CIMObject.
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 object.

Throws:

IndexOutOfBoundsException If the index is outside the range of properties available for the CIMObject.
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 object.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

An integer count of the properties in the CIMObject.

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 new copy of the CIMObject object.

Boolean identical(const CIMConstObject& x) const

Compares the CIMObject 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 CIMClass.

Returns:

True if the object represents a CIMClass; false otherwise.

Boolean isInstance() const

Indicates whether the object represents a CIMInstance.

Returns:

True if the object represents a CIMInstance; false otherwise.

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