Pegasus Developers Manual

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 (see CIMType for a list of valid CIM data types).

Documentation

The CIMValue class represents a value of any of the CIM data types (see CIMType for a list of valid CIM data types). This class encapsulates a union which holds the current value. The class also has a type field indicating the type of that value.

Inheritance:

Public Methods

CIMValue()

Constructor - Creates an NULL CIMValue object set to null and with type CIMType:none and !arraytype

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

Constructor - Creates a NULL CIMValue object with the type and array indicator set as specified.


Throws:: TypeMismatchException If the given type is not valid for a CIMValue object.

CIMValue(Boolean x)

Constructor

CIMValue(Uint8 x)

Constructor

CIMValue(Sint8 x)

Constructor

CIMValue(Uint16 x)

Constructor

CIMValue(Sint16 x)

Constructor

CIMValue(Uint32 x)

Constructor

CIMValue(Sint32 x)

Constructor

CIMValue(Uint64 x)

Constructor

CIMValue(Sint64 x)

Constructor

CIMValue(Real32 x)

Constructor

CIMValue(Real64 x)

Constructor

CIMValue(const Char16& x)

Constructor

CIMValue(const String& x)

Constructor

CIMValue(const CIMDateTime& x)

Constructor

CIMValue(const CIMObjectPath& x)

Constructor

CIMValue(const CIMObject& x)

Constructor. Note: Constructing a CIMValue with an uninitialized CIMObject is not defined and results in a thrown UninitializedObjectException. Note: The input CIMObject will be cloned before putting it into the value of the constructed CIMValue. This is because CIMObjects use a shared representation model, but we don't want CIMObjects inside a CIMValue to be altered by other external changes.

CIMValue(const Array<Boolean>& x)

Constructor

CIMValue(const Array<Uint8>& x)

Constructor

CIMValue(const Array<Sint8>& x)

Constructor

CIMValue(const Array<Uint16>& x)

Constructor

CIMValue(const Array<Sint16>& x)

Constructor

CIMValue(const Array<Uint32>& x)

Constructor

CIMValue(const Array<Sint32>& x)

Constructor

CIMValue(const Array<Uint64>& x)

Constructor

CIMValue(const Array<Sint64>& x)

Constructor

CIMValue(const Array<Real32>& x)

Constructor

CIMValue(const Array<Real64>& x)

Constructor

CIMValue(const Array<Char16>& x)

Constructor

CIMValue(const Array<String>& x)

Constructor

CIMValue(const Array<CIMDateTime>& x)

Constructor

CIMValue(const Array<CIMObjectPath>& x)

Constructor

CIMValue(const Array<CIMObject>& x)

Constructor. Note: Constructing a CIMValue with an uninitialized CIMObject anywhere in the input array is not defined and results in a thrown UninitializedObjectException. Note: Each CIMObject in the input Array will be cloned before putting the Array into the value of the constructed CIMValue. This is because CIMObjects use a shared representation model, but we don't want CIMObjects inside a CIMValue to be altered by other external changes.

CIMValue(const CIMValue& x)

Constructor. Note: If the input type is CIMObject, it/they will be cloned before putting it into the value of the constructed CIMValue. This is because CIMObjects use a shared representation model, but we don't want CIMObjects inside a CIMValue to be altered by other external changes.

~CIMValue()

Destructor

CIMValue& operator=(const CIMValue& x)

Operator = Note: If the right hand side type is CIMObject, it/they will be cloned before putting it into the value of the target CIMValue. This is because CIMObjects use a shared representation model, but we don't want CIMObjects inside a CIMValue to be altered by other external changes.

void assign(const CIMValue& x)

Assigns one CIMValue object to another CIMValue object.


Parameters:: x - - CIMValue object to be used for assignment. Note: If the input type is CIMObject, it/they will be cloned before putting it into the value of the target CIMValue. This is because CIMObjects use a shared representation model, but we don't want CIMObjects inside a CIMValue to be altered by other external changes.

void clear()

Clears the attributes and value of the CIMValue object

Boolean typeCompatible(const CIMValue& x) const

Compares the types of two CIMValues. This compares the type field and the array indicators.

Returns:

true if both are of the same type and both are either arrays or not, false otherwise.

