[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/CIMProperty.h:

class PEGASUS_COMMON_LINKAGE CIMConstProperty

The CIMConstProperty class provides a const interface to a CIMProperty object.

Documentation

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

Inheritance:

Public Methods

CIMConstProperty()

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

CIMConstProperty(const CIMConstProperty& x)

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


Parameters:: x - The CIMConstProperty object from which to construct a new CIMConstProperty object.

CIMConstProperty(const CIMProperty& x)

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


Parameters:: x - The CIMProperty object from which to construct a new CIMConstProperty object.

CIMConstProperty( const CIMName& name, const CIMValue& value, Uint32 arraySize = 0, const CIMName& referenceClassName = CIMName(), const CIMName& classOrigin = CIMName(), Boolean propagated = false)

Constructs a CIMConstProperty object with the specified attributes.


Throws:: TypeMismatchException If the property is of reference type and referenceClassName is null or if the property is not of reference type and referenceClassName is not null.
TypeMismatchException If the property is an Array property and arraySize is not zero.
UninitializedObjectException If the property name is null.
Parameters:: name - A CIMName specifying the name of the property.
value - A CIMValue specifying the property value, and implicitly defining the property type and whether the property is an Array property.
arraySize - A Uint32 indicating the size of the Array, if the property is an Array property. The default value of zero indicates a variable size array.
referenceClassName - A CIMName containing the reference class name for this property, if the property is of reference type.
classOrigin - A CIMName indicating the class in which the property is locally defined (optional).
propagated - A Boolean indicating whether the property is local to the class or instance in which it appears or was propagated (without modification) from other schema.

~CIMConstProperty()

Destructs the CIMConstProperty object

CIMConstProperty& operator=(const CIMConstProperty& x)

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


Parameters:: x - The CIMConstProperty object from which to assign this CIMConstProperty object.
Returns:: A reference to this CIMConstProperty object.

CIMConstProperty& operator=(const CIMProperty& x)

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


Parameters:: x - The CIMProperty object from which to assign this CIMConstProperty object.
Returns:: A reference to this CIMConstProperty object.

const CIMName& getName() const

Gets the name of the property.


Throws:: UninitializedObjectException If the object is not initialized.
Returns:: A CIMName containing the name of the property.

const CIMValue& getValue() const

Gets the property value.


Throws:: UninitializedObjectException If the object is not initialized.
Returns:: A CIMValue containing the property value.

CIMType getType() const

Gets the property type.


Throws:: UninitializedObjectException If the object is not initialized.
Returns:: A CIMType containing the property type.

Boolean isArray() const

Checks whether the property is an Array property.


Throws:: UninitializedObjectException If the object is not initialized.
Returns:: True if the property is an Array property, false otherwise.

Uint32 getArraySize() const

Gets the array size for the property.


Throws:: UninitializedObjectException If the object is not initialized.
Returns:: Uint32 array size.

const CIMName& getReferenceClassName() const

Gets the reference class name for the property.


Throws:: UninitializedObjectException If the object is not initialized.
Returns:: A CIMName containing the reference class name for the property if the property is of reference type, a null CIMName otherwise.

const CIMName& getClassOrigin() const

Gets the class in which this property is locally defined. This information is normally available with properties that are part of schema returned from a CIM Server.


Throws:: UninitializedObjectException If the object is not initialized.
Returns:: CIMName containing the classOrigin attribute.

Boolean getPropagated() const

Tests the propagated attribute of the object. The propagated attribute indicates whether this property was propagated from a higher-level class. Normally this attribute is set as part of defining a property in the context of a schema. It is set in properties retrieved from a CIM Server.


Throws:: UninitializedObjectException If the object is not initialized.
Returns:: True if property is propagated; otherwise, false.

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 CIMConstProperty.
UninitializedObjectException If the object is not initialized.
Parameters:: index - The index of the qualifier to be retrieved.
Returns:: The CIMConstQualifier object at the specified index.

Uint32 getQualifierCount() const

Gets the number of qualifiers in the property.


Throws:: UninitializedObjectException If the object is not initialized.
Returns:: An integer count of the qualifiers in the CIMConstProperty.

Boolean identical(const CIMConstProperty& x) const

Compares the property with another property.


Throws:: UninitializedObjectException If either of the objects is not initialized.
Parameters:: x - The CIMConstProperty to be compared.
Returns:: True if this property is identical to the one specified, false otherwise.

CIMProperty clone() const

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


Throws:: UninitializedObjectException If the object is not initialized.
Returns:: A CIMProperty object with a separate copy of the CIMConstProperty 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 CIMProperty
class CIMPropertyRep
class XmlWriter
class MofWriter
class CIMPropertyInternal
class SCMOClass
class SCMOInstance

Alphabetic index HTML hierarchy of classes or Java

Pegasus CIM Object Broker Documentation

class PEGASUS_COMMON_LINKAGE CIMConstProperty

Documentation

Inheritance:

Public Methods

[an error occurred while processing this directive]