CIMQualifierDecl Class Reference

#include <CIMQualifierDecl.h>

List of all members.

Public Member Functions

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

Detailed Description

A CIMQualifierDecl represents a DMTF standard CIM qualifier declaration. A CIMQualifierDecl differs from a CIMQualifier in that it has a scope attribute. A CIMQualifierDecl defines a qualifier, whereas a CIMQualifier applies the qualifier.

The CIMQualifierDecl class uses a shared representation model, such that multiple CIMQualifierDecl 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 CIMQualifierDecl object affects all the CIMQualifierDecl objects that refer to the same data copy. The data remains valid until all the CIMQualifierDecl objects that refer to it are destructed. A separate copy of the data may be created using the clone method.


Constructor & Destructor Documentation

CIMQualifierDecl::CIMQualifierDecl (  ) 

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

CIMQualifierDecl::CIMQualifierDecl ( const CIMQualifierDecl x  ) 

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

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

Constructs a CIMQualifierDecl object with the specified attributes.

Parameters:
name A CIMName specifying the name of the qualifier.
value A CIMValue specifying the default qualifier value, and implicitly defining the qualifier type and whether the qualifier is an Array qualifier.
scope A CIMScope indicating the qualifier scope.
flavor A CIMFlavor indicating the qualifier flavors.
arraySize A 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:
UninitializedObjectException If the qualifier name is null.
CIMQualifierDecl::~CIMQualifierDecl (  ) 

Destructs the CIMQualifierDecl object.


Member Function Documentation

CIMQualifierDecl CIMQualifierDecl::clone (  )  const

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

Returns:
A new copy of the CIMQualifierDecl object.
Exceptions:
UninitializedObjectException If the object is not initialized.
Uint32 CIMQualifierDecl::getArraySize (  )  const

Gets the array size for the qualifier.

Returns:
Uint32 array size.
Exceptions:
UninitializedObjectException If the object is not initialized.
const CIMFlavor& CIMQualifierDecl::getFlavor (  )  const

Gets the qualifier flavors.

Returns:
A CIMFlavor containing the qualifier flavor settings.
Exceptions:
UninitializedObjectException If the object is not initialized.
const CIMName& CIMQualifierDecl::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.
const CIMScope& CIMQualifierDecl::getScope (  )  const

Gets the qualifier scope.

Returns:
A CIMScope containing the qualifier scope.
Exceptions:
UninitializedObjectException If the object is not initialized.
CIMType CIMQualifierDecl::getType (  )  const

Gets the qualifier type.

Returns:
A CIMType containing the qualifier type.
Exceptions:
UninitializedObjectException If the object is not initialized.
const CIMValue& CIMQualifierDecl::getValue (  )  const

Gets the qualifier default value.

Returns:
A CIMValue containing the qualifier default value.
Exceptions:
UninitializedObjectException If the object is not initialized.
Boolean CIMQualifierDecl::identical ( const CIMConstQualifierDecl x  )  const

Compares the qualifier declaration with another qualifier declaration.

Parameters:
x The CIMConstQualifierDecl to be compared.
Returns:
True if this qualifier declaration is identical to the one specified, false otherwise.
Exceptions:
UninitializedObjectException If either of the objects is not initialized.
Boolean CIMQualifierDecl::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 CIMQualifierDecl::isUninitialized (  )  const

Determines whether the object has been initialized.

Returns:
True if the object has not been initialized, false otherwise.
CIMQualifierDecl& CIMQualifierDecl::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:
x The CIMQualifierDecl object from which to assign this CIMQualifierDecl object.
Returns:
A reference to this CIMQualifierDecl object.
void CIMQualifierDecl::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.
void CIMQualifierDecl::setValue ( const CIMValue value  ) 

Sets the qualifier default value.

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

The documentation for this class was generated from the following file:
  • /home/builduser/trunk/pkgs/tog-pegasus/BUILD/pegasus/src/Pegasus/Common/CIMQualifierDecl.h