cimobject.h

Pegasus is an open-source implementationof the DMTF CIM and WBEM standards. It is designed to be por

            false otherwise.
        @exception UninitializedObjectException If the object is not
            initialized.
    */
    Boolean identical(const CIMConstObject& x) const;

    /**
        Determines whether the object has been initialized.
        @return True if the object has not been initialized, false otherwise.
    */
    Boolean isUninitialized() const;

    /**
        Generates a human-readable String representing the value of the
        CIMObject.  The String may be in MOF format, but the format is not
        guaranteed and may change without notice.
        @return A human-readable String representing the CIMObject value.
        @exception UninitializedObjectException If the object is not
            initialized.
    */
    String toString() const;

    /**
        Indicates whether the object represents a CIMClass.
        @return True if the object represents a CIMClass; false otherwise.
    */
    Boolean isClass() const;

    /**
        Indicates whether the object represents a CIMInstance.
        @return True if the object represents a CIMInstance; false otherwise.
    */
    Boolean isInstance() const;

private:

    CIMObjectRep* _rep;

    CIMObject(CIMObjectRep* rep);

    void _checkRep() const;

    friend class CIMConstObject;
    friend class CIMClass;
    friend class CIMConstClass;
    friend class CIMInstance;
    friend class CIMConstInstance;
};

#define PEGASUS_ARRAY_T CIMObject
# include <Pegasus/Common/ArrayInter.h>
#undef PEGASUS_ARRAY_T


////////////////////////////////////////////////////////////////////////////////
//
// CIMConstObject
//
////////////////////////////////////////////////////////////////////////////////

/**
    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 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 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 CIMConstObject 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
            CIMConstObject object.
    */
    CIMConstObject(const CIMObject& x);

    /**
        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 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 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 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);

    /**
        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);

    /**
        Destructs the CIMConstObject object.
    */
    ~CIMConstObject();

    /**
        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;

    /**
        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;

    /**
        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;

    /**
        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;

    /**
        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;

    /**
        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;

    /**
        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;

    /**
        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;

    /**
        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;

    /**
        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;

    /**
        Determines whether the object has been initialized.
        @return True if the object has not been initialized, false otherwise.
    */
    Boolean isUninitialized() const;

    /**
        Generates a human-readable String representing the value of the
        CIMObject.  The String may be in MOF format, but the format is not
        guaranteed and may change without notice.
        @return A human-readable String representing the CIMObject value.
        @exception UninitializedObjectException If the object is not
            initialized.
    */
    String toString () const;

    /**
        Indicates whether the object represents a CIMConstClass.
        @return True if the object represents a CIMConstClass; false otherwise.
    */
    Boolean isClass() const;

    /**
        Indicates whether the object represents a CIMConstInstance.
        @return True if the object represents a CIMConstInstance; false
            otherwise.
    */
    Boolean isInstance() const;

private:

    CIMObjectRep* _rep;

    void _checkRep() const;

    friend class CIMObject;
    friend class CIMClass;
    friend class CIMConstClass;
    friend class CIMInstance;
    friend class CIMConstInstance;
};

PEGASUS_NAMESPACE_END

#endif /* Pegasus_Object_h */