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

Documentation

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

Inheritance:

Public Methods

	CIMConstParameter () Constructs an uninitialized CIMConstParameter object.
	CIMConstParameter (const CIMConstParameter& x) Constructs a CIMConstParameter object from the value of a specified CIMConstParameter object, so that both objects refer to the same data copy.
	CIMConstParameter (const CIMParameter& x) Constructs a CIMConstParameter object from the value of a specified CIMParameter object, so that both objects refer to the same data copy.
	CIMConstParameter ( const CIMName& name, CIMType type, Boolean isArray = false, Uint32 arraySize = 0, const CIMName& referenceClassName = CIMName()) Constructs a CIMConstParameter object with the specified attributes.
	~CIMConstParameter () Destructs the CIMConstParameter object
CIMConstParameter&	operator= (const CIMConstParameter& x) Assigns the value of the specified CIMConstParameter object to this object, so that both objects refer to the same data copy.
CIMConstParameter&	operator= (const CIMParameter& x) Assigns the value of the specified CIMParameter object to this object, so that both objects refer to the same data copy.
const CIMName&	getName () const Gets the parameter name.
Boolean	isArray () const Checks whether the parameter is an Array parameter.
Uint32	getArraySize () const Gets the array size for the parameter.
const CIMName&	getReferenceClassName () const Gets the reference class name for the parameter.
CIMType	getType () const Gets the parameter type.
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 parameter.
Boolean	isUninitialized () const Determines whether the object has been initialized.
Boolean	identical (const CIMConstParameter& x) const Compares the parameter with another parameter.
CIMParameter	clone () const Makes a deep copy of the parameter.

CIMConstParameter()

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

CIMConstParameter(const CIMConstParameter& x)

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

Parameters:

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

CIMConstParameter(const CIMParameter& x)

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

Parameters:

x - The CIMParameter object from which to construct a new CIMConstParameter object.

CIMConstParameter( const CIMName& name, CIMType type, Boolean isArray = false, Uint32 arraySize = 0, const CIMName& referenceClassName = CIMName())

Constructs a CIMConstParameter object with the specified attributes.

Throws:

TypeMismatchException If the parameter is of reference type and referenceClassName is null.
TypeMismatchException If isArray is true and arraySize is not zero.

Parameters:

name - A CIMName specifying the name of the parameter.
type - A CIMType defining the parameter type.
- isArray A Boolean indicating whether it is an Array parameter.
arraySize - A Uint32 indicating the size of the Array, if the parameter is an Array parameter. The default value of zero indicates a variable size array.
referenceClassName - A CIMName containing the reference class name for this parameter, if the parameter is of reference type.

~CIMConstParameter()

Destructs the CIMConstParameter object

CIMConstParameter& operator=(const CIMConstParameter& x)

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

Parameters:

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

Returns:

A reference to this CIMConstParameter object.

CIMConstParameter& operator=(const CIMParameter& x)

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

Parameters:

x - The CIMParameter object from which to assign this CIMConstParameter object.

Returns:

A reference to this CIMConstParameter object.

const CIMName& getName() const

Gets the parameter name.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A CIMName containing the name of the parameter.

Boolean isArray() const

Checks whether the parameter is an Array parameter.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

True if the parameter is an Array parameter, false otherwise.

Uint32 getArraySize() const

Gets the array size for the parameter.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

Uint32 array size.

const CIMName& getReferenceClassName() const

Gets the reference class name for the parameter.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A CIMName containing the reference class name for the parameter if the parameter is of reference type, a null CIMName otherwise.

CIMType getType() const

Gets the parameter type.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A CIMType indicating the type of this parameter.

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 CIMParameter.
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 parameter.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

An integer count of the qualifiers in the CIMParameter.

Boolean isUninitialized() const

Determines whether the object has been initialized.

Returns:

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

Boolean identical(const CIMConstParameter& x) const

Compares the parameter with another parameter.

Throws:

UninitializedObjectException If either of the objects is not initialized.

Parameters:

x - The CIMConstParameter to be compared.

Returns:

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

CIMParameter clone() const

Makes a deep copy of the parameter. This creates a new copy of all the parameter attributes including qualifiers.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A CIMParameter object with a separate copy of the CIMConstParameter object.

This class has no child classes.

Friends:

class CIMParameter
class XmlWriter
class MofWriter

Alphabetic index HTML hierarchy of classes or Java