CIMValue a(Boolean(true);
CIMValue b = a;
if b.typeCompatible(a)
...

Boolean isArray() const

Determines if the value is an array.


Returns:: true if the value is an array, false otherwise.

Boolean isNull() const

Determines whether the CIMvalue object is Null. Null is the specific condition where no value has yet been set. If a CIMValue object is Null, any get on that object will create an exception.


Returns:: true if the CIMValue object is Null, false otherwise.

Uint32 getArraySize() const

Gets the size of an Array CIMValue.


Returns:: The number of entries in the array.

CIMType getType() const

Gets the CIMType attribute for the CIMValue.


Returns:: the CIMType value.

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

Sets the CIMValue a NULL, but with valid CIMType and array characteristics.

Parameters:

type - - CIMType for this CIMValue.
- isArray - Boolean indicating whether this is an array CIMValue.
arraySize - - Optional parameter indicating the array size.

CIMValue value;             
value.setNullValue(CIMType::BOOLEAN, false);

void set(Boolean x)

Sets the type, Array attribute and puts the value provided into the value of the target CIMValue.

            CIMValue x;
            x.set(Uint16(9));


Throws:: UninitializedObjectException If the given type is CIMObject, and the input CIMObject parameter is uninitialized or at least one entry in the Array of CIMObjects is uninitialized. Note: If the input type is CIMObject, it/they will be cloned before putting it into the value of the target CIMValue. This is because CIMObjects use a shared representation model, but we don't want CIMObjects inside a CIMValue to be altered by other external changes.

void set(Uint8 x)

void set(Sint8 x)

void set(Uint16 x)

void set(Sint16 x)

void set(Uint32 x)

void set(Sint32 x)

void set(Uint64 x)

void set(Sint64 x)

void set(Real32 x)

void set(Real64 x)

void set(const Char16& x)

void set(const String& x)

void set(const CIMDateTime& x)

void set(const CIMObjectPath& x)

void set(const CIMObject& x)

void set(const Array<Boolean>& x)

void set(const Array<Uint8>& x)

void set(const Array<Sint8>& x)

void set(const Array<Uint16>& x)

void set(const Array<Sint16>& x)

void set(const Array<Uint32>& x)

void set(const Array<Sint32>& x)

void set(const Array<Uint64>& x)

void set(const Array<Sint64>& x)

void set(const Array<Real32>& x)

void set(const Array<Real64>& x)

void set(const Array<Char16>& x)

void set(const Array<String>& x)

void set(const Array<CIMDateTime>& x)

void set(const Array<CIMObjectPath>& x)

void set(const Array<CIMObject>& x)

void get(Boolean& x) const

Gets the value of a CIMValue. Note: Before using get, the caller should use getType () and isNull () to ensure that the value is not null, and is of the correct type.

The behavior of get is undefined when the value is null.

Throws:

TypeMismatchException If the CIMValue type is not compatible with the type of the output parameter.

Uint32 v;
CIMValue value(CIMValue::UINT32, UINT32(99));
value.get(v);

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

Parameters:

Variable - in which to return the value.

void get(Uint8& x) const

void get(Sint8& x) const

void get(Uint16& x) const

void get(Sint16& x) const

void get(Uint32& x) const

void get(Sint32& x) const

void get(Uint64& x) const

void get(Sint64& x) const

void get(Real32& x) const

void get(Real64& x) const

void get(Char16& x) const

void get(String& x) const

void get(CIMDateTime& x) const

void get(CIMObjectPath& x) const

void get(CIMObject& x) const

void get(Array<Boolean>& x) const

void get(Array<Uint8>& x) const

void get(Array<Sint8>& x) const

void get(Array<Uint16>& x) const

void get(Array<Sint16>& x) const

void get(Array<Uint32>& x) const

void get(Array<Sint32>& x) const

void get(Array<Uint64>& x) const

void get(Array<Sint64>& x) const

void get(Array<Real32>& x) const

void get(Array<Real64>& x) const

void get(Array<Char16>& x) const

void get(Array<String>& x) const

void get(Array<CIMDateTime>& x) const

void get(Array<CIMObjectPath>& x) const

void get(Array<CIMObject>& x) const

Boolean equal(const CIMValue& x) const

Compares with another CIMValue object for equality.


Parameters:: x - - CIMValue to compare with.
Returns:: true if they are identical in type, attribute and value, false otherwise.

String toString() const

Converts the CIMvalue to a string. Should only be used for output purposes. To get an actual String value, use get(String &).

Returns:

String output for CIMValue.

String test;
CIMValue value(Boolean(true));
test = value.toString();   puts "TRUE" into test

CIMValue(char x)

Deprecated Interface
Constructor. (Note: This constructor exists solely to support binary compatibility with a previous definition of the Sint8 type.)

CIMValue(const Array<char>& x)

Deprecated Interface
Constructor. (Note: This constructor exists solely to support binary compatibility with a previous definition of the Sint8 type.)

void set(char x)

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

void set(const Array<char>& x)

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

void get(char& x) const

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

void get(Array<char>& x) const

Deprecated Interface
Gets an Sint8 array value. (Note: This method exists solely to support binary compatibility with a previous definition of the Sint8 type.)

This class has no child classes.


Friends:: class CIMMethodRep
class CIMParameterRep
class CIMPropertyRep
class CIMQualifierRep
class CIMQualifierDeclRep
class BinaryStreamer

Alphabetic index HTML hierarchy of classes or Java

class PEGASUS_COMMON_LINKAGE CIMValue

Documentation

Inheritance:

Public Methods