CIMConstQualifierDecl Class Reference

#include <CIMQualifierDecl.h>

List of all members.

Public Member Functions

 CIMConstQualifierDecl ()
 CIMConstQualifierDecl (const CIMConstQualifierDecl &x)
 CIMConstQualifierDecl (const CIMQualifierDecl &x)
 CIMConstQualifierDecl (const CIMName &name, const CIMValue &value, const CIMScope &scope, const CIMFlavor &flavor=CIMFlavor(CIMFlavor::DEFAULTS), Uint32 arraySize=0)
 ~CIMConstQualifierDecl ()
CIMConstQualifierDecloperator= (const CIMConstQualifierDecl &x)
CIMConstQualifierDecloperator= (const CIMQualifierDecl &x)
const CIMNamegetName () const
CIMType getType () const
Boolean isArray () const
const CIMValuegetValue () const
const CIMScopegetScope () const
const CIMFlavorgetFlavor () const
Uint32 getArraySize () const
Boolean isUninitialized () const
Boolean identical (const CIMConstQualifierDecl &x) const
CIMQualifierDecl clone () const

Detailed Description

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


Constructor & Destructor Documentation

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

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

Parameters:
xThe CIMConstQualifierDecl object from which to construct a new CIMConstQualifierDecl object.

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

Parameters:
xThe CIMQualifierDecl object from which to construct a new CIMConstQualifierDecl object.
CIMConstQualifierDecl::CIMConstQualifierDecl ( const CIMName name,
const CIMValue value,
const CIMScope scope,
const CIMFlavor flavor = CIMFlavor(CIMFlavor::DEFAULTS),
Uint32  arraySize = 0 
)

Constructs a CIMConstQualifierDecl object with the specified attributes.

Parameters:
nameA CIMName specifying the name of the qualifier.
valueA CIMValue specifying the default qualifier value, and implicitly defining the qualifier type and whether the qualifier is an Array qualifier.
scopeA CIMScope indicating the qualifier scope.
flavorA CIMFlavor indicating the qualifier flavors.
arraySizeA Uint32 indicating the size of the Array, if the qualifier is an Array qualifier. The default value of zero indicates a variable size array.
Exceptions:
UninitializedObjectExceptionIf the qualifier name is null.

Member Function Documentation

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

Returns:
A CIMQualifierDecl object with a separate copy of the CIMConstQualifierDecl object.
Exceptions:
UninitializedObjectExceptionIf the object is not initialized.

Gets the array size for the qualifier.

Returns:
Uint32 array size.
Exceptions:
UninitializedObjectExceptionIf the object is not initialized.

Gets the qualifier flavors.

Returns:
A CIMFlavor containing the qualifier flavor settings.
Exceptions:
UninitializedObjectExceptionIf the object is not initialized.

Gets the name of the qualifier.

Returns:
A CIMName containing the name of the qualifier.
Exceptions:
UninitializedObjectExceptionIf the object is not initialized.

Gets the qualifier scope.

Returns:
A CIMScope containing the qualifier scope.
Exceptions:
UninitializedObjectExceptionIf the object is not initialized.
CIMType CIMConstQualifierDecl::getType ( ) const

Gets the qualifier type.

Returns:
A CIMType containing the qualifier type.
Exceptions:
UninitializedObjectExceptionIf the object is not initialized.

Gets the qualifier default value.

Returns:
A CIMValue containing the qualifier default value.
Exceptions:
UninitializedObjectExceptionIf the object is not initialized.

Compares the qualifier declaration with another qualifier declaration.

Parameters:
xThe CIMConstQualifierDecl to be compared.
Returns:
True if this qualifier declaration is identical to the one specified, false otherwise.
Exceptions:
UninitializedObjectExceptionIf either of the objects is not initialized.
Boolean CIMConstQualifierDecl::isArray ( ) const

Checks whether the qualifier is an Array qualifier.

Returns:
True if the qualifier is an Array qualifier, false otherwise.
Exceptions:
UninitializedObjectExceptionIf the object is not initialized.

Determines whether the object has been initialized.

Returns:
True if the object has not been initialized, false otherwise.
CIMConstQualifierDecl& CIMConstQualifierDecl::operator= ( const CIMConstQualifierDecl x)

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

Parameters:
xThe CIMConstQualifierDecl object from which to assign this CIMConstQualifierDecl object.
Returns:
A reference to this CIMConstQualifierDecl object.
CIMConstQualifierDecl& CIMConstQualifierDecl::operator= ( const CIMQualifierDecl x)

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

Parameters:
xThe CIMQualifierDecl object from which to assign this CIMConstQualifierDecl object.
Returns:
A reference to this CIMConstQualifierDecl object.

The documentation for this class was generated from the following file: