[an error occurred while processing this directive]

Pegasus CIM Object Broker Documentation

[an error occurred while processing this directive]

Contents

Introduction
Objectives
Overview
Credits
Pegasus Architecture
Design Goals
The Broker
Pegasus Providers.
Extension Services
Pegasus Clients.
Functional Flow
Pegasus Components
Component Descriptions
Pegasus Directory Structure
Pegasus Utilization
Pegasus Availability
Pegasus Installation
Pegasus Operation
Pegasus CIM Clients
Pegasus Providers
Pegasus MOF Compiler
Programming Pegasus
CIM Objects in Pegasus
CIM Object Table
Class Definitions
Pegasus Interfaces
CIM Operations over HTTP
Pegasus Client Interfaces
Pegasus Provider Interfaces
Pegasus Service Extension Interfaces
Repository Interfaces
Writing Providers.
Glossary
Pegasus Code Examples
Client Examples
Client Coding Examples
Provider Coding Examples
Document References
Pegausus FAQ

In file ../../src/Pegasus/Common/CIMQualifier.h:

class PEGASUS_COMMON_LINKAGE CIMQualifier

A CIMQualifier represents a DMTF standard CIM qualifier.

Documentation

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.

Inheritance:

Public Methods

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(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( const CIMName& name, const CIMValue& value, const CIMFlavor & flavor = CIMFlavor (CIMFlavor::NONE), Boolean propagated = false)

Constructs a CIMQualifier object with the specified attributes.


Throws:: UninitializedObjectException If the qualifier name is null.
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.

~CIMQualifier()

Destructs the CIMQualifier object

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.

const CIMName& getName() const

Gets the name of the qualifier.


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

void setName(const CIMName& name)

Sets the qualifier name.


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

CIMType getType() const

Gets the qualifier type.


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

Boolean isArray() const

Checks whether the qualifier is an Array qualifier.


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

const CIMValue& getValue() const

Gets the qualifier value.


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

void setValue(const CIMValue& value)

Sets the qualifier value.


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

void setFlavor(const CIMFlavor & flavor)

Adds flavors to the qualifier.


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

void unsetFlavor(const CIMFlavor & flavor)

Removes flavors from the qualifier.


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

const CIMFlavor& getFlavor() const

Gets the qualifier flavors.


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

Uint32 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.)


Throws:: UninitializedObjectException If the object is not initialized.
Returns:: Non-zero if qualifier is propagated, otherwise zero.

void 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.


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

Boolean isUninitialized() const

Determines whether the object has been initialized.


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

Boolean identical(const CIMConstQualifier& x) const

Compares the qualifier with another qualifier.


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

CIMQualifier clone() const

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


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

This class has no child classes.


Friends:: class CIMConstQualifier
class CIMClassRep
class Resolver
class XmlWriter
class MofWriter
class BinaryStreamer
class CIMQualifierList

Alphabetic index HTML hierarchy of classes or Java

Pegasus CIM Object Broker Documentation

class PEGASUS_COMMON_LINKAGE CIMQualifier

Documentation

Inheritance:

Public Methods

[an error occurred while processing this directive]