CIMQualifier Class Reference

#include <CIMQualifier.h>

List of all members.

Public Member Functions

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


Detailed Description

A CIMQualifier represents a DMTF standard CIM qualifier. A CIMQualifier differs from a CIMQualifierDecl in that it has no scope attribute.

The CIMQualifier class uses a shared representation model, such that multiple CIMQualifier objects may refer to the same data copy. Assignment and copy operators create new references to the same data, not distinct copies. An update to a CIMQualifier object affects all the CIMQualifier objects that refer to the same data copy. The data remains valid until all the CIMQualifier objects that refer to it are destructed. A separate copy of the data may be created using the clone method.


Constructor & Destructor Documentation

CIMQualifier::CIMQualifier (  ) 

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

CIMQualifier::CIMQualifier ( const CIMQualifier x  ) 

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

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

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

Constructs a CIMQualifier object with the specified attributes.

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

CIMQualifier::~CIMQualifier (  ) 

Destructs the CIMQualifier object.


Member Function Documentation

CIMQualifier CIMQualifier::clone (  )  const

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

Returns:
A new copy of the CIMQualifier object.
Exceptions:
UninitializedObjectException If the object is not initialized.

const CIMFlavor& CIMQualifier::getFlavor (  )  const

Gets the qualifier flavors.

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

const CIMName& CIMQualifier::getName (  )  const

Gets the name of the qualifier.

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

Uint32 CIMQualifier::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:
UninitializedObjectException If the object is not initialized.

CIMType CIMQualifier::getType (  )  const

Gets the qualifier type.

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

const CIMValue& CIMQualifier::getValue (  )  const

Gets the qualifier value.

Returns:
A CIMValue containing the qualifier value.
Exceptions:
UninitializedObjectException If the object is not initialized.

Boolean CIMQualifier::identical ( const CIMConstQualifier x  )  const

Compares the qualifier with another qualifier.

Parameters:
x The CIMConstQualifier to be compared.
Returns:
True if this qualifier is identical to the one specified, false otherwise.
Exceptions:
UninitializedObjectException If either of the objects is not initialized.

Boolean CIMQualifier::isArray (  )  const

Checks whether the qualifier is an Array qualifier.

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

Boolean CIMQualifier::isUninitialized (  )  const

Determines whether the object has been initialized.

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

CIMQualifier& CIMQualifier::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:
x The CIMQualifier object from which to assign this CIMQualifier object.
Returns:
A reference to this CIMQualifier object.

void CIMQualifier::setFlavor ( const CIMFlavor flavor  ) 

Adds flavors to the qualifier.

Parameters:
flavor A CIMFlavor indicating the flavors to add.
Exceptions:
UninitializedObjectException If the object is not initialized.

void CIMQualifier::setName ( const CIMName name  ) 

Sets the qualifier name.

Parameters:
name A CIMName containing the new name of the qualifier.
Exceptions:
UninitializedObjectException If the object is not initialized.
Exception If the object is already contained by CIMClass, CIMInstance, CIMObject, CIMProperty, CIMParameter or CIMMethod

void CIMQualifier::setPropagated ( Boolean  propagated  ) 

Sets the propagated attribute. Normally this is used by a CIM Server when defining a qualifier in the context of a schema.

Parameters:
propagated A Boolean indicating whether the qualifier is propagated.
Exceptions:
UninitializedObjectException If the object is not initialized.

void CIMQualifier::setValue ( const CIMValue value  ) 

Sets the qualifier value.

Parameters:
value A CIMValue containing the new value of the qualifier.
Exceptions:
UninitializedObjectException If the object is not initialized.

void CIMQualifier::unsetFlavor ( const CIMFlavor flavor  ) 

Removes flavors from the qualifier.

Parameters:
flavor A CIMFlavor indicating the flavors to remove.
Exceptions:
UninitializedObjectException If the object is not initialized.


The documentation for this class was generated from the following file:
  • /scratch/rpmbuild.22230.L22270/pegasus/src/Pegasus/Common/CIMQualifier.h