(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.38 and 1.40.10.1

version 1.38, 2003/03/12 21:02:53 version 1.40.10.1, 2004/11/12 17:48:28
Line 1 
Line 1 
 //%/////////////////////////////////////////////////////////////////////////////  //%2003////////////////////////////////////////////////////////////////////////
 // //
 // Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Company, IBM,  // Copyright (c) 2000, 2001, 2002  BMC Software, Hewlett-Packard Development
 // The Open Group, Tivoli Systems  // Company, L. P., IBM Corp., The Open Group, Tivoli Systems.
   // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L. P.;
   // IBM Corp.; EMC Corporation, The Open Group.
 // //
 // Permission is hereby granted, free of charge, to any person obtaining a copy // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to // of this software and associated documentation files (the "Software"), to
Line 48 
Line 50 
 class CIMConstClass; class CIMConstClass;
 class CIMInstance; class CIMInstance;
 class CIMConstInstance; class CIMConstInstance;
   class CIMProperty;
   class CIMConstProperty;
   class CIMQualifier;
   class CIMConstQualifier;
  
 //////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
 // //
Line 65 
Line 71 
 { {
 public: public:
  
     /** Constructor.      /** Creates CIMObject instance with null values (default constructor).
     */     */
     CIMObject();     CIMObject();
  
     /** Copy constructor.      /** Creates a new CIMObject instance (copy constructor).
       @param x Specifies the name of the CIMObject instance to create.
     */     */
     CIMObject(const CIMObject& x);     CIMObject(const CIMObject& x);
  
     /** Construction from CIMClass.      /** Construction of a CIMObject instance based on the CIMClass object.
     */     */
     CIMObject(const CIMClass& x);     CIMObject(const CIMClass& x);
  
     /** Construction from CIMInstance.      /** Construction of a CIMObject instance based on the CIMInstance object.
     */     */
     CIMObject(const CIMInstance& x);     CIMObject(const CIMInstance& x);
  
     /** Assignment operator.      /** Assign the values of the CIMObject instance to CIMObject.
       @param x Specifies the name of the CIMObject instance.
     */     */
     CIMObject& operator=(const CIMObject& x);     CIMObject& operator=(const CIMObject& x);
  
     /** Destructor.      /** Destroys CIMObject.
     */     */
     ~CIMObject();     ~CIMObject();
  
     /** Gets the ClassName of the object.     /** Gets the ClassName of the object.
         @return ClassName of the object in a CIMName parameter.          @return ClassName of the object in a CIMName parameter. For example,
         <pre>         <pre>
             CIMName className;             CIMName className;
             CIMClass myclass("myclass", "superclass");             CIMClass myclass("myclass", "superclass");
Line 99 
Line 107 
     */     */
     const CIMName& getClassName() const;     const CIMName& getClassName() const;
  
     ///      /** REVIEWERS: Insert description here.
       */
     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 Specifies the CIMObjectPath that contains the object path.
     */     */
     void setPath (const CIMObjectPath & path);     void setPath (const CIMObjectPath & path);
  
     /** Adds the CIMQualifier object to the instance.     /** Adds the CIMQualifier object to the instance.
         @param qualifier - CIMQualifier object to add to instance.          @param qualifier CIMQualifier object to add to instance.
         @return the resulting CIMObject.          @return The resulting CIMObject.
         @exception AlreadyExistsException if the CIMQualifier already          @exception AlreadyExistsException True if the CIMQualifier already
         exists in the instance.          exists in the instance; otherwise, false.
     */     */
     CIMObject& addQualifier(const CIMQualifier& qualifier);     CIMObject& addQualifier(const CIMQualifier& qualifier);
  
     /** 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 name - CIMName defining the qualifier object to be found.          @param name CIMName that defines the qualifier object to be found.
         @return  Position of the qualifier to be used in subsequent          @return  Position of the qualifier to use 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;
  
     /** Retrieves the qualifier object defined by the input parameter.     /** Retrieves the qualifier object defined by the input parameter.
         @param  index - Index for the qualifier object. The index to          @param  index Specifies the index for the qualifier object. The index to
         qualifier objects is zero-origin and continuous so that         qualifier objects is zero-origin and continuous so that
         incrementing loops can be used to get all qualifier         incrementing loops can be used to get all qualifier
         objects in a CIMInstance.         objects in a CIMInstance.
         @return CIMQualifier object defined by the index.         @return CIMQualifier object defined by the index.
         @exception IndexOutOfBoundsException exception if the index          @exception IndexOutOfBoundsException True if the index
         is out of bounds.          is out of bounds; otherwise, false.
     */     */
     CIMQualifier getQualifier(Uint32 index);     CIMQualifier getQualifier(Uint32 index);
  
     /** Retrieves the qualifier object defined by the input parameter.     /** Retrieves the qualifier object defined by the input parameter.
         @param index - Index for the qualifier object. The index to          @param index Specifies the index for the qualifier object. The index to
         qualifier objects is zero-origin and continuous so that         qualifier objects is zero-origin and continuous so that
         incrementing loops can be used to get all qualifier         incrementing loops can be used to get all qualifier
         objects in a CIMInstance.         objects in a CIMInstance.
         @return CIMConstQualifier object defined by the index.         @return CIMConstQualifier object defined by the index.
         @exception IndexOutOfBoundsException exception if the index          @exception IndexOutOfBoundsException True if the index
         is out of bounds.          is out of bounds; otherwise, false.
     */     */
     CIMConstQualifier getQualifier(Uint32 index) const;     CIMConstQualifier getQualifier(Uint32 index) const;
  
     ///      /** REVIEWERS: Insert description here.
       */
     void removeQualifier(Uint32 index);     void removeQualifier(Uint32 index);
  
     /** Gets the number of CIMQualifier objects defined for     /** Gets the number of CIMQualifier objects defined for
Line 157 
Line 167 
  
     /** Adds a property object defined by the input parameter to     /** Adds a property object defined by the input parameter to
         the CIMObject.         the CIMObject.
         @param x - 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 CIMObject.          @return The resulting CIMObject.
         @exception AlreadyExistsException if the property already exists.          @exception AlreadyExistsException True if the property already exists
           otherwise, false.
     */     */
     CIMObject& addProperty(const CIMProperty& x);     CIMObject& addProperty(const CIMProperty& x);
  
     /** Searches the CIMProperty objects in the     /** Searches the CIMProperty objects in the
         CIMObject for a property object with the name defined by the         CIMObject for a property object with the name defined by the
         input parameter.         input parameter.
         @param name - 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 of 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 parameter.         input parameter.
Line 176 
Line 187 
  
     /** Gets the CIMProperty object in the CIMObject defined     /** Gets the CIMProperty object in the CIMObject defined
         by the input parameter.         by the input parameter.
         @param index - Index to the property object in the CIMObject.          @param index Specifies the 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 IndexOutOfBoundsException exception if the index          @exception IndexOutOfBoundsException True if the index
         is out of bounds.          is out of bounds; otherwise, false.
     */     */
     CIMProperty getProperty(Uint32 index);     CIMProperty getProperty(Uint32 index);
  
     /** Gets the CIMproperty object in the CIMObject defined     /** Gets the CIMproperty object in the CIMObject defined
         by the input parameter.         by the input parameter.
         @param index - Index to the property object in the CIMObject.          @param index Specifies the 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 True if the index is outside the
         range of properties in this object.          range of properties in this object; otherwise, false.
     */     */
     CIMConstProperty getProperty(Uint32 index) const;     CIMConstProperty getProperty(Uint32 index) const;
  
     /** 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 Specifies the 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 True if the index is outside the
         range of properties in this object.          range of properties in this object; otherwise, false.
     */     */
     void removeProperty(Uint32 index);     void removeProperty(Uint32 index);
  
Line 211 
Line 222 
     Uint32 getPropertyCount() const;     Uint32 getPropertyCount() const;
  
     /** Makes a deep copy (clone) of the given object.     /** Makes a deep copy (clone) of the given object.
         @return copy of the CIMObject.          @return Copy of the CIMObject.
     */     */
     CIMObject clone() const;     CIMObject clone() const;
  
     /** Compares with another CIM Object.     /** Compares with another CIM Object.
         @param x - CIM object for comparision.          @param x CIM object for comparison.
         @return true if the objects are identical, false otherwise.          @return True if the objects are identical; otherwise, false.
     */     */
     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,          @return  True if the object has not been initialized; otherwise, false.
                  false otherwise.  
      */      */
     Boolean isUninitialized() const;     Boolean isUninitialized() const;
  
       /** Returns a string representing the value of the CIMObject.
           With the inclusion of CIMObject as a CIMValue, the intent
           of the toString() method is to produce a "human-readable" string
           consistent with other CIMValue types. The string will be a MOF
           representation of the object (ie. either CIMClass or CIMInstance)
           using the _rep's toMof() method.
           @return String representing the CIMObject value.
       */
       String toString () const;
   
     /** Determines if the object represents a CIMClass.     /** Determines if the object represents a CIMClass.
         @return  true if the object represents a CIMClass,          @return  True if the object represents a CIMClass; otherwise, false.
                  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,          @return  True if the object represents a CIMInstance; otherwise, false.
                  false otherwise  
      */      */
     Boolean isInstance () const;     Boolean isInstance () const;
  
Line 264 
Line 283 
 // //
 //////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
  
 ///  /**
   REVIEWERS: Add class defintion here
   */
 class PEGASUS_COMMON_LINKAGE CIMConstObject class PEGASUS_COMMON_LINKAGE CIMConstObject
 { {
 public: public:
  
     ///      /** Constructs a new CIMConstObject with null values (default constructor).
       */
     CIMConstObject();     CIMConstObject();
  
     ///      /** Constructs a new CIMConstObject.
       @param x Specifies the name of the CIMConstObject instance to create.
       */
     CIMConstObject(const CIMConstObject& x);     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
       the CIMConstObject instance.
       */
     CIMConstObject(const CIMObject& x);     CIMConstObject(const CIMObject& x);
  
     /** Constructs a CIMObject instance from a CIMClass instance.     /** Constructs a CIMObject instance from a CIMClass instance.
       @param x Specifies the name of the CIMClass instance.
     */     */
     CIMConstObject(const CIMClass& x);     CIMConstObject(const CIMClass& x);
  
     /** Constructs a CIMObject instance from a CIMInstance instance.     /** Constructs a CIMObject instance from a CIMInstance instance.
       @param x Specifies the name of the CIMInstance instance.
     */     */
     CIMConstObject(const CIMInstance& x);     CIMConstObject(const CIMInstance& x);
  
     /** Constructs a CIMObject instance from a CIMConstClass instance.     /** Constructs a CIMObject instance from a CIMConstClass instance.
       @param x Specifies the name of the CIMConstClass instance.
     */     */
     CIMConstObject(const CIMConstClass& x);     CIMConstObject(const CIMConstClass& x);
  
     /** Constructs a CIMObject instance from a CIMConstInstance instance.     /** Constructs a CIMObject instance from a CIMConstInstance instance.
       @param x Specifies the name of the CIMConstInstance instance.
     */     */
     CIMConstObject(const CIMConstInstance& x);     CIMConstObject(const CIMConstInstance& x);
  
     ///      /** REVIEWERS: Insert description here.
       @param x Specifies the name of the CIMConstObject instance.
       */
     CIMConstObject& operator=(const CIMConstObject& x);     CIMConstObject& operator=(const CIMConstObject& x);
  
     ///      /** CIMConstObject destructor.
       */
     ~CIMConstObject();     ~CIMConstObject();
  
     ///      /** REVIEWERS: Insert description here.
       */
     const CIMName& getClassName() const;     const CIMName& getClassName() const;
  
     ///      /** REVIEWERS: Insert description here.
       */
     const CIMObjectPath& getPath() const;     const CIMObjectPath& getPath() const;
  
     ///      /** REVIEWERS: Insert description here.
       @param name Specifies the name of the CIMName instance.
       */
     Uint32 findQualifier(const CIMName& name) const;     Uint32 findQualifier(const CIMName& name) const;
  
     ///      /** REVIEWERS: Insert description here.
       @param index Specifies the name of the Uint32 instance.
       */
     CIMConstQualifier getQualifier(Uint32 index) const;     CIMConstQualifier getQualifier(Uint32 index) const;
  
     ///      /** REVIEWERS: Insert description here.
       */
     Uint32 getQualifierCount() const;     Uint32 getQualifierCount() const;
  
     ///      /** REVIEWERS: Insert description here.
       @param name Specifies the name of the CIMName instance.
       */
     Uint32 findProperty(const CIMName& name) const;     Uint32 findProperty(const CIMName& name) const;
  
     ///      /** REVIEWERS: Insert description here.
       @param index Specifies the name of the Uint32 instance.
       */
     CIMConstProperty getProperty(Uint32 index) const;     CIMConstProperty getProperty(Uint32 index) const;
  
     ///      /** REVIEWERS: Insert description here.
       */
     Uint32 getPropertyCount() const;     Uint32 getPropertyCount() const;
  
     ///      /** REVIEWERS: Insert description here.
       */
     CIMObject clone() const;     CIMObject clone() const;
  
     ///      /** REVIEWERS: Insert description here.
       */
     Boolean identical(const CIMConstObject& x) const;     Boolean identical(const CIMConstObject& x) const;
  
     ///      /** REVIEWERS: Insert description here.
       */
     Boolean isUninitialized() const;     Boolean isUninitialized() const;
  
     ///      /** Returns a string representing the value of the CIMObject.
           With the inclusion of CIMObject as a CIMValue, the intent
           of the toString() method is to produce a "human-readable" string
           consistent with other CIMValue types. The string will be a MOF
           representation of the object (ie. either CIMClass or CIMInstance)
           using the _rep's toMof() method.
           @return String representing the CIMObject value.
       */
       String toString () const;
   
       /** REVIEWERS: Insert description here.
       */
     Boolean isClass() const;     Boolean isClass() const;
  
     ///      /** REVIEWERS: Insert description here.
       */
     Boolean isInstance() const;     Boolean isInstance() const;
  
 private: private:

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