(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.24 and 1.33

version 1.24, 2002/05/23 16:52:14 version 1.33, 2002/07/31 22:05:08
Line 1 
Line 1 
 //%///////////////////////////////////////////////////////////////////////////// //%/////////////////////////////////////////////////////////////////////////////
 // //
 // Copyright (c) 2000, 2001 The Open group, BMC Software, Tivoli Systems, IBM  // Copyright (c) 2000, 2001, 2002 BMC Software, Hewlett-Packard Company, IBM,
   // The Open Group, Tivoli Systems
 // //
 // 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 32 
Line 33 
 #define Pegasus_Object_h #define Pegasus_Object_h
  
 #include <Pegasus/Common/Config.h> #include <Pegasus/Common/Config.h>
   #include <Pegasus/Common/Linkage.h>
 #include <Pegasus/Common/String.h> #include <Pegasus/Common/String.h>
   #include <Pegasus/Common/CIMName.h>
 #include <Pegasus/Common/Array.h> #include <Pegasus/Common/Array.h>
 #include <Pegasus/Common/CIMProperty.h> #include <Pegasus/Common/CIMProperty.h>
 #include <Pegasus/Common/CIMQualifier.h> #include <Pegasus/Common/CIMQualifier.h>
Line 95 
Line 98 
  
     /** Accessor for ClassName component of the object.     /** Accessor for ClassName component of the object.
         @return - Returns the ClassName of the object in         @return - Returns the ClassName of the object in
         a String parameter.          a CIMName parameter.
         <pre>         <pre>
             String className;              CIMName className;
             CIMClass myclass("myclass", "superclass");             CIMClass myclass("myclass", "superclass");
             className = myclass.getClassName;             className = myclass.getClassName;
         </pre>         </pre>
     */     */
     const String& getClassName() const;      const CIMName& getClassName() const;
  
     const CIMObjectPath& getPath() const;     const CIMObjectPath& getPath() const;
  
Line 115 
Line 118 
     /** addQualifier - Adds the CIMQualifier object to the instance.     /** addQualifier - Adds the CIMQualifier object to the instance.
         Thows an exception of the CIMQualifier already exists in the instance         Thows an exception of the CIMQualifier already exists in the instance
         @param CIMQualifier object to add to instance         @param CIMQualifier object to add to instance
         @return ATTN:          @return the resulting object.
         @exception Throws AlreadyExists.         @exception Throws AlreadyExists.
     */     */
     CIMObject& addQualifier(const CIMQualifier& qualifier);     CIMObject& addQualifier(const CIMQualifier& qualifier);
  
     /** findQualifier - Searches the instance for the qualifier object     /** findQualifier - Searches the instance for the qualifier object
         defined by the input parameter.         defined by the input parameter.
         @param String defining the qualifier object to be found.          @param 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 String& name) const;      Uint32 findQualifier(const CIMName& name) const;
   
     /** existsQualifier - Searches the instance for the qualifier object  
         defined by the input parameter.  
         @param String defining the qualifier object to be found.  
         @return - Returns True if  the qualifier object exists or false  
         if the qualifier is not found.  
     */  
     Boolean existsQualifier(const String& name) const;  
  
     /** getQualifier - Retrieves the qualifier object defined by the     /** getQualifier - Retrieves the qualifier object defined by the
         index input parameter.  @ index for the qualifier object.         index input parameter.  @ index for the qualifier object.
Line 155 
Line 150 
         @return: Returns qualifier object defined by index.         @return: Returns qualifier object defined by index.
         @exception Throws the OutOfBounds exception if the index         @exception Throws the OutOfBounds exception if the index
         is out of bounds         is out of bounds
         ATTN: What is effect of out of range index???  
         ATTN: Is the above statement correct???  
     */     */
     CIMConstQualifier getQualifier(Uint32 pos) const;     CIMConstQualifier getQualifier(Uint32 pos) const;
  
Line 175 
Line 168 
         parameter to the CIMObject         parameter to the CIMObject
         @param Property Object to be added.  See the CIM Property         @param Property Object to be added.  See the CIM Property
         class for definition of the property object         class for definition of the property object
         @return ATTN:          @return the resulting object.
         @exception Throws the exception AlreadyExists if the property         @exception Throws the exception AlreadyExists if the property
         already exists.         already exists.
     */     */
Line 184 
Line 177 
     /** findProperty - Searches the CIMProperty objects installed in the     /** findProperty - Searches the CIMProperty objects installed in the
         CIMObject for property objects with the name defined by the         CIMObject for property objects with the name defined by the
         input.         input.
         @param String with the name of the property object to be found          @param 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 to 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.
     */     */
     Uint32 findProperty(const String& name) const;      Uint32 findProperty(const CIMName& name) const;
   
     /** existsProperty - Determines if a property object with the  
         name defined by the input parameter exists in the class.  
         @parm String parameter with the property name.  
         @return True if the property object exists.  
     */  
     Boolean existsProperty(const String& name) const;  
  
     /** getProperty - Gets the CIMProperty object in the CIMObject defined     /** getProperty - Gets the CIMProperty object in the CIMObject defined
         by the input index parameter.         by the input index parameter.
Line 207 
Line 193 
         @return CIMProperty object corresponding to the index.         @return CIMProperty object corresponding to the index.
         @exception Throws the OutOfBounds exception if the index         @exception Throws the OutOfBounds exception if the index
         is out of bounds         is out of bounds
   
         ATTN: What is the effect of out of range?  
     */     */
     CIMProperty getProperty(Uint32 pos);     CIMProperty getProperty(Uint32 pos);
  
Line 221 
Line 205 
         @return CIMProperty object corresponding to the index.         @return CIMProperty object corresponding to the index.
         @exception Throws the OutOfBounds exception if the index         @exception Throws the OutOfBounds exception if the index
         is out of bounds         is out of bounds
   
         ATTN: What is the effect of out of range?  
     */     */
     CIMConstProperty getProperty(Uint32 pos) const;     CIMConstProperty getProperty(Uint32 pos) const;
  
Line 253 
Line 235 
     */     */
     Boolean identical(const CIMConstObject& x) const;     Boolean identical(const CIMConstObject& x) const;
  
 #ifdef PEGASUS_INTERNALONLY      /**
     /** isNull() - ATTN: */          Determines if the object has not been initialized.
     Boolean isNull() const;  
 #endif          @return  True if the object has not been initialized,
                    False otherwise
        */
       Boolean isUninitialized() const;
  
 private: private:
  
Line 275 
Line 260 
 #endif #endif
 }; };
  
   #define PEGASUS_ARRAY_T CIMObject
   # include <Pegasus/Common/ArrayInter.h>
   #undef PEGASUS_ARRAY_T
   
 //////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
 // //
 // CIMConstObject // CIMConstObject
Line 321 
Line 310 
  
     ~CIMConstObject();     ~CIMConstObject();
  
     const String& getClassName() const;      const CIMName& getClassName() const;
  
     const CIMObjectPath& getPath() const;     const CIMObjectPath& getPath() const;
  
     Uint32 findQualifier(const String& name) const;      Uint32 findQualifier(const CIMName& name) const;
  
     CIMConstQualifier getQualifier(Uint32 pos) const;     CIMConstQualifier getQualifier(Uint32 pos) const;
  
     Uint32 getQualifierCount() const;     Uint32 getQualifierCount() const;
  
     Uint32 findProperty(const String& name) const;      Uint32 findProperty(const CIMName& name) const;
  
     CIMConstProperty getProperty(Uint32 pos) const;     CIMConstProperty getProperty(Uint32 pos) const;
  
Line 341 
Line 330 
  
     Boolean identical(const CIMConstObject& x) const;     Boolean identical(const CIMConstObject& x) const;
  
 #ifdef PEGASUS_INTERNALONLY      Boolean isUninitialized() const;
     Boolean isNull() const;  
 #endif  
  
 private: private:
  
Line 360 
Line 347 
 #endif #endif
 }; };
  
 /** The CIMObjectWithPath encapsulates a CIMObjectPath and CIMObject.  
     Accessors are provided for getting the two parts. Constructors are  
     provided for initializing it from a CIMObject.  
 */  
 class PEGASUS_COMMON_LINKAGE CIMObjectWithPath  
 {  
 public:  
   
     /** Constructor  
     */  
     CIMObjectWithPath();  
   
     /** constructor  
     */  
     CIMObjectWithPath(const CIMObjectPath& reference, const CIMObject& object);  
   
     /** Constructor - Constructs a CIMObjectWithPath Object from  
         another CimObjectWithPath  
         @param - ATTN  
     */  
     CIMObjectWithPath(const CIMObjectWithPath& x);  
   
     ~CIMObjectWithPath();  
   
     CIMObjectWithPath& operator=(const CIMObjectWithPath& x);  
   
     /** set -  
     */  
     void set(const CIMObjectPath& reference, const CIMObject& object);  
   
     /**  
     */  
     const CIMObjectPath& getReference() const;  
   
     /**  
     */  
     const CIMObject& getObject() const;  
   
     /**  
     */  
     CIMObjectPath& getReference();  
   
     /**  
     */  
     CIMObject& getObject();  
   
 private:  
   
     CIMObjectPath _reference;  
     CIMObject _object;  
 };  
   
 PEGASUS_NAMESPACE_END PEGASUS_NAMESPACE_END
  
 #endif /* Pegasus_Object_h */ #endif /* Pegasus_Object_h */

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