[an error occurred while processing this directive]

Pegasus CIM Object Broker Documentation

[an error occurred while processing this directive]

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

In file ../../src/Pegasus/Common/CIMParameter.h:

class PEGASUS_COMMON_LINKAGE CIMParameter

The CIMParameter class represents the DMTF standard CIM parameter definition.

Documentation

The CIMParameter class represents the DMTF standard CIM parameter definition. A CIMParameter is generally defined in the context of a CIMMethod. A CIM Parameter consists of:

A CIMName containing the name of the parameter
A CIMType defining the parameter type
A Boolean indicating whether it is an Array parameter
A Uint32 indicating the size of the Array, if the parameter is an Array parameter
A CIMName containing the reference class name for this parameter, if the parameter is of reference type
Zero or more CIMQualifier objects

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

Inheritance:

Public Methods

CIMParameter()

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

CIMParameter(const CIMParameter& x)

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

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

Constructs a CIMParameter object with the specified attributes.


Throws:: TypeMismatchException If the parameter is of reference type and referenceClassName is null or if the parameter is not of reference type and referenceClassName is not null.
TypeMismatchException If isArray is true and arraySize is not zero.
UninitializedObjectException If the parameter name is null.
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.

~CIMParameter()

Destructs the CIMParameter object

CIMParameter& 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 CIMParameter object.
Returns:: A reference to this CIMParameter 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.

void setName(const CIMName& name)

Sets the parameter name.


Throws:: UninitializedObjectException If the object is not initialized.
Exception If the object is already contained by CIMMethod
Parameters:: name - A CIMName indicating the new name for 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.

CIMParameter& addQualifier(const CIMQualifier& x)

Adds a qualifier to the parameter.


Throws:: AlreadyExistsException If a qualifier with the same name already exists in the CIMParameter.
UninitializedObjectException If the object is not initialized.
Parameters:: x - The CIMQualifier to be added.
Returns:: A reference to this CIMParameter 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 CIMParameter.
UninitializedObjectException If the object is not initialized.
Parameters:: index - The index of the qualifier to be retrieved.
Returns:: The CIMQualifier at the specified index.

void removeQualifier(Uint32 index)

Removes a qualifier from the parameter.


Throws:: IndexOutOfBoundsException If the index is outside the range of qualifiers available for the CIMParameter.
UninitializedObjectException If the object is not initialized.
Parameters:: index - Index of the qualifier to be removed.

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.

              loop to access all qualifiers in a CIMparameter
             CIMParameter parm;
             ....                build the parameter
             for (Uint32 i = 0 ; i < parm.getQualifierCount() ; i++)
                 ....


Throws:: UninitializedObjectException If the object is not initialized.
Returns:: An integer count of the CIMQualifiers 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 new copy of the CIMParameter object.

This class has no child classes.


Friends:: class CIMConstParameter
class Resolver
class XmlWriter
class MofWriter
class BinaryStreamer

Alphabetic index HTML hierarchy of classes or Java

Pegasus CIM Object Broker Documentation

class PEGASUS_COMMON_LINKAGE CIMParameter

Documentation

Inheritance:

Public Methods

[an error occurred while processing this directive]