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 CIMParamValue class represents an extrinsic method parameter value, as defined in the DMTF Specification for CIM Operations over HTTP.

Documentation

The CIMParamValue class represents an extrinsic method parameter value, as defined in the DMTF Specification for CIM Operations over HTTP.

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

Inheritance:

Public Methods

	CIMParamValue () Constructs an uninitialized CIMParamValue object.
	CIMParamValue (const CIMParamValue& x) Constructs a CIMParamValue object from the value of a specified CIMParamValue object, so that both objects refer to the same data copy.
CIMParamValue&	operator= (const CIMParamValue& x) Assigns the value of the specified CIMParamValue object to this object, so that both objects refer to the same data copy.
	CIMParamValue ( String parameterName, CIMValue value, Boolean isTyped=true) Constructs a parameter value with the specified attributes.
	~CIMParamValue () Destructs the CIMParamValue object
String	getParameterName () const Gets the parameter name for the parameter value.
CIMValue	getValue () const Gets the value for the parameter.
Boolean	isTyped () const Checks whether the parameter value has the correct type.
void	setParameterName (String& parameterName) Sets the parameter name for the parameter value.
void	setValue (CIMValue& value) Sets the value for the parameter.
void	setIsTyped (Boolean isTyped) Sets a flag indicating whether the parameter value has the correct type.
CIMParamValue	clone () const Makes a deep copy of the object.
Boolean	isUninitialized () const Determines whether the object has been initialized.

CIMParamValue()

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

CIMParamValue(const CIMParamValue& x)

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

Parameters:

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

CIMParamValue& operator=(const CIMParamValue& x)

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

Parameters:

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

Returns:

A reference to this CIMParamValue object.

CIMParamValue( String parameterName, CIMValue value, Boolean isTyped=true)

Constructs a parameter value with the specified attributes.

Throws:

UninitializedObjectException If the parameter name is an empty String.

Parameters:

parameterName - A String containing the name of this parameter.
value - A CIMValue containing the value of this parameter.
- isTyped A Boolean indicating whether the type indicated in the value is correct. This is needed because the Specification for the Representation of CIM in XML does not require type information to be specified with a parameter value.

~CIMParamValue()

Destructs the CIMParamValue object

String getParameterName() const

Gets the parameter name for the parameter value.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A String containing the parameter name.

CIMValue getValue() const

Gets the value for the parameter.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A CIMValue containing the parameter value.

Boolean isTyped() const

Checks whether the parameter value has the correct type.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

True if the parameter value is known to have the correct type, false otherwise.

void setParameterName(String& parameterName)

Sets the parameter name for the parameter value.

Throws:

UninitializedObjectException If the object is not initialized.

Parameters:

parameterName - A String containing the parameter name.

void setValue(CIMValue& value)

Sets the value for the parameter.

Throws:

UninitializedObjectException If the object is not initialized.

Parameters:

value - A CIMValue containing the parameter value.

void setIsTyped(Boolean isTyped)

Sets a flag indicating whether the parameter value has the correct type.

Throws:

UninitializedObjectException If the object is not initialized.

Parameters:

- isTyped A Boolean indicating whether the parameter value is known to have the correct type.

CIMParamValue clone() const

Makes a deep copy of the object. This creates a new copy of all the object attributes.

Throws:

UninitializedObjectException If the object is not initialized.

Returns:

A new copy of the CIMParamValue object.

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 XmlWriter

Alphabetic index HTML hierarchy of classes or Java