[an error occurred while processing this directive]
[an error occurred while processing this directive] [an error occurred while processing this directive]

Pegasus CIM Object Broker Documentation
[an error occurred while processing this directive]


[an error occurred while processing this directive]

 

Contents

o Introduction
o Objectives
o Overview
o Credits
o Pegasus Architecture
   o Design Goals
   o The Broker
   o Pegasus Providers.
   o Extension Services
   o Pegasus Clients.
   o Functional Flow
o Pegasus Components
   o Component Descriptions
   o Pegasus Directory Structure
o Pegasus Utilization
   o Pegasus Availability
   o Pegasus Installation
   o Pegasus Operation
   o Pegasus CIM Clients
   o Pegasus Providers
   o Pegasus MOF Compiler
o Programming Pegasus
   o CIM Objects in Pegasus
   o CIM Object Table
   o Class Definitions
o Pegasus Interfaces
   o CIM Operations over HTTP
   o Pegasus Client Interfaces
   o Pegasus Provider Interfaces
   o Pegasus Service Extension Interfaces
   o Repository Interfaces
o Writing Providers.
o Glossary
o Pegasus Code Examples
   o Client Examples
   o Client Coding Examples
   o Provider Coding Examples
o Document References
o Pegausus FAQ
o
In file ../../src/Pegasus/Common/CIMPropertyList.h:

class PEGASUS_COMMON_LINKAGE CIMPropertyList

The CIMPropertyList class represents a propertyList parameter in a CIM operation request, as defined in the DMTF Specification for CIM Operations over HTTP.

Documentation

The CIMPropertyList class represents a propertyList parameter in a CIM operation request, as defined in the DMTF Specification for CIM Operations over HTTP.

This class consists of an array of property names and a flag indicating whether the list is null. A null property list indicates that no filtering is performed on the basis of this parameter. A non-null property list indicates that any property not specified in the list is to be filtered from the CIM operation response. (An empty property list implies that all properties should be filtered from the response.)

A null property list is created by using the default constructor or the clear method. An empty property list is created by setting the value to an empty Array.

Inheritance:

Public Methods

[more] CIMPropertyList ()
Constructs a null property list.
[more] CIMPropertyList (const CIMPropertyList& x)
Constructs a CIMPropertyList object from the value of a specified CIMPropertyList object.
[more] CIMPropertyList (const Array<CIMName>& propertyNames)
Constructs a non-null property list with the specified property names.
[more] ~CIMPropertyList ()
Destructs the CIMPropertyList object
[more]void set (const Array<CIMName>& propertyNames)
Sets the property list with the specified property names.
[more]CIMPropertyList& operator= (const CIMPropertyList& x)
Assigns the value of the specified CIMPropertyList object to this object.
[more]void clear ()
Sets the property list to a null value
[more]Boolean isNull () const
Determines whether the property list is null.
[more]Uint32 size () const
Gets the number of property names in the property list.
[more]const CIMName& operator[] (Uint32 index) const
Gets the property name at a specified index.
[more]Array<CIMName> getPropertyNameArray () const
Gets an Array of the property names in the property list.

o CIMPropertyList()
Constructs a null property list.

Example: 

            CIMPropertyList pl;
            assert(pl.isNull());

o CIMPropertyList(const CIMPropertyList& x)
Constructs a CIMPropertyList object from the value of a specified CIMPropertyList object.
Parameters:
x - The CIMPropertyList object from which to construct a new CIMPropertyList object.

o CIMPropertyList(const Array<CIMName>& propertyNames)
Constructs a non-null property list with the specified property names.

Example: 

            Array n;
            n.append("name");
            n.append("type");
            CIMPropertyList pl(n);
Parameters:
propertyNames - An Array of CIMNames specifying the property names in the list.

o ~CIMPropertyList()
Destructs the CIMPropertyList object

ovoid set(const Array<CIMName>& propertyNames)
Sets the property list with the specified property names. The resulting property list is non-null.

Example: 

            Array n;
            n.append("name");
            n.append("type");
            CIMPropertyList pl;
            pl.set(n);
            assert(pl.size() = 2);
Parameters:
propertyNames - An Array of CIMNames specifying the property names in the list.

oCIMPropertyList& operator=(const CIMPropertyList& x)
Assigns the value of the specified CIMPropertyList object to this object.
Parameters:
x - The CIMPropertyList object from which to assign this CIMPropertyList object.
Returns:
A reference to this CIMPropertyList object.

ovoid clear()
Sets the property list to a null value

oBoolean isNull() const
Determines whether the property list is null.
Returns:
True if the property list is null, false otherwise.

oUint32 size() const
Gets the number of property names in the property list.
Returns:
An integer count of the property names in the CIMPropertyList. A value of 0 is returned if the list is null or empty.

oconst CIMName& operator[](Uint32 index) const
Gets the property name at a specified index.

Example: 

            Array n;
            n.append("name");
            n.append("type");
            CIMPropertyList pl(n);
            assert(pl[0] == CIMName("name"));
Throws:
IndexOutOfBoundsException If the index is outside the range of property names in the property list or if the property list is null.
Parameters:
index - The index of the property name to be retrieved.
Returns:
A CIMName containing the property name at the specified index.

oArray<CIMName> getPropertyNameArray() const
Gets an Array of the property names in the property list.

Example: 

            Array n = pl.getPropertyNameArray();
Returns:
An Array of CIMName objects containing the property names in the property list.

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java
[an error occurred while processing this directive]