pegasus/src/Pegasus/Common/CIMObject.h - diff

Return to CIMObject.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/CIMObject.h between version 1.44.18.1 and 1.44.18.2

version 1.44.18.1, 2006/02/10 16:09:34

version 1.44.18.2, 2006/03/07 18:45:46

Line 61

////////////////////////////////////////////////////////////////////////////////

/** The CIMObject class is the superclass for the CIMInstance and

/**

CIMClass classes.

The CIMObject class represents the DMTF standard CIM object definition,

which may represent a CIMClass or a CIMInstance.

The CIMObjectRep data member points to either a CIMInstanceRep or

<p>The CIMObject class uses a shared representation model, such that

CIMClassRep.

multiple CIMObject 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 CIMObject object affects all the CIMObject

objects that refer to the same data copy. The data remains valid until

all the CIMObject objects that refer to it are destructed. A separate

copy of the data may be created using the clone method.

class PEGASUS_COMMON_LINKAGE CIMObject

{

public:

/** Creates CIMObject instance with null values (default constructor).

/**

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

CIMObject();

/** Creates a new CIMObject instance (copy constructor).

/**

@param x Specifies the name of the CIMObject instance to create.

Constructs a CIMObject object from the value of a specified

CIMObject object, so that both objects refer to the same data copy.

@param x The CIMObject object from which to construct a new

CIMObject object.

CIMObject(const CIMObject& x);

/** Construction of a CIMObject instance based on the CIMClass object.

/**

Constructs a CIMObject object from the value of a specified

CIMClass object, so that both objects refer to the same data copy.

@param x The CIMClass object from which to construct the

CIMObject object.

CIMObject(const CIMClass& x);

/** Construction of a CIMObject instance based on the CIMInstance object.

/**

Constructs a CIMObject object from the value of a specified

CIMInstance object, so that both objects refer to the same data copy.

@param x The CIMInstance object from which to construct the

CIMObject object.

CIMObject(const CIMInstance& x);

/** Assign the values of the CIMObject instance to CIMObject.

/**

@param x Specifies the name of the CIMObject instance.

Assigns the value of the specified CIMObject object to this object,

so that both objects refer to the same data copy.

@param x The CIMObject object from which to assign this CIMObject

object.

@return A reference to this CIMObject object.

CIMObject& operator=(const CIMObject& x);

/** Destroys CIMObject.

/**

Destructs the CIMObject object.

~CIMObject();

/** Gets the ClassName of the object.

/**

@return ClassName of the object in a CIMName parameter. For example,

Gets the class name of the object.

<pre>

@return A CIMName containing the class name.

CIMName className;

@exception UninitializedObjectException If the object is not

CIMClass myclass("myclass", "superclass");

initialized.

className = myclass.getClassName;

</pre>

const CIMName& getClassName() const;

/** REVIEWERS: Insert description here.

/**

Gets the object path for the object.

@return A CIMObjectPath containing the object path.

@exception UninitializedObjectException If the object is not

initialized.

const CIMObjectPath& getPath() const;

/** Sets the object path for the object.

/**

@param path Specifies the CIMObjectPath that contains the object path.

Sets the object path for the object.

@param path A CIMObjectPath containing the object path.

@exception UninitializedObjectException If the object is not

initialized.

void setPath (const CIMObjectPath & path);

/** Adds the CIMQualifier object to the instance.

/**

@param qualifier CIMQualifier object to add to instance.

Adds a qualifier to the object.

@return The resulting CIMObject.

@param qualifier The CIMQualifier to be added.

@exception AlreadyExistsException True if the CIMQualifier already

@return A reference to this CIMObject object.

exists in the instance; otherwise, false.

@exception AlreadyExistsException If a qualifier with the

same name already exists in the CIMObject.

@exception UninitializedObjectException If the object is not

initialized.

CIMObject& addQualifier(const CIMQualifier& qualifier);

/** Searches the instance for the qualifier object

/**

defined by the input parameter.

Finds a qualifier by name.

@param name CIMName that defines the qualifier object to be found.

@param name A CIMName specifying the name of the qualifier to be found.

@return Position of the qualifier to use in subsequent

@return Index of the qualifier if found or PEG_NOT_FOUND if not found.

operations or PEG_NOT_FOUND if the qualifier is not found.

@exception UninitializedObjectException If the object is not

initialized.

Uint32 findQualifier(const CIMName& name) const;

/** Retrieves the qualifier object defined by the input parameter.

/**

@param index Specifies the index for the qualifier object. The index to

Gets the qualifier at the specified index.

qualifier objects is zero-origin and continuous so that

@param index The index of the qualifier to be retrieved.

incrementing loops can be used to get all qualifier

@return The CIMQualifier at the specified index.

objects in a CIMInstance.

@exception IndexOutOfBoundsException If the index is outside

@return CIMQualifier object defined by the index.

the range of qualifiers available for the CIMObject.

@exception IndexOutOfBoundsException True if the index

@exception UninitializedObjectException If the object is not

is out of bounds; otherwise, false.

initialized.

CIMQualifier getQualifier(Uint32 index);

/** Retrieves the qualifier object defined by the input parameter.

/**

@param index Specifies the index for the qualifier object. The index to

Gets the qualifier at the specified index.

qualifier objects is zero-origin and continuous so that

@param index The index of the qualifier to be retrieved.

incrementing loops can be used to get all qualifier

@return The CIMConstQualifier at the specified index.

objects in a CIMInstance.

@exception IndexOutOfBoundsException If the index is outside

@return CIMConstQualifier object defined by the index.

the range of qualifiers available for the CIMObject.

@exception IndexOutOfBoundsException True if the index

@exception UninitializedObjectException If the object is not

is out of bounds; otherwise, false.

initialized.

CIMConstQualifier getQualifier(Uint32 index) const;

/** REVIEWERS: Insert description here.

/**

Removes a qualifier from the object.

@param index The index of the qualifier to remove.

@exception IndexOutOfBoundsException If the index is

outside the range of qualifiers available for the CIMObject.

@exception UninitializedObjectException If the object is not

initialized.

void removeQualifier(Uint32 index);

/** Gets the number of CIMQualifier objects defined for

/**

this CIMObject.

Gets the number of qualifiers in the object.

@return Count of the number of CIMQualifier objects in the

@return An integer count of the qualifiers in the CIMObject.

CIMObject.

@exception UninitializedObjectException If the object is not

initialized.

Uint32 getQualifierCount() const;

/** Adds a property object defined by the input parameter to

/**

the CIMObject.

Adds a property to the object.

@param x Property Object to be added. See the CIM Property

@param x The CIMProperty to be added.

class for definition of the property object.

@return A reference to this CIMObject object.

@return The resulting CIMObject.

@exception AlreadyExistsException If a property with the

@exception AlreadyExistsException True if the property already exists

same name already exists in the CIMObject.

otherwise, false.

@exception UninitializedObjectException If the object is not

initialized.

CIMObject& addProperty(const CIMProperty& x);

/** Searches the CIMProperty objects in the

/**

CIMObject for a property object with the name defined by the

Finds a property by name.

input parameter.

@param name A CIMName specifying the name of the property to be found.

@param name CIMName with the name of the property object to be found.

@return Index of the property if found or PEG_NOT_FOUND if not found.

@return Position in the CIM object of the property object if found or

@exception UninitializedObjectException If the object is not

PEG_NOT_FOUND if no property object found with the name defined by the

initialized.

input parameter.

Uint32 findProperty(const CIMName& name) const;

/** Gets the CIMProperty object in the CIMObject defined

/**

by the input parameter.

Gets the property at the specified index.

@param index Specifies the index to the property object in the CIMObject.

@param index The index of the property to be retrieved.

The index to qualifier objects is zero-origin and continuous

@return The CIMProperty at the specified index.

so that incrementing loops can be used to get all qualifier

@exception IndexOutOfBoundsException If the index is outside

objects in a CIMObject.

the range of properties available for the CIMObject.

@return CIMProperty object corresponding to the index.

@exception UninitializedObjectException If the object is not

@exception IndexOutOfBoundsException True if the index

initialized.

is out of bounds; otherwise, false.

CIMProperty getProperty(Uint32 index);

/** Gets the CIMproperty object in the CIMObject defined

/**

by the input parameter.

Gets the property at the specified index.

@param index Specifies the index to the property object in the CIMObject.

@param index The index of the property to be retrieved.

@return CIMProperty object corresponding to the index.

@return The CIMConstProperty at the specified index.

@exception IndexOutOfBoundsException True if the index is outside the

@exception IndexOutOfBoundsException If the index is outside

range of properties in this object; otherwise, false.

the range of properties available for the CIMObject.

@exception UninitializedObjectException If the object is not

initialized.

CIMConstProperty getProperty(Uint32 index) const;

/** Remove the specified property from the instance.

/**

@param index Specifies the index to the property to be removed from the

Removes a property from the object.

instance. Normally this is obtained by findProperty();

@param index The index of the property to remove.

@exception IndexOutOfBoundsException True if the index is outside the

@exception IndexOutOfBoundsException If the index is

range of properties in this object; otherwise, false.

outside the range of properties available for the CIMObject.

@exception UninitializedObjectException If the object is not

initialized.

void removeProperty(Uint32 index);

/** Gets the number of CIMProperty objects defined for this CIMObject.

/**

@return Count of the number of CIMProperty objects in the

Gets the number of properties in the object.

CIMObject. Zero indicates that no CIMProperty objects

@return An integer count of the properties in the CIMObject.

are contained in the CIMObject.

@exception UninitializedObjectException If the object is not

initialized.

Uint32 getPropertyCount() const;

/** Makes a deep copy (clone) of the given object.

/**

@return Copy of the CIMObject.

Makes a deep copy of the object. This creates a new copy of all

the object attributes including qualifiers and properties.

@return A new copy of the CIMObject object.

@exception UninitializedObjectException If the object is not

initialized.

CIMObject clone() const;

/** Compares with another CIM Object.

/**

@param x CIM object for comparison.

Compares the CIMObject with a specified CIMConstObject.

@return True if the objects are identical; otherwise, false.

@param x The CIMConstObject to be compared.

@return True if this object is identical to the one specified,

false otherwise.

@exception UninitializedObjectException If the object is not

initialized.

Boolean identical(const CIMConstObject& x) const;

/** Determines if the object has not been initialized.

/**

@return True if the object has not been initialized; otherwise, false.

Determines whether the object has been initialized.

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

Boolean isUninitialized() const;

/** Returns a string representing the value of the CIMObject.

/**

With the inclusion of CIMObject as a CIMValue, the intent

Generates a human-readable String representing the value of the

of the toString() method is to produce a "human-readable" string

CIMObject. The String may be in MOF format, but the format is not

consistent with other CIMValue types. The string will be a MOF

guaranteed and may change without notice.

representation of the object (ie. either CIMClass or CIMInstance)

@return A human-readable String representing the CIMObject value.

using the _rep's toMof() method.

@exception UninitializedObjectException If the object is not

@return String representing the CIMObject value.

initialized.

String toString () const;

/** Determines if the object represents a CIMClass.

/**

@return True if the object represents a CIMClass; otherwise, false.

Indicates whether the object represents a CIMClass.

@return True if the object represents a CIMClass; false otherwise.

Boolean isClass () const;

/** Determines if the object represents a CIMInstance.

/**

@return True if the object represents a CIMInstance; otherwise, false.

Indicates whether the object represents a CIMInstance.

@return True if the object represents a CIMInstance; false otherwise.

Boolean isInstance () const;

Line 277

Line 334

# include <Pegasus/Common/ArrayInter.h>

#undef PEGASUS_ARRAY_T

////////////////////////////////////////////////////////////////////////////////

// CIMConstObject

Line 284

Line 342

////////////////////////////////////////////////////////////////////////////////

/**

REVIEWERS: Add class defintion here

The CIMConstObject class provides a const interface to a CIMObject

object. This class is needed because the shared representation model

used by CIMObject does not prevent modification to a const CIMObject

object. Note that the value of a CIMConstObject object could still be

modified by a CIMObject object that refers to the same data copy.

class PEGASUS_COMMON_LINKAGE CIMConstObject

{

public:

/** Constructs a new CIMConstObject with null values (default constructor).

/**

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

CIMConstObject();

/** Constructs a new CIMConstObject.

/**

@param x Specifies the name of the CIMConstObject instance to create.

Constructs a CIMConstObject object from the value of a specified

CIMConstObject object, so that both objects refer to the same data

copy.

@param x The CIMConstObject object from which to construct a new

CIMConstObject object.

CIMConstObject(const CIMConstObject& x);

/** Constructs a new CIMConstObject from a CIMObject instance.

/**

@param x Specifies the name of the CIMObject instance to use to create

Constructs a CIMConstObject object from the value of a specified

the CIMConstObject instance.

CIMObject object, so that both objects refer to the same data copy.

@param x The CIMObject object from which to construct a new

CIMConstObject object.

CIMConstObject(const CIMObject& x);

/** Constructs a CIMObject instance from a CIMClass instance.

/**

@param x Specifies the name of the CIMClass instance.

Constructs a CIMConstObject object from the value of a specified

CIMClass object, so that both objects refer to the same data copy.

@param x The CIMClass object from which to construct the

CIMConstObject object.

CIMConstObject(const CIMClass& x);

/** Constructs a CIMObject instance from a CIMInstance instance.

/**

@param x Specifies the name of the CIMInstance instance.

Constructs a CIMConstObject object from the value of a specified

CIMInstance object, so that both objects refer to the same data copy.

@param x The CIMInstance object from which to construct the

CIMConstObject object.

CIMConstObject(const CIMInstance& x);

/** Constructs a CIMObject instance from a CIMConstClass instance.

/**

@param x Specifies the name of the CIMConstClass instance.

Constructs a CIMConstObject object from the value of a specified

CIMConstClass object, so that both objects refer to the same data copy.

@param x The CIMConstClass object from which to construct the

CIMConstObject object.

CIMConstObject(const CIMConstClass& x);

/** Constructs a CIMObject instance from a CIMConstInstance instance.

/**

@param x Specifies the name of the CIMConstInstance instance.

Constructs a CIMConstObject object from the value of a specified

CIMConstInstance object, so that both objects refer to the same data

copy.

@param x The CIMConstInstance object from which to construct the

CIMConstObject object.

CIMConstObject(const CIMConstInstance& x);

/** REVIEWERS: Insert description here.

/**

@param x Specifies the name of the CIMConstObject instance.

Assigns the value of the specified CIMConstObject object to this

object, so that both objects refer to the same data copy.

@param x The CIMConstObject object from which to assign this

CIMConstObject object.

@return A reference to this CIMConstObject object.

CIMConstObject& operator=(const CIMConstObject& x);

/** CIMConstObject destructor.

/**

Destructs the CIMConstObject object.

~CIMConstObject();

/** REVIEWERS: Insert description here.

/**

Gets the class name of the object.

@return A CIMName containing the class name.

@exception UninitializedObjectException If the object is not

initialized.

const CIMName& getClassName() const;

/** REVIEWERS: Insert description here.

/**

Gets the object path for the object.

@return A CIMObjectPath containing the object path.

@exception UninitializedObjectException If the object is not

initialized.

const CIMObjectPath& getPath() const;

/** REVIEWERS: Insert description here.

/**

@param name Specifies the name of the CIMName instance.

Finds a qualifier by name.

@param name A CIMName specifying the name of the qualifier to be found.

@return Index of the qualifier if found or PEG_NOT_FOUND if not found.

@exception UninitializedObjectException If the object is not

initialized.

Uint32 findQualifier(const CIMName& name) const;

/** REVIEWERS: Insert description here.

/**

@param index Specifies the name of the Uint32 instance.

Gets the qualifier at the specified index.

@param index The index of the qualifier to be retrieved.

@return The CIMConstQualifier at the specified index.

@exception IndexOutOfBoundsException If the index is outside

the range of qualifiers available for the CIMConstObject.

@exception UninitializedObjectException If the object is not

initialized.

CIMConstQualifier getQualifier(Uint32 index) const;

/** REVIEWERS: Insert description here.

/**

Gets the number of qualifiers in the object.

@return An integer count of the qualifiers in the CIMConstObject.

@exception UninitializedObjectException If the object is not

initialized.

Uint32 getQualifierCount() const;

/** REVIEWERS: Insert description here.

/**

@param name Specifies the name of the CIMName instance.

Finds a property by name.

@param name A CIMName specifying the name of the property to be found.

@return Index of the property if found or PEG_NOT_FOUND if not found.

@exception UninitializedObjectException If the object is not

initialized.

Uint32 findProperty(const CIMName& name) const;

/** REVIEWERS: Insert description here.

/**

@param index Specifies the name of the Uint32 instance.

Gets the property at the specified index.

@param index The index of the property to be retrieved.

@return The CIMConstProperty at the specified index.

@exception IndexOutOfBoundsException If the index is outside

the range of properties available for the CIMConstObject.

@exception UninitializedObjectException If the object is not

initialized.

CIMConstProperty getProperty(Uint32 index) const;

/** REVIEWERS: Insert description here.

/**

Gets the number of properties in the object.

@return An integer count of the properties in the CIMConstObject.

@exception UninitializedObjectException If the object is not

initialized.

Uint32 getPropertyCount() const;

/** REVIEWERS: Insert description here.

/**

Makes a deep copy of the object. This creates a new copy of all

the object attributes including qualifiers and properties.

@return A CIMObject object with a separate copy of the

CIMConstObject object.

@exception UninitializedObjectException If the object is not

initialized.

CIMObject clone() const;

/** REVIEWERS: Insert description here.

/**

Compares the CIMConstObject with a specified CIMConstObject.

@param x The CIMConstObject to be compared.

@return True if this object is identical to the one specified,

false otherwise.

@exception UninitializedObjectException If the object is not

initialized.

Boolean identical(const CIMConstObject& x) const;

/** REVIEWERS: Insert description here.

/**

Determines whether the object has been initialized.

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

Boolean isUninitialized() const;

/** Returns a string representing the value of the CIMObject.

/**

With the inclusion of CIMObject as a CIMValue, the intent

Generates a human-readable String representing the value of the

of the toString() method is to produce a "human-readable" string

CIMObject. The String may be in MOF format, but the format is not

consistent with other CIMValue types. The string will be a MOF

guaranteed and may change without notice.

representation of the object (ie. either CIMClass or CIMInstance)

@return A human-readable String representing the CIMObject value.

using the _rep's toMof() method.

@exception UninitializedObjectException If the object is not

@return String representing the CIMObject value.

initialized.

String toString () const;

/** REVIEWERS: Insert description here.

/**

Indicates whether the object represents a CIMConstClass.

@return True if the object represents a CIMConstClass; false otherwise.

Boolean isClass() const;

/** REVIEWERS: Insert description here.

/**

Indicates whether the object represents a CIMConstInstance.

@return True if the object represents a CIMConstInstance; false

otherwise.

Boolean isInstance() const;

Legend:

Removed from v.1.44.18.1
changed lines
	Added in v.1.44.18.2

No CVS admin address has been configured