(file) Return to CIMObject.h CVS log (file) (dir) Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/CIMObject.h between version 1.37 and 1.38

version 1.37, 2002/09/11 22:50:10 version 1.38, 2003/03/12 21:02:53
Line 55 
Line 55 
 // //
 //////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
  
 /** This class either refers to a CIMInstance or a CIMClass.  /** The CIMObject class is the superclass for the CIMInstance and
       CIMClass classes.
  
     The CIMObjectRep data member points to either a CIMInstanceRep or     The CIMObjectRep data member points to either a CIMInstanceRep or
     CIMClassRep.     CIMClassRep.
Line 88 
Line 89 
     */     */
     ~CIMObject();     ~CIMObject();
  
     /** Accessor for ClassName component of the object.      /** Gets the ClassName of the object.
         @return - Returns the ClassName of the object in          @return ClassName of the object in a CIMName parameter.
         a CIMName parameter.  
         <pre>         <pre>
             CIMName className;             CIMName className;
             CIMClass myclass("myclass", "superclass");             CIMClass myclass("myclass", "superclass");
Line 99 
Line 99 
     */     */
     const CIMName& getClassName() const;     const CIMName& getClassName() const;
  
       ///
     const CIMObjectPath& getPath() const;     const CIMObjectPath& getPath() const;
  
     /**      /** Sets the object path for the object.
       Sets the object path for the object          @param  path -  CIMObjectPath containing the object path.
       @param  path  CIMObjectPath containing the object path  
      */      */
     void setPath (const CIMObjectPath & path);     void setPath (const CIMObjectPath & path);
  
     /** addQualifier - Adds the CIMQualifier object to the instance.      /** Adds the CIMQualifier object to the instance.
         Thows an exception of the CIMQualifier already exists in the instance          @param qualifier - CIMQualifier object to add to instance.
         @param CIMQualifier object to add to instance          @return the resulting CIMObject.
         @return the resulting object.          @exception AlreadyExistsException if the CIMQualifier already
         @exception AlreadyExistsException.          exists in the instance.
     */     */
     CIMObject& addQualifier(const CIMQualifier& qualifier);     CIMObject& addQualifier(const CIMQualifier& qualifier);
  
     /** findQualifier - Searches the instance for the qualifier object      /** Searches the instance for the qualifier object
         defined by the input parameter.         defined by the input parameter.
         @param CIMName defining the qualifier object to be found.          @param name - CIMName defining the qualifier object to be found.
         @return - Position of the qualifier to be used in subsequent          @return  Position of the qualifier to be used in subsequent
         operations or PEG_NOT_FOUND if the qualifier is not found.         operations or PEG_NOT_FOUND if the qualifier is not found.
     */     */
     Uint32 findQualifier(const CIMName& name) const;     Uint32 findQualifier(const CIMName& name) const;
  
     /** getQualifier - Retrieves the qualifier object defined by the      /** Retrieves the qualifier object defined by the input parameter.
         index input parameter.  @ index for the qualifier object.          @param  index - Index for the qualifier object. The index to
         The index to qualifier objects is zero-origin and continuous          qualifier objects is zero-origin and continuous so that
         so that incrementing loops can be used to get all qualifier          incrementing loops can be used to get all qualifier
         objects in a CIMInstnace.          objects in a CIMInstance.
         @return: Returns qualifier object defined by index.          @return CIMQualifier object defined by the index.
         @exception Throws the IndexOutOfBoundsException exception if the index          @exception IndexOutOfBoundsException exception if the index
         is out of bounds          is out of bounds.
     */     */
     CIMQualifier getQualifier(Uint32 index);     CIMQualifier getQualifier(Uint32 index);
  
     /** getQualifier - Retrieves the qualifier object defined by the      /** Retrieves the qualifier object defined by the input parameter.
         index input parameter.  @ index for the qualifier object.          @param index - Index for the qualifier object. The index to
         The index to qualifier objects is zero-origin and continuous          qualifier objects is zero-origin and continuous so that
         so that incrementing loops can be used to get all qualifier          incrementing loops can be used to get all qualifier
         objects in a CIMInstnace.          objects in a CIMInstance.
         @return: Returns qualifier object defined by index.          @return CIMConstQualifier object defined by the index.
         @exception Throws the IndexOutOfBoundsException exception if the index          @exception IndexOutOfBoundsException exception if the index
         is out of bounds          is out of bounds.
     */     */
     CIMConstQualifier getQualifier(Uint32 index) const;     CIMConstQualifier getQualifier(Uint32 index) const;
  
       ///
     void removeQualifier(Uint32 index);     void removeQualifier(Uint32 index);
  
     /** getQualifierCount - Gets the number of CIMQualifier objects      /** Gets the number of CIMQualifier objects defined for
         defined for this CIMObject.          this CIMObject.
         @return Count of the number of CIMQualifier objects in the         @return Count of the number of CIMQualifier objects in the
         CIMObject.         CIMObject.
         @exception Throws the IndexOutOfBoundsException exception if the index  
         is out of bounds  
     */     */
     Uint32 getQualifierCount() const;     Uint32 getQualifierCount() const;
  
     /** addProperty - Adds a property object defined by the input      /** Adds a property object defined by the input parameter to
         parameter to the CIMObject          the CIMObject.
         @param Property Object to be added.  See the CIM Property          @param x - Property Object to be added. See the CIM Property
         class for definition of the property object          class for definition of the property object.
         @return the resulting object.          @return the resulting CIMObject.
         @exception AlreadyExistsException if the property already exists.         @exception AlreadyExistsException if the property already exists.
     */     */
     CIMObject& addProperty(const CIMProperty& x);     CIMObject& addProperty(const CIMProperty& x);
  
     /** findProperty - Searches the CIMProperty objects installed in the      /** Searches the CIMProperty objects in the
         CIMObject for property objects with the name defined by the          CIMObject for a property object with the name defined by the
         input.          input parameter.
         @param CIMName with the name of the property object to be found          @param name - CIMName with the name of the property object to be found.
         @return Position in the CIM object to the property object if found or          @return Position in the CIM object of the property object if found or
         PEG_NOT_FOUND if no property object found with the name defined by the         PEG_NOT_FOUND if no property object found with the name defined by the
         input.          input parameter.
     */     */
     Uint32 findProperty(const CIMName& name) const;     Uint32 findProperty(const CIMName& name) const;
  
     /** getProperty - Gets the CIMProperty object in the CIMObject defined      /** Gets the CIMProperty object in the CIMObject defined
         by the input index parameter.          by the input parameter.
         @param Index to the property object in the CIMObject.          @param index - Index to the property object in the CIMObject.
         The index to qualifier objects is zero-origin and continuous         The index to qualifier objects is zero-origin and continuous
         so that incrementing loops can be used to get all qualifier         so that incrementing loops can be used to get all qualifier
         objects in a CIMObject.         objects in a CIMObject.
         @return CIMProperty object corresponding to the index.         @return CIMProperty object corresponding to the index.
         @exception Throws the IndexOutOfBoundsException exception if the index          @exception IndexOutOfBoundsException exception if the index
         is out of bounds          is out of bounds.
     */     */
     CIMProperty getProperty(Uint32 index);     CIMProperty getProperty(Uint32 index);
  
     /** getProperty - Gets the CIMproperty object in the CIMObject defined      /** Gets the CIMproperty object in the CIMObject defined
         by the input index parameter.          by the input parameter.
         @param Index to the property object in the CIMObject.          @param index - Index to the property object in the CIMObject.
         @return CIMProperty object corresponding to the index.         @return CIMProperty object corresponding to the index.
         @exception IndexOutOfBoundsException if the index is outside the         @exception IndexOutOfBoundsException if the index is outside the
         range of properties in this object.         range of properties in this object.
     */     */
     CIMConstProperty getProperty(Uint32 index) const;     CIMConstProperty getProperty(Uint32 index) const;
  
     /** removeProperty - Remove the specified property from the instance      /** Remove the specified property from the instance.
         @param index Index to the property to be removed from the          @param index - Index to the property to be removed from the
         instance.  Normally this is obtained by findProperty();         instance.  Normally this is obtained by findProperty();
         @exception IndexOutOfBoundsException if the index is outside the         @exception IndexOutOfBoundsException if the index is outside the
         range of properties in this object.         range of properties in this object.
     */     */
     void removeProperty(Uint32 index);     void removeProperty(Uint32 index);
  
     /** getPropertyCount - Gets the number of CIMProperty      /** Gets the number of CIMProperty objects defined for this CIMObject.
         objects defined for this CIMObject.  
         @return Count of the number of CIMProperty objects in the         @return Count of the number of CIMProperty objects in the
         CIMObject. Zero indicates that no CIMProperty objects         CIMObject. Zero indicates that no CIMProperty objects
         are contained in the CIMObject          are contained in the CIMObject.
         @exception Throws the IndexOutOfBoundsException exception if the index  
         is out of bounds  
   
     */     */
     Uint32 getPropertyCount() const;     Uint32 getPropertyCount() const;
  
     /** Clones the given object.      /** Makes a deep copy (clone) of the given object.
           @return copy of the CIMObject.
     */     */
     CIMObject clone() const;     CIMObject clone() const;
  
     /** Returns true if the two classes are structurally identical.      /** Compares with another CIM Object.
           @param x - CIM object for comparision.
           @return true if the objects are identical, false otherwise.
     */     */
     Boolean identical(const CIMConstObject& x) const;     Boolean identical(const CIMConstObject& x) const;
  
     /**      /** Determines if the object has not been initialized.
         Determines if the object has not been initialized.          @return  true if the object has not been initialized,
                    false otherwise.
         @return  True if the object has not been initialized,  
                  False otherwise  
      */      */
     Boolean isUninitialized() const;     Boolean isUninitialized() const;
  
     /**      /** Determines if the object represents a CIMClass.
         Determines if the object represents a CIMClass.          @return  true if the object represents a CIMClass,
                    false otherwise.
         @return  True if the object represents a CIMClass,  
                  False otherwise  
      */      */
     Boolean isClass () const;     Boolean isClass () const;
  
     /**      /** Determines if the object represents a CIMInstance.
         Determines if the object represents a CIMInstance.          @return  true if the object represents a CIMInstance,
                    false otherwise
         @return  True if the object represents a CIMInstance,  
                  False otherwise  
      */      */
     Boolean isInstance () const;     Boolean isInstance () const;
  
Line 272 
Line 264 
 // //
 //////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
  
   ///
 class PEGASUS_COMMON_LINKAGE CIMConstObject class PEGASUS_COMMON_LINKAGE CIMConstObject
 { {
 public: public:
  
       ///
     CIMConstObject();     CIMConstObject();
  
       ///
     CIMConstObject(const CIMConstObject& x);     CIMConstObject(const CIMConstObject& x);
  
       ///
     CIMConstObject(const CIMObject& x);     CIMConstObject(const CIMObject& x);
  
     /** Construction from CIMClass.      /** Constructs a CIMObject instance from a CIMClass instance.
     */     */
     CIMConstObject(const CIMClass& x);     CIMConstObject(const CIMClass& x);
  
     /** Construction from CIMInstance.      /** Constructs a CIMObject instance from a CIMInstance instance.
     */     */
     CIMConstObject(const CIMInstance& x);     CIMConstObject(const CIMInstance& x);
  
     /** Construction from CIMClass.      /** Constructs a CIMObject instance from a CIMConstClass instance.
     */     */
     CIMConstObject(const CIMConstClass& x);     CIMConstObject(const CIMConstClass& x);
  
     /** Construction from CIMInstance.      /** Constructs a CIMObject instance from a CIMConstInstance instance.
     */     */
     CIMConstObject(const CIMConstInstance& x);     CIMConstObject(const CIMConstInstance& x);
  
       ///
     CIMConstObject& operator=(const CIMConstObject& x);     CIMConstObject& operator=(const CIMConstObject& x);
  
       ///
     ~CIMConstObject();     ~CIMConstObject();
  
       ///
     const CIMName& getClassName() const;     const CIMName& getClassName() const;
  
       ///
     const CIMObjectPath& getPath() const;     const CIMObjectPath& getPath() const;
  
       ///
     Uint32 findQualifier(const CIMName& name) const;     Uint32 findQualifier(const CIMName& name) const;
  
       ///
     CIMConstQualifier getQualifier(Uint32 index) const;     CIMConstQualifier getQualifier(Uint32 index) const;
  
       ///
     Uint32 getQualifierCount() const;     Uint32 getQualifierCount() const;
  
       ///
     Uint32 findProperty(const CIMName& name) const;     Uint32 findProperty(const CIMName& name) const;
  
       ///
     CIMConstProperty getProperty(Uint32 index) const;     CIMConstProperty getProperty(Uint32 index) const;
  
       ///
     Uint32 getPropertyCount() const;     Uint32 getPropertyCount() const;
  
       ///
     CIMObject clone() const;     CIMObject clone() const;
  
       ///
     Boolean identical(const CIMConstObject& x) const;     Boolean identical(const CIMConstObject& x) const;
  
       ///
     Boolean isUninitialized() const;     Boolean isUninitialized() const;
  
       ///
     Boolean isClass() const;     Boolean isClass() const;
  
       ///
     Boolean isInstance() const;     Boolean isInstance() const;
  
 private: private:

Legend:
Removed from v.1.37  
changed lines
  Added in v.1.38
No CVS admin address has been configured
 Powered by
ViewCVS 0.9.2