cimproperty.h

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

    Boolean getPropagated() const;

    /** Sets the propagated attribute true or false.
        @param x Specifies a true or false value that represents
        the propagated state to be set.
    */
    void setPropagated(Boolean propagated);

    /** Adds a qualifier object to the property and
        increases the qualifier count.
        @param x CIMQualifier object to be added.
        @return The resulting CIMProperpty.
        @exception AlreadyExistsException True if the qualifier already 
        exists; otherwise, false..
    */
    CIMProperty& addQualifier(const CIMQualifier& x);

    /** Finds the qualifier object defined by the name parameter 
        if it is attached to this CIMProperty.
        @param name CIMName parameter that defines the name of Qualifier
        object.
        @return Position of the qualifier object or PEG_NOT_FOUND (-1),  
        if not found.
    */
    Uint32 findQualifier(const CIMName& name) const;

    /** Gets the Qualifier object specified by the input parameter.
        @param index Index parameter for the Qualifier object to be
        retrieved.
        @return CIMQualifier object at specified index.
        @exception IndexOutOfBoundsException If index is outside range
        of Qualifiers in this property object; otherwise, false.
    */
    CIMQualifier getQualifier(Uint32 index);

    /** Returns the qualifier at the specified index.
        @param index Specifies the index of the qualifier. The index is obtained from the
        findQualifier method.
        @return The qualifier object.
        @exception IndexOutOfBoundsException If index is outside the range
        of qualifiers that exist for the property; otherwise, false.
    */
    CIMConstQualifier getQualifier(Uint32 index) const;

    /** Removes the CIMQualifier defined by the 
        index input as a parameter.
        @param index Index of the qualifier requested.
        @exception IndexOutOfBoundsException If the index is outside the
        range of qualifiers in this property object; otherwise, false.
    */
    void removeQualifier(Uint32 index);
    
    /** Returns count of the number of qualifiers attached to 
        the CIMProperty object.
        @return Count of the number of CIMQualifier objects attached
        to the CIMProperty object.
    */
    Uint32 getQualifierCount() const;

    /** Compares the CIMProperty object with
        another CIMProperty object defined by the input parameter.
        @param x CIMPropery object for comparison.
        @return True if the objects are identical; otherwise, false.
    */
    Boolean identical(const CIMConstProperty& x) const;

    /** Makes a deep copy (clone) of the given object.
        @return Copy of the CIMProperty object.
    */
    CIMProperty clone() const;

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

private:

    CIMProperty(CIMPropertyRep* rep);

    /** This constructor allows the CIMClassRep friend class to cast
    away constness.
    @param x Specifies the name of the CIMConstProperty instance.
    */ 
    PEGASUS_EXPLICIT CIMProperty(const CIMConstProperty& x);

    void _checkRep() const;

    friend class CIMConstProperty;
    friend class CIMClassRep;
    friend class CIMInstanceRep;
    friend class Resolver;
    friend class XmlWriter;
    friend class MofWriter;
    friend class BinaryStreamer;

    CIMPropertyRep* _rep;
};

////////////////////////////////////////////////////////////////////////////////
//
// CIMConstProperty
//
////////////////////////////////////////////////////////////////////////////////

///
class PEGASUS_COMMON_LINKAGE CIMConstProperty
{
public:

    /** REVIEWERS: Insert text here.
    */
    CIMConstProperty();

    /** REVIEWERS: Insert text here.
    */
    CIMConstProperty(const CIMConstProperty& x);

    /** REVIEWERS: Insert text here.
    */
    CIMConstProperty(const CIMProperty& x);

    /** REVIEWERS: Insert text here.
    */
    CIMConstProperty(
        const CIMName& name,
        const CIMValue& value,
        Uint32 arraySize = 0,
        const CIMName& referenceClassName = CIMName(),
        const CIMName& classOrigin = CIMName(),
        Boolean propagated = false);

    /** REVIEWERS: Insert text here.
    */
    ~CIMConstProperty();

    /** REVIEWERS: Insert text here.
    */
    CIMConstProperty& operator=(const CIMConstProperty& x);

    /** REVIEWERS: Insert text here.
    */
    CIMConstProperty& operator=(const CIMProperty& x);

    /** REVIEWERS: Insert text here.
    */
    const CIMName& getName() const;

    /** REVIEWERS: Insert text here.
    */
    const CIMValue& getValue() const;

    /** REVIEWERS: Insert text here.
    */
    CIMType getType() const;

    /** REVIEWERS: Insert text here.
    */
    Boolean isArray() const;

    /** REVIEWERS: Insert text here.
    */
    Uint32 getArraySize() const;

    /** REVIEWERS: Insert text here.
    */
    const CIMName& getReferenceClassName() const;

    /** REVIEWERS: Insert text here.
    */
    const CIMName& getClassOrigin() const;

    /** REVIEWERS: Insert text here.
    */
    Boolean getPropagated() const;

    /** REVIEWERS: Insert text here.
    */
    Uint32 findQualifier(const CIMName& name) const;

    /** REVIEWERS: Insert text here.
    */
    CIMConstQualifier getQualifier(Uint32 index) const;

    /** REVIEWERS: Insert text here.
    */
    Uint32 getQualifierCount() const;

    /** REVIEWERS: Insert text here.
    */
    Boolean identical(const CIMConstProperty& x) const;

    /** REVIEWERS: Insert text here.
    */
    CIMProperty clone() const;

    ///
    Boolean isUninitialized() const;

private:

    void _checkRep() const;

    CIMPropertyRep* _rep;

    friend class CIMProperty;
    friend class CIMPropertyRep;
    friend class XmlWriter;
    friend class MofWriter;
};

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

PEGASUS_NAMESPACE_END

#endif /* Pegasus_Property_h */