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

Documentation

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

Inheritance:

Public Methods

	CIMConstClass () Constructs an uninitialized CIMConstClass object.
	CIMConstClass (const CIMConstClass& x) Constructs a CIMConstClass object from the value of a specified CIMConstClass object, so that both objects refer to the same data copy.
	CIMConstClass (const CIMClass& x) Constructs a CIMConstClass object from the value of a specified CIMClass object, so that both objects refer to the same data copy.
explicit	CIMConstClass (const CIMObject& x) Constructs a CIMConstClass object from the value of a specified CIMObject object, so that both objects refer to the same data copy.
explicit	CIMConstClass (const CIMConstObject& x) Constructs a CIMConstClass object from the value of a specified CIMConstObject object, so that both objects refer to the same data copy.
	CIMConstClass ( const CIMName& className, const CIMName& superClassName = CIMName()) Constructs a CIMConstClass object with the specified attributes.
CIMConstClass&	operator= (const CIMConstClass& x) Assigns the value of the specified CIMConstClass object to this object, so that both objects refer to the same data copy.
CIMConstClass&	operator= (const CIMClass& x) Assigns the value of the specified CIMClass object to this object, so that both objects refer to the same data copy.
	~CIMConstClass () Destructs the CIMConstClass object
Boolean	isAssociation () const Indicates whether this class is an association class.
Boolean	isAbstract () const Indicates whether this class is an abstract class.
const CIMName&	getClassName () const Gets the name of the class.
const CIMObjectPath&	getPath () const Gets the object path for the class.
const CIMName&	getSuperClassName () const Gets the name of the parent class of this class.
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 class.
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 class.
Uint32	findMethod (const CIMName& name) const Finds a method by name.
CIMConstMethod	getMethod (Uint32 index) const Gets the method at the specified index.
Uint32	getMethodCount () const Gets the number of methods in the class.
void	getKeyNames (Array<CIMName>& keyNames) const Gets the list of key properties in this class.
Boolean	hasKeys () const Indicates whether this class contains key properties.
CIMClass	clone () const Makes a deep copy of the class.
Boolean	identical (const CIMConstClass& x) const Compares the CIMConstClass with a specified CIMConstClass.
Boolean	isUninitialized () const Determines whether the object has been initialized.

CIMConstClass()

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

CIMConstClass(const CIMConstClass& x)

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

CIMConstClass(const CIMClass& x)

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

explicit CIMConstClass(const CIMObject& x)

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

Throws:

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

Parameters:

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

explicit CIMConstClass(const CIMConstObject& x)

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

Throws:

DynamicCastFailedException If a CIMConstClass can not be created from the given CIMConstObject.

Parameters:

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

CIMConstClass( const CIMName& className, const CIMName& superClassName = CIMName())

Constructs a CIMConstClass object with the specified attributes.

Parameters:

className - A CIMName specifying the name of the class.
superClassName - A CIMName specifying name of the parent class. (A null value indicates no superclass.)

CIMConstClass& operator=(const CIMConstClass& x)

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

Parameters:

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

Returns:

A reference to this CIMConstClass object.

CIMConstClass& operator=(const CIMClass& x)

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

Parameters:

x - The CIMClass object from which to assign this CIMConstClass object.

Returns:

A reference to this CIMConstClass object.

~CIMConstClass()

Destructs the CIMConstClass object

Boolean isAssociation() const

Indicates whether this class is an association class. An association is a relationship between two (or more) classes or instances. The Association qualifier is used to make this determination.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

True if this class is an association class, false otherwise.

Boolean isAbstract() const

Indicates whether this class is an abstract class. The Abstract qualifier is used to make this determination.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

True if this class is an abstract class, false otherwise.

const CIMName& getClassName() const

Gets the name of the class.

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

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A CIMObjectPath containing the object path.

const CIMName& getSuperClassName() const

Gets the name of the parent class of this class.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A CIMName containing parent class name.

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 CIMConstClass.
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 class.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

An integer count of the qualifiers in the CIMConstClass.

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 CIMConstClass.
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 class.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

An integer count of the properties in the CIMConstClass.

Uint32 findMethod(const CIMName& name) const

Finds a method by name.

Throws:

UninitializedObjectException If the object is not initialized.

Parameters:

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

Returns:

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

CIMConstMethod getMethod(Uint32 index) const

Gets the method at the specified index.

Throws:

IndexOutOfBoundsException If the index is outside the range of methods available for the CIMConstClass.
UninitializedObjectException If the object is not initialized.

Parameters:

index - The index of the method to be retrieved.

Returns:

The CIMConstMethod at the specified index.

Uint32 getMethodCount() const

Gets the number of methods in the class.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

An integer count of the methods in the CIMConstClass.

void getKeyNames(Array<CIMName>& keyNames) const

Gets the list of key properties in this class. The Key qualifier on CIMConstProperty objects is used to locate key properties.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

An Array of CIMName objects containing the names of the key properties.

Boolean hasKeys() const

Indicates whether this class contains key properties. The Key qualifier on CIMConstProperty objects is used to make this determination.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

True if this class contains key properties, false otherwise.

CIMClass clone() const

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

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A CIMClass object with a separate copy of the CIMConstClass object.

Boolean identical(const CIMConstClass& x) const

Compares the CIMConstClass with a specified CIMConstClass.

Throws:

UninitializedObjectException If the object is not initialized.

Parameters:

x - The CIMConstClass to be compared.

Returns:

True if this class 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 CIMClassRep
class CIMClass
class CIMInstanceRep
class CIMObject
class CIMConstObject
class XmlWriter
class MofWriter
class BinaryStreamer
class SCMOClass

Alphabetic index HTML hierarchy of classes or Java