version 1.40, 2006/01/30 16:16:47
|
version 1.41, 2006/02/17 19:30:37
|
|
|
class CIMClassRep; | class CIMClassRep; |
class CIMQualifierDeclRep; | class CIMQualifierDeclRep; |
| |
/** The CIMQualifierDecl class is used to represent CIM qualifier |
/** |
declarations in Pegasus. |
A CIMQualifierDecl represents a DMTF standard CIM qualifier declaration. |
Note that the Declarations |
A CIMQualifierDecl differs from a CIMQualifier in that it has a scope |
are not the same as CIM Qualiifers as seen on Classes, properties, etc. |
attribute. A CIMQualifierDecl defines a qualifier, whereas a CIMQualifier |
These are the original declarations of qualifiers (i.e. input from the compiler |
applies the qualifier. |
qualifier Declarations). |
|
|
<p>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. |
*/ | */ |
class PEGASUS_COMMON_LINKAGE CIMQualifierDecl | class PEGASUS_COMMON_LINKAGE CIMQualifierDecl |
{ | { |
public: | public: |
/// Constructor. |
|
|
/** |
|
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(); |
| |
/// Constructor - Creates a CIMQualifierDecl from another CIMQualifierDecl. |
/** |
|
Constructs a CIMQualifierDecl object from the value of a specified |
|
CIMQualifierDecl object, so that both objects refer to the same data |
|
copy. |
|
@param x The CIMQualifierDecl object from which to construct a new |
|
CIMQualifierDecl object. |
|
*/ |
CIMQualifierDecl(const CIMQualifierDecl& x); | CIMQualifierDecl(const CIMQualifierDecl& x); |
| |
/** Constructor - Constructs a single CIMQualifierDecl object. |
/** |
@param name - CIMName containing the name of the Qualifier being created. |
Constructs a CIMQualifierDecl object with the specified attributes. |
@param value - CIMValue for the qualifier. |
@param name A CIMName specifying the name of the qualifier. |
@param scope - CIMScope containing the scope of the qualifier. |
@param value A CIMValue specifying the default qualifier value, and |
@param flavor - Optional definition of the flavor for the qualifier. |
implicitly defining the qualifier type and whether the qualifier |
CIMFlavor::DEFAULTS is used if no value supplied. |
is an Array qualifier. |
@param arraySize - Optional integer defining the arraysize if the |
@param scope A CIMScope indicating the qualifier scope. |
qualifier is an array type with fixed value array. The default is |
@param flavor A CIMFlavor indicating the qualifier flavors. |
zero indicating that the qualifier declaration is not a fixed size |
@param arraySize A Uint32 indicating the size of the Array, if the |
array. |
qualifier is an Array qualifier. The default value of zero |
|
indicates a variable size array. |
|
@exception UninitializedObjectException If the qualifier name is null. |
*/ | */ |
CIMQualifierDecl( | CIMQualifierDecl( |
const CIMName& name, | const CIMName& name, |
|
|
const CIMFlavor & flavor = CIMFlavor (CIMFlavor::DEFAULTS), | const CIMFlavor & flavor = CIMFlavor (CIMFlavor::DEFAULTS), |
Uint32 arraySize = 0); | Uint32 arraySize = 0); |
| |
/// Destructor. |
/** |
|
Destructs the CIMQualifierDecl object. |
|
*/ |
~CIMQualifierDecl(); | ~CIMQualifierDecl(); |
| |
/// Operator. |
/** |
|
Assigns the value of the specified CIMQualifierDecl object to this |
|
object, so that both objects refer to the same data copy. |
|
@param x The CIMQualifierDecl object from which to assign this |
|
CIMQualifierDecl object. |
|
@return A reference to this CIMQualifierDecl object. |
|
*/ |
CIMQualifierDecl& operator=(const CIMQualifierDecl& x); | CIMQualifierDecl& operator=(const CIMQualifierDecl& x); |
| |
/** Get the name of the CIMQualifierDecl object. |
/** |
@return CIMName containing the name of the CIMQualifierDecl object. |
Gets the name of the qualifier. |
|
@return A CIMName containing the name of the qualifier. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
const CIMName& getName() const; | const CIMName& getName() const; |
| |
/** Sets the name in the CIMQualifierDecl object. |
/** |
@param name CIMName containing name to be set on this qualifier. |
Sets the qualifier name. |
|
@param name A CIMName containing the new name of the qualifier. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
void setName(const CIMName& name); | void setName(const CIMName& name); |
| |
/** Gets the Qualifier Declaration type which is the |
/** |
value type (boolean, etc. for this qualifier). |
Gets the qualifier type. |
@return the type as CIMType. |
@return A CIMType containing the qualifier type. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
CIMType getType() const; | CIMType getType() const; |
| |
/** Determines if this qualifier declaration is an array type. |
/** |
@return true if this is an array type, false otherwise. |
Checks whether the qualifier is an Array qualifier. |
|
@return True if the qualifier is an Array qualifier, false otherwise. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
*/ | */ |
Boolean isArray() const; | Boolean isArray() const; |
| |
/// |
/** |
|
Gets the qualifier default value. |
|
@return A CIMValue containing the qualifier default value. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
const CIMValue& getValue() const; | const CIMValue& getValue() const; |
| |
/// |
/** |
|
Sets the qualifier default value. |
|
@param name A CIMValue containing the new default value of the |
|
qualifier. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
void setValue(const CIMValue& value); | void setValue(const CIMValue& value); |
| |
/// |
/** |
|
Gets the qualifier scope. |
|
@return A CIMScope containing the qualifier scope. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
const CIMScope & getScope() const; | const CIMScope & getScope() const; |
| |
/** Gets the Flavor definition from the qualifier declaration. |
/** |
@return CIMFlavor object containing the flavor flags. The |
Gets the qualifier flavors. |
CIMFlavor hasFlavor method can be used to test against the flavor |
@return A CIMFlavor containing the qualifier flavor settings. |
constants defined in CIMFlavor. |
@exception UninitializedObjectException If the object is not |
@See CIMFlavor |
initialized. |
*/ | */ |
const CIMFlavor & getFlavor() const; | const CIMFlavor & getFlavor() const; |
| |
/// |
/** |
|
Gets the array size for the qualifier. |
|
@return Uint32 array size. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
Uint32 getArraySize() const; | Uint32 getArraySize() const; |
| |
/** Determines if the object has not been initialized. |
/** |
@return true if the object has not been initialized, |
Determines whether the object has been initialized. |
false otherwise. |
@return True if the object has not been initialized, false otherwise. |
*/ | */ |
Boolean isUninitialized() const; | Boolean isUninitialized() const; |
| |
/** Compares two qualifier declarations. |
/** |
@return true if they are identical, false otherwise. |
Compares the qualifier declaration with another qualifier declaration. |
|
@param x The CIMConstQualifierDecl to be compared. |
|
@return True if this qualifier declaration is identical to the one |
|
specified, false otherwise. |
|
@exception UninitializedObjectException If either of the objects |
|
is not initialized. |
*/ | */ |
Boolean identical(const CIMConstQualifierDecl& x) const; | Boolean identical(const CIMConstQualifierDecl& x) const; |
| |
/// |
/** |
|
Makes a deep copy of the qualifier declaration. This creates a new |
|
copy of all the qualifier declaration attributes. |
|
@return A new copy of the CIMQualifierDecl object. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
CIMQualifierDecl clone() const; | CIMQualifierDecl clone() const; |
| |
private: | private: |
|
|
// | // |
//////////////////////////////////////////////////////////////////////////////// | //////////////////////////////////////////////////////////////////////////////// |
| |
/// |
/** |
|
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. |
|
*/ |
class PEGASUS_COMMON_LINKAGE CIMConstQualifierDecl | class PEGASUS_COMMON_LINKAGE CIMConstQualifierDecl |
{ | { |
public: | public: |
/// |
|
|
/** |
|
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. |
|
*/ |
CIMConstQualifierDecl(); | CIMConstQualifierDecl(); |
| |
/// |
/** |
|
Constructs a CIMConstQualifierDecl object from the value of a |
|
specified CIMConstQualifierDecl object, so that both objects refer |
|
to the same data copy. |
|
@param x The CIMConstQualifierDecl object from which to construct a |
|
new CIMConstQualifierDecl object. |
|
*/ |
CIMConstQualifierDecl(const CIMConstQualifierDecl& x); | CIMConstQualifierDecl(const CIMConstQualifierDecl& x); |
| |
/// |
/** |
|
Constructs a CIMConstQualifierDecl object from the value of a |
|
specified CIMQualifierDecl object, so that both objects refer |
|
to the same data copy. |
|
@param x The CIMQualifierDecl object from which to construct a |
|
new CIMConstQualifierDecl object. |
|
*/ |
CIMConstQualifierDecl(const CIMQualifierDecl& x); | CIMConstQualifierDecl(const CIMQualifierDecl& x); |
| |
/** Constructor - Creates a CIMConstQualiferDecl. |
/** |
@param name - CIMName containing the name of the Qualifier declaration. |
Constructs a CIMConstQualifierDecl object with the specified |
@param value - CIMValue for the qualifier. |
attributes. |
@param scope - CIMScope containing the scope of the qualifier. |
@param name A CIMName specifying the name of the qualifier. |
@param flavor - Optional definition of the flavor for the qualifier. |
@param value A CIMValue specifying the default qualifier value, and |
CIMFlavor::DEFAULTS is used if no value supplied. |
implicitly defining the qualifier type and whether the qualifier |
@param arraySize - Optional integer defining the arraysize if the |
is an Array qualifier. |
qualifier is an array type with fixed value array. The default is |
@param scope A CIMScope indicating the qualifier scope. |
zero indicating that the qualifier declaration is not a fixed size |
@param flavor A CIMFlavor indicating the qualifier flavors. |
array. |
@param 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. |
|
@exception UninitializedObjectException If the qualifier name is null. |
*/ | */ |
CIMConstQualifierDecl( | CIMConstQualifierDecl( |
const CIMName& name, | const CIMName& name, |
|
|
const CIMFlavor & flavor = CIMFlavor (CIMFlavor::DEFAULTS), | const CIMFlavor & flavor = CIMFlavor (CIMFlavor::DEFAULTS), |
Uint32 arraySize = 0); | Uint32 arraySize = 0); |
| |
/// |
/** |
|
Destructs the CIMConstQualifierDecl object. |
|
*/ |
~CIMConstQualifierDecl(); | ~CIMConstQualifierDecl(); |
| |
/// |
/** |
|
Assigns the value of the specified CIMConstQualifierDecl object to |
|
this object, so that both objects refer to the same data copy. |
|
@param x The CIMConstQualifierDecl object from which to assign this |
|
CIMConstQualifierDecl object. |
|
@return A reference to this CIMConstQualifierDecl object. |
|
*/ |
CIMConstQualifierDecl& operator=(const CIMConstQualifierDecl& x); | CIMConstQualifierDecl& operator=(const CIMConstQualifierDecl& x); |
| |
/// |
/** |
|
Assigns the value of the specified CIMQualifierDecl object to |
|
this object, so that both objects refer to the same data copy. |
|
@param x The CIMQualifierDecl object from which to assign this |
|
CIMConstQualifierDecl object. |
|
@return A reference to this CIMConstQualifierDecl object. |
|
*/ |
CIMConstQualifierDecl& operator=(const CIMQualifierDecl& x); | CIMConstQualifierDecl& operator=(const CIMQualifierDecl& x); |
| |
/// |
/** |
|
Gets the name of the qualifier. |
|
@return A CIMName containing the name of the qualifier. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
const CIMName& getName() const; | const CIMName& getName() const; |
| |
/// |
/** |
|
Gets the qualifier type. |
|
@return A CIMType containing the qualifier type. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
CIMType getType() const; | CIMType getType() const; |
| |
/// |
/** |
|
Checks whether the qualifier is an Array qualifier. |
|
@return True if the qualifier is an Array qualifier, false otherwise. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
Boolean isArray() const; | Boolean isArray() const; |
| |
/// |
/** |
|
Gets the qualifier default value. |
|
@return A CIMValue containing the qualifier default value. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
const CIMValue& getValue() const; | const CIMValue& getValue() const; |
| |
/// |
/** |
|
Gets the qualifier scope. |
|
@return A CIMScope containing the qualifier scope. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
const CIMScope & getScope() const; | const CIMScope & getScope() const; |
| |
/// |
/** |
|
Gets the qualifier flavors. |
|
@return A CIMFlavor containing the qualifier flavor settings. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
const CIMFlavor & getFlavor() const; | const CIMFlavor & getFlavor() const; |
| |
/// |
/** |
|
Gets the array size for the qualifier. |
|
@return Uint32 array size. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
Uint32 getArraySize() const; | Uint32 getArraySize() const; |
| |
/// |
/** |
|
Determines whether the object has been initialized. |
|
@return True if the object has not been initialized, false otherwise. |
|
*/ |
Boolean isUninitialized() const; | Boolean isUninitialized() const; |
| |
/// |
/** |
|
Compares the qualifier declaration with another qualifier declaration. |
|
@param x The CIMConstQualifierDecl to be compared. |
|
@return True if this qualifier declaration is identical to the one |
|
specified, false otherwise. |
|
@exception UninitializedObjectException If either of the objects |
|
is not initialized. |
|
*/ |
Boolean identical(const CIMConstQualifierDecl& x) const; | Boolean identical(const CIMConstQualifierDecl& x) const; |
| |
/// |
/** |
|
Makes a deep copy of the qualifier declaration. This creates a new |
|
copy of all the qualifier declaration attributes. |
|
@return A CIMQualifierDecl object with a separate copy of the |
|
CIMConstQualifierDecl object. |
|
@exception UninitializedObjectException If the object is not |
|
initialized. |
|
*/ |
CIMQualifierDecl clone() const; | CIMQualifierDecl clone() const; |
| |
private: | private: |