CIMConstQualifier Class Reference

#include <CIMQualifier.h>

Public Member Functions

 CIMConstQualifier ()
 
 CIMConstQualifier (const CIMConstQualifier &x)
 
 CIMConstQualifier (const CIMQualifier &x)
 
 CIMConstQualifier (const CIMName &name, const CIMValue &value, const CIMFlavor &flavor=CIMFlavor(CIMFlavor::NONE), Boolean propagated=false)
 
 ~CIMConstQualifier ()
 
CIMConstQualifieroperator= (const CIMConstQualifier &x)
 
CIMConstQualifieroperator= (const CIMQualifier &x)
 
const CIMNamegetName () const
 
CIMType getType () const
 
Boolean isArray () const
 
const CIMValuegetValue () const
 
const CIMFlavorgetFlavor () const
 
Uint32 getPropagated () const
 
Boolean isUninitialized () const
 
Boolean identical (const CIMConstQualifier &x) const
 
CIMQualifier clone () const
 

Detailed Description

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

Constructor & Destructor Documentation

◆ CIMConstQualifier() [1/4]

CIMConstQualifier::CIMConstQualifier ( )

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

◆ CIMConstQualifier() [2/4]

CIMConstQualifier::CIMConstQualifier ( const CIMConstQualifier x)

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

Parameters
xThe CIMConstQualifier object from which to construct a new CIMConstQualifier object.

◆ CIMConstQualifier() [3/4]

CIMConstQualifier::CIMConstQualifier ( const CIMQualifier x)

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

Parameters
xThe CIMQualifier object from which to construct a new CIMConstQualifier object.

◆ CIMConstQualifier() [4/4]

CIMConstQualifier::CIMConstQualifier ( const CIMName name,
const CIMValue value,
const CIMFlavor flavor = CIMFlavor(CIMFlavor::NONE),
Boolean  propagated = false 
)

Constructs a CIMConstQualifier object with the specified attributes.

Parameters
nameA CIMName specifying the name of the qualifier.
valueA CIMValue specifying the qualifier value, and implicitly defining the qualifier type and whether the qualifier is an Array qualifier.
flavorA CIMFlavor indicating the qualifier flavors.
propagatedA Boolean indicating whether the qualifier is local to the context in which it appears or was propagated (without modification) from other schema.
Exceptions
UninitializedObjectExceptionIf the qualifier name is null.

◆ ~CIMConstQualifier()

CIMConstQualifier::~CIMConstQualifier ( )

Destructs the CIMQualifier object.

Member Function Documentation

◆ clone()

CIMQualifier CIMConstQualifier::clone ( ) const

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

Returns
A CIMQualifier object with a separate copy of the CIMConstQualifier object.
Exceptions
UninitializedObjectExceptionIf the object is not initialized.

◆ getFlavor()

const CIMFlavor& CIMConstQualifier::getFlavor ( ) const

Gets the qualifier flavors.

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

◆ getName()

const CIMName& CIMConstQualifier::getName ( ) const

Gets the name of the qualifier.

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

◆ getPropagated()

Uint32 CIMConstQualifier::getPropagated ( ) const

Tests the propagated attribute of the qualifier. The propagated attribute indicates whether this qualifier was propagated from a higher-level class. Normally this attribute is set as part of defining a qualifier in the context of a schema. It is set in qualifiers retrieved from a CIM Server. (Note: Although this method is intended to return a Boolean value, changing the return type would break interface compatibility.)

Returns
Non-zero if qualifier is propagated, otherwise zero.
Exceptions
UninitializedObjectExceptionIf the object is not initialized.

◆ getType()

CIMType CIMConstQualifier::getType ( ) const

Gets the qualifier type.

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

◆ getValue()

const CIMValue& CIMConstQualifier::getValue ( ) const

Gets the qualifier value.

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

◆ identical()

Boolean CIMConstQualifier::identical ( const CIMConstQualifier x) const

Compares the qualifier with another qualifier.

Parameters
xThe CIMConstQualifier to be compared.
Returns
True if this qualifier is identical to the one specified, false otherwise.
Exceptions
UninitializedObjectExceptionIf either of the objects is not initialized.

◆ isArray()

Boolean CIMConstQualifier::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.

◆ isUninitialized()

Boolean CIMConstQualifier::isUninitialized ( ) const

Determines whether the object has been initialized.

Returns
True if the object has not been initialized, false otherwise.

◆ operator=() [1/2]

CIMConstQualifier& CIMConstQualifier::operator= ( const CIMConstQualifier x)

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

Parameters
xThe CIMConstQualifier object from which to assign this CIMConstQualifier object.
Returns
A reference to this CIMConstQualifier object.

◆ operator=() [2/2]

CIMConstQualifier& CIMConstQualifier::operator= ( const CIMQualifier x)

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

Parameters
xThe CIMQualifier object from which to assign this CIMConstQualifier object.
Returns
A reference to this CIMConstQualifier object.

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