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

class PEGASUS_COMMON_LINKAGE CIMValue

The CIMValue class represents a value of any of the CIM data types.

Documentation

The CIMValue class represents a value of any of the CIM data types. This class encapsulates a union which holds value of any CIMType. A type field indicates the type of the value.
WARNING: The returned value of CIMValue get(returnValue) is never nodified when a CIMValue is null (i.e. isNull() == true). An isNull() test should be executed before executing any CIMValue get(...) if there is any question of a possible null value and you are not sure of the value in the returned variable.

Inheritance:

Public Methods

CIMValue()

Constructs a null CIMValue with type Boolean and isArray=false

CIMValue(CIMType type, Boolean isArray, Uint32 arraySize = 0)

Constructs a null CIMValue object with the specified type and array indicator.


Parameters:: type - The CIMType of the value
- isArray A Boolean indicating whether the value is of array type
arraySize - An integer specifying the size of the array, if the CIMValue is for an array of a fixed size. This value is ignored if the isArray argument is false.

CIMValue(Boolean x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Boolean value to assign

CIMValue(Uint8 x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Uint8 value to assign

CIMValue(Sint8 x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Sint8 value to assign

CIMValue(Uint16 x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Uint16 value to assign

CIMValue(Sint16 x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Sint16 value to assign

CIMValue(Uint32 x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Uint32 value to assign

CIMValue(Sint32 x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Sint32 value to assign

CIMValue(Uint64 x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Uint64 value to assign

CIMValue(Sint64 x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Sint64 value to assign

CIMValue(Real32 x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Real32 value to assign

CIMValue(Real64 x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Real64 value to assign

CIMValue(const Char16& x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Char16 value to assign

CIMValue(const String& x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The String value to assign

CIMValue(const CIMDateTime& x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The CIMDateTime value to assign

CIMValue(const CIMObjectPath& x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The CIMObjectPath value to assign

CIMValue(const CIMObject& x)

Constructs a CIMValue with the specified value and inferred type. Note: The CIMObject argument is cloned to prevent subsequent modification through the shared representation model.


Throws:: UninitializedObjectException If the CIMObject is uninitialized.
Parameters:: x - The CIMObject value to assign

CIMValue(const CIMInstance& x)

Constructs a CIMValue with the specified value and inferred type. Note: The CIMInstance argument is cloned to prevent subsequent modification through the shared representation model.


Throws:: UninitializedObjectException If the CIMInstance is uninitialized.
Parameters:: x - The CIMInstance value to assign

CIMValue(const Array<Boolean>& x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Boolean Array value to assign

CIMValue(const Array<Uint8>& x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Uint8 Array value to assign

CIMValue(const Array<Sint8>& x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Sint8 Array value to assign

CIMValue(const Array<Uint16>& x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Uint16 Array value to assign

CIMValue(const Array<Sint16>& x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Sint16 Array value to assign

CIMValue(const Array<Uint32>& x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Uint32 Array value to assign

CIMValue(const Array<Sint32>& x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Sint32 Array value to assign

CIMValue(const Array<Uint64>& x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Uint64 Array value to assign

CIMValue(const Array<Sint64>& x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Sint64 Array value to assign

CIMValue(const Array<Real32>& x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Real32 Array value to assign

CIMValue(const Array<Real64>& x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Real64 Array value to assign

CIMValue(const Array<Char16>& x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The Char16 Array value to assign

CIMValue(const Array<String>& x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The String Array value to assign

CIMValue(const Array<CIMDateTime>& x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The CIMDateTime Array value to assign

CIMValue(const Array<CIMObjectPath>& x)

Constructs a CIMValue with the specified value and inferred type.


Parameters:: x - The CIMObjectPath Array value to assign

CIMValue(const Array<CIMObject>& x)

Constructs a CIMValue with the specified value and inferred type. Note: The CIMObjects in the Array argument are cloned to prevent subsequent modification through the shared representation model.


Throws:: UninitializedObjectException If any of the CIMObjects in the Array are uninitialized.
Parameters:: x - The CIMObject Array value to assign

CIMValue(const Array<CIMInstance>& x)

Constructs a CIMValue with the specified value and inferred type. Note: The CIMInstances in the Array argument are cloned to prevent subsequent modification through the shared representation model.


Throws:: UninitializedObjectException If any of the CIMInstances in the Array are uninitialized.
Parameters:: x - The CIMInstance Array value to assign

CIMValue(const CIMValue& x)

Constructs a CIMValue by copying another CIMValue object. Note: If the specified CIMValue contains CIMObject or CIMInstance objects, they are cloned to prevent subsequent modification through the shared representation model.


Parameters:: x - The CIMValue object to copy

~CIMValue()

Destructs a CIMValue object

CIMValue& operator=(const CIMValue& x)

Assigns the value from a specified CIMValue object. Note: If the specified CIMValue contains CIMObject or CIMInstance objects, they are cloned to prevent subsequent modification through the shared representation model.


Parameters:: x - The CIMValue object to copy
Returns:: A reference to this CIMValue object with the new assignment

void assign(const CIMValue& x)


Parameters:: x - The CIMValue object to copy

void clear()

Resets to a null value with type Boolean and isArray=false

Boolean typeCompatible(const CIMValue& x) const

Compares the type and isArray attributes with a specified CIMValue.


Parameters:: x - The CIMValue object with which to compare
Returns:: A Boolean indicating whether the CIMValue objects have the same type and isArray attribute value.

Boolean isArray() const

Indicates whether the value is an array.


Returns:: A Boolean indicating whether the value is an array.

Boolean isNull() const

Indicates whether the value is null. A null CIMValue has a type, but no value can be retrieved from it.


Returns:: A Boolean indicating whether the value is null.

Uint32 getArraySize() const

Gets the fixed array size of a CIMValue. This value is undefined for non-array values. A value of 0 is given for variable size arrays. Result is undetermined if CIMValue is null.


Returns:: An integer indicating the array size.

CIMType getType() const

Gets the value type.


Returns:: A CIMType indicating the type of the value.

void setNullValue(CIMType type, Boolean isArray, Uint32 arraySize = 0)

Sets the value to null with the specified type and array indicator.


Parameters:: type - The CIMType of the value
- isArray A Boolean indicating whether the value is of array type
arraySize - An integer specifying the size of the array, if the CIMValue is for an array of a fixed size. This value is ignored if the isArray argument is false.

void set(Boolean x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Boolean value to assign

void set(Uint8 x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Uint8 value to assign

void set(Sint8 x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Sint8 value to assign

void set(Uint16 x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Uint16 value to assign

void set(Sint16 x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Sint16 value to assign

void set(Uint32 x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Uint32 value to assign

void set(Sint32 x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Sint32 value to assign

void set(Uint64 x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Uint64 value to assign

void set(Sint64 x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Sint64 value to assign

void set(Real32 x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Real32 value to assign

void set(Real64 x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Real64 value to assign

void set(const Char16& x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Char16 value to assign

void set(const String& x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The String value to assign

void set(const CIMDateTime& x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The CIMDateTime value to assign

void set(const CIMObjectPath& x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The CIMObjectPath value to assign

void set(const CIMObject& x)

Sets the CIMValue to the specified value and inferred type. Note: The CIMObject argument is cloned to prevent subsequent modification through the shared representation model.


Throws:: UninitializedObjectException If the CIMObject is uninitialized.
Parameters:: x - The CIMObject value to assign

void set(const CIMInstance& x)

Sets the CIMValue to the specified value and inferred type. Note: The CIMInstance argument is cloned to prevent subsequent modification through the shared representation model.


Throws:: UninitializedObjectException If the CIMInstance is uninitialized.
Parameters:: x - The CIMInstance value to assign

void set(const Array<Boolean>& x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Boolean Array value to assign

void set(const Array<Uint8>& x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Uint8 Array value to assign

void set(const Array<Sint8>& x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Sint8 Array value to assign

void set(const Array<Uint16>& x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Uint16 Array value to assign

void set(const Array<Sint16>& x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Sint16 Array value to assign

void set(const Array<Uint32>& x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Uint32 Array value to assign

void set(const Array<Sint32>& x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Sint32 Array value to assign

void set(const Array<Uint64>& x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Uint64 Array value to assign

void set(const Array<Sint64>& x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Sint64 Array value to assign

void set(const Array<Real32>& x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Real32 Array value to assign

void set(const Array<Real64>& x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Real64 Array value to assign

void set(const Array<Char16>& x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The Char16 Array value to assign

void set(const Array<String>& x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The String Array value to assign

void set(const Array<CIMDateTime>& x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The CIMDateTime Array value to assign

void set(const Array<CIMObjectPath>& x)

Sets the CIMValue to the specified value and inferred type.


Parameters:: x - The CIMObjectPath Array value to assign

void set(const Array<CIMObject>& x)

Sets the CIMValue to the specified value and inferred type. Note: The CIMObjects in the Array argument are cloned to prevent subsequent modification through the shared representation model.


Throws:: UninitializedObjectException If any of the CIMObjects in the Array are uninitialized.
Parameters:: x - The CIMObject Array value to assign

void set(const Array<CIMInstance>& x)

Sets the CIMValue to the specified value and inferred type. Note: The CIMInstances in the Array argument are cloned to prevent subsequent modification through the shared representation model.


Throws:: UninitializedObjectException If any of the CIMInstances in the Array are uninitialized.
Parameters:: x - The CIMInstance Array value to assign

void get(Boolean& x) const

Gets the value of the CIMValue. The caller should first verify that the value is not null and may verify type to avoid the possibility of the TypeMismatchException. The output parameter x is NOT updated if the value is null (isNull() == true).

             get with complete checking on type and nullness
            Boolean v;
            CIMValue value = property.getValue();
            if ((value.getType() == CIMTYPE_BOOLEAN) && (!value.isNull()))
                value.get(v);
            or
             Set the value from property into v if the value is
             of Boolean type and !isNull(). If type incorrect, generates
             an exception.  If CIMValue is null, leaves v false. Else
             sets Boolean value from property into v.
            Boolean v = false;
            property.getValue().get(v);


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Boolean into which the value is stored if CIMValue state is not null.

void get(Uint8& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Uint8 into which the value is stored if CIMValue state is not null.

void get(Sint8& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Sint8 into which the value is stored if CIMValue state is not null.

void get(Uint16& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Uint16 into which the value is stored if CIMValue state is not null.

void get(Sint16& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Sint16 into which the value is stored if CIMValue state is not null.

void get(Uint32& x) const

            Uint32 v;
            CIMValue value = property.getValue();
            if ((value.getType() == CIMTYPE_SINT32) && (!value.isNull()))
                value.get(v);


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Uint32 into which the value is stored if CIMValue state is not null.

void get(Sint32& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Sint32 into which the value is stored if CIMValue state is not null.

void get(Uint64& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Uint64 into which the value is stored if CIMValue state is not null.

void get(Sint64& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Sint64 into which the value is stored if CIMValue state is not null.

void get(Real32& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Real32 into which the value is stored if CIMValue state is not null.

void get(Real64& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Real64 into which the value is stored if CIMValue state is not null.

void get(Char16& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Char16 into which the value is stored if CIMValue state is not null.

void get(String& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output String into which the value is stored if CIMValue state is not null.

void get(CIMDateTime& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output CIMDateTime into which the value is stored if CIMValue state is not null.

void get(CIMObjectPath& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output CIMObjectPath into which the value is stored if CIMValue state is not null.

void get(CIMObject& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output CIMObject into which the value is stored if CIMValue state is not null.

void get(CIMInstance& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output CIMInstance into which the value is stored if CIMValue state is not null.

void get(Array<Boolean>& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Boolean Array into which the value is stored if CIMValue state is not null.

void get(Array<Uint8>& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Uint8 Array into which the value is stored if CIMValue state is not null.

void get(Array<Sint8>& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Sint8 Array into which the value is stored if CIMValue state is not null.

void get(Array<Uint16>& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Uint16 Array into which the value is stored if CIMValue state is not null.

void get(Array<Sint16>& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Sint16 Array into which the value is stored if CIMValue state is not null.

void get(Array<Uint32>& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Uint32 Array into which the value is stored if CIMValue state is not null.

void get(Array<Sint32>& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Sint32 Array into which the value is stored if CIMValue state is not null.

void get(Array<Uint64>& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Uint64 Array into which the value is stored if CIMValue state is not null.

void get(Array<Sint64>& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Sint64 Array into which the value is stored if CIMValue state is not null.

void get(Array<Real32>& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Real32 Array into which the value is stored if CIMValue state is not null.

void get(Array<Real64>& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Real64 Array into which the value is stored if CIMValue state is not null.

void get(Array<Char16>& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output Char16 Array into which the value is stored if CIMValue state is not null.

void get(Array<String>& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output String Array into which the value is stored if CIMValue state is not null.

void get(Array<CIMDateTime>& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output CIMDateTime Array into which the value is stored if CIMValue state is not null.

void get(Array<CIMObjectPath>& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output CIMObjectPath Array into which the value is stored if CIMValue state is not null.

void get(Array<CIMObject>& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output CIMObject Array into which the value is stored if CIMValue state is not null.

void get(Array<CIMInstance>& x) const


Throws:: TypeMismatchException If the value type does not match the output parameter.
Parameters:: x - Output CIMInstance Array into which the value is stored if CIMValue state is not null.

Boolean equal(const CIMValue& x) const

Compares with another CIMValue object for equality.


Parameters:: x - The CIMValue with which to compare
Returns:: A Boolean indicating whether they are identical in type, array attributes, and value.

String toString() const

Converts a CIMValue to a String. This method should only be used for diagnostic output purposes. To get an actual String value, use get(String &).


Returns:: A String representation of the value.

CIMValue(char x)

Deprecated Interface
Constructs a CIMValue with the specified value and type Sint8. (Note: This constructor exists solely to support binary compatibility with a previous definition of the Sint8 type.)


Parameters:: x - The Sint8 value to assign

CIMValue(const Array<char>& x)

Deprecated Interface
Constructs a CIMValue with the specified value and type Sint8 Array. (Note: This constructor exists solely to support binary compatibility with a previous definition of the Sint8 type.)


Parameters:: x - The Sint8 Array value to assign

void set(char x)

Deprecated Interface
Sets the CIMValue to the specified value and type Sint8. (Note: This method exists solely to support binary compatibility with a previous definition of the Sint8 type.)


Parameters:: x - The value to assign

void set(const Array<char>& x)

Deprecated Interface
Sets the CIMValue to the specified value and type Sint8 Array. (Note: This method exists solely to support binary compatibility with a previous definition of the Sint8 type.)


Parameters:: x - The Array value to assign

void get(char& x) const

Deprecated Interface
Gets the Sint8 value of the CIMValue. The caller should first verify that the value is of the expected type and is not null. The output parameter x is not updated if the value is null (isNull() == true). (Note: This method exists solely to support binary compatibility with a previous definition of the Sint8 type.)


Parameters:: x - Output variable into which the value is stored.

void get(Array<char>& x) const

Deprecated Interface
Gets the Sint8 Array value of the CIMValue. The caller should first verify that the value is of the expected type and is not null. The output parameter x is not updated if the value is null (isNull() == true). (Note: This method exists solely to support binary compatibility with a previous definition of the Sint8 type.)


Parameters:: x - Output Array variable into which the value is stored.

This class has no child classes.


Friends:: class CIMMethodRep
class CIMParameterRep
class CIMPropertyRep
class CIMQualifierRep
class CIMQualifierDeclRep
class BinaryStreamer
class XmlWriter
class SCMOClass
class SCMOInstance

Alphabetic index HTML hierarchy of classes or Java

Pegasus CIM Object Broker Documentation

class PEGASUS_COMMON_LINKAGE CIMValue

Documentation

Inheritance:

Public Methods

[an error occurred while processing this directive]