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

Diff for /pegasus/src/Pegasus/Common/CIMMethod.h between version 1.38 and 1.39

version 1.38, 2003/10/30 14:43:48 version 1.39, 2003/11/12 15:27:53
Line 49 
Line 49 
 class CIMMethodRep; class CIMMethodRep;
  
 /** The CIMMethod class is used to represent CIM methods in Pegasus. A CIMMethod /** The CIMMethod class is used to represent CIM methods in Pegasus. A CIMMethod
     consists of the following entities      consists of the following entities:
     <ul>     <ul>
         <li>Name of the method, a CIMName          <li>Name of the method, a CIMName. Functions are provided to manipulate the name.
         <li>CIMType of the method, a CIMType          The name must be a legal name for a CIMProperty or Method {@link CIMName}.
         <li>Optional Qualifiers for the method          <li>CIMType of the return value of the method, a CIMType.
         <li>Optional Parameters for the method          <li>Optional CIMQualifiers for the method. A method can contain zero or
           more CIMQualifiers and functions are provided to manipulate the
           list of CIMQualifiers
           <li>Optional CIMParameters for the method which are the parameters to be
           placed on a CIM Method operation.  A CIMMethod can contain zero or more
           CIMParameters and functions are provided in CIMMethod to manipulate the
           list of CIMParameters.
     </ul>     </ul>
     In addition, internally, there are the following additional attributes     In addition, internally, there are the following additional attributes
     that are part of a CIMMethod.     that are part of a CIMMethod.
     <ul>     <ul>
         <li>propagated - attributed defining whether this CIMMethod is         <li>propagated - attributed defining whether this CIMMethod is
         propagated from a superclass.  Note that this is normally set          propagated from a superclass.  Note that this is normally set as part of
         as part of resolving objects when they are placed in a repository          completing the definition of objects (resolving) when they are placed in a
         and is NOT automatically set when creating a local object.  It          repository and is NOT automatically set when creating a local object.  It
         can only logically be set in context of the superclass of which          is part of the context of the object within the repository.  It can only
         this CIMMethod is defined.          logically be set in context of the superclass of which this CIMMethod is
           defined.
         <li>ClassOrigin - attribute defining the superclass in which this         <li>ClassOrigin - attribute defining the superclass in which this
         CIMMethod was originally defined.  This is normally se as part          CIMMethod was originally defined.  This is normally set as part of
         of resolving Class and instances.  It is available from objects          resolving Class and instances in the context of other objects (i.e.  a
         retrieved from the repository.          repository).  This attribute is available from objects retrieved from the
           repository, for example and indicates the Class/Instance in the hiearchy
           (this object or a superclass or instance of a superclass)was originally
           defined.  Together the propagated and ClassOrigin attributes can be used
           to determine if methods originated with the current object or were
           inherited from higher levels in the hiearchy.
     </ul>     </ul>
     CIMMethod is a shared class and uses a representation object and reference      Normally CIMMethods are defined in the context of CIMClasses. A CIMClass can include
     counting to control the lifecycle of the objects.      zero or more CIMMethods
       CIMMethod is a shared class so that assignment and copy operators do not
       create new copies of the data representing a CIMMethod object but point
       back to the original object and the lifecycle of the original object is
       controlled by the accumulative lifecycle of any copies and assigned
       objects.
       {@link Shared Classes}
     @see CIMConstMethod     @see CIMConstMethod
       @see CIMParameters
       @see CIMQualifiers
       @see CIMType
 */ */
 class PEGASUS_COMMON_LINKAGE CIMMethod class PEGASUS_COMMON_LINKAGE CIMMethod
 { {
 public: public:
  
     /** Creates a new default CIMMethod object. The object created is     /** Creates a new default CIMMethod object. The object created is
         empty.  Other methods such as setName() or assign must be          empty.  The only thing that can be done with this constructor
         used to provide attributes for the object          is to copy another object into it.  Other methods such as setName, etc.
           will fail.  The object has the state unitialized which can be tested with
           the Unitialized method.
           @exception throws UninitializedObjectException() if any method except the copy
           function is executed against.
         @see CIMConstMethod()         @see CIMConstMethod()
           @see Unitialized()
     */     */
     CIMMethod();     CIMMethod();
  
     /** Creates a new CIMMethod object from another method instance. This method      /** Creates a new CIMMethod object from another CIMmethod instance. This method
         assigns the new object to the representation in the parameter and increments the         assigns the new object to the representation in the parameter and increments the
         representation count.  It does NOT create a new independent object.          representation count.  It does NOT create a new independent object but creates
         @param x - CIMMethod object from which to create CIMMethod object.          a reference from the assigned object to the representation of the object being
           assigned.
           @param x CIMMethod object from which to create CIMMethod object.
         <pre>         <pre>
             CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);             CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);
             const CIMMethod cm1(m1);             const CIMMethod cm1(m1);
Line 105 
Line 133 
             CIMName() (Null name).             CIMName() (Null name).
         @param propagated Optional flag indicating whether the definition of the         @param propagated Optional flag indicating whether the definition of the
             CIM Method is local to the CIM Class (respectively, Instance) in which             CIM Method is local to the CIM Class (respectively, Instance) in which
             it appears, or was propagated without modification from the underlying              it appears, or was propagated without modification from the a
             Subclass (respectively, Class). Default is false.              Superclass. Default is false.
         <pre>         <pre>
             CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING)              CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);
         </pre>         </pre>
     */     */
     CIMMethod(     CIMMethod(
Line 118 
Line 146 
         Boolean propagated = false);         Boolean propagated = false);
  
     /** Destructor for the CIMMethod. Since this is a shared class, the destructor     /** Destructor for the CIMMethod. Since this is a shared class, the destructor
         is automatically executed when the representation reference count becomes          is only releases when there are no more objects pointing to the representation of this
         zero          object.
     */     */
     ~CIMMethod();     ~CIMMethod();
  
     /** Assignment operator. Assigns one CIM method to another.  This method performs     /** Assignment operator. Assigns one CIM method to another.  This method performs
         the assignment by incrementing the reference count for the representation of         the assignment by incrementing the reference count for the representation of
         the CIMMethod, not by creating a deep copy of the object          the CIMMethod, not by creating a deep copy of the object.
           <pre>
               CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);
               CIMMethod m2 = m1;
           </pre>
     */     */
     CIMMethod& operator=(const CIMMethod& x);     CIMMethod& operator=(const CIMMethod& x);
  
     /** Gets the name of the method.     /** Gets the name of the method.
         @return CIMName with the name of the method.         @return CIMName with the name of the method.
         <pre>         <pre>
             CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING)              CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);
             assert(m1.getName() == CIMName ("getHostName"));             assert(m1.getName() == CIMName ("getHostName"));
         </pre>         </pre>
     */     */
Line 150 
Line 182 
  
     /** Gets the method type.     /** Gets the method type.
         @return The CIMType containing the method type for this method.         @return The CIMType containing the method type for this method.
           This is the type returned as the return value of a method operation.
         <pre>         <pre>
             CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING)              CIMMethod m1(CIMName ("getHostName"), CIMTYPE_STRING);
             assert(m1.getType() == CIMTYPE_STRING);             assert(m1.getType() == CIMTYPE_STRING);
         </pre>         </pre>
     */     */
     CIMType getType() const;     CIMType getType() const;
  
     /** Sets the method type to the specified CIM method type     /** Sets the method type to the specified CIM method type
         as defined in CIMType.          as defined in CIMType. This is the type of the CIMValue
           that is returned on a CIMMethod operation
         @param type CIMType to be set into the method object.         @param type CIMType to be set into the method object.
         <pre>         <pre>
             CIMMethod m1();             CIMMethod m1();
Line 177 
Line 211 
  
     /** Sets the ClassOrigin attribute with the classname defined on     /** Sets the ClassOrigin attribute with the classname defined on
         the input parameter. Normally this function is used internally         the input parameter. Normally this function is used internally
         as part of resolving the objects containing methods (classes          as part of the use objects containing methods (classes
         and instances).          and instances) in a context such as a repository.
     @param classOrigin - CIMName parameter defining the name     @param classOrigin - CIMName parameter defining the name
     of the class origin.     of the class origin.
     */     */
Line 374 
Line 408 
     constructors, (i.e. getter methods) and the destructor.     constructors, (i.e. getter methods) and the destructor.
     The const form of the object is used TBD     The const form of the object is used TBD
     ATTN: Complete the explanation of why.     ATTN: Complete the explanation of why.
     @see CIMMethod  
 */ */
 class PEGASUS_COMMON_LINKAGE CIMConstMethod class PEGASUS_COMMON_LINKAGE CIMConstMethod
 { {
Line 403 
Line 436 
     const CIMName& classOrigin = CIMName(),     const CIMName& classOrigin = CIMName(),
     Boolean propagated = false);     Boolean propagated = false);
  
     /// destructor.      /// destructor. CIMMethod objects are destroyed when
     ~CIMConstMethod();     ~CIMConstMethod();
  
     /// assignment operator.      /** assigns one CIMMethod object to another. Because this
       is a shared class, an assignment does not create a copy to
       the assigned object but sets a refernce in the assigned object
       to the same object as the CIMMethod object that was assigned.
       Note that the return is really CIMConstMethod, not CIMMethod to
       prevent unplanned modification of the object
       @param x CIMMethod object that is to be assigned to another
       CIMMethod object.
       <pre>
       CIMMethod cm1("putthing");
       </pre>
       */
     CIMConstMethod& operator=(const CIMConstMethod& x);     CIMConstMethod& operator=(const CIMConstMethod& x);
  
     /// assignment operator.     /// assignment operator.
Line 415 
Line 459 
     /** gets CIMMethod name. Operation is the same as     /** gets CIMMethod name. Operation is the same as
         CIMMethod getName().         CIMMethod getName().
         @see CIMMethod         @see CIMMethod
   
     */     */
     const CIMName& getName() const;     const CIMName& getName() const;
  
     /** gets CIMMethod CIMType. Functions the same as     /** gets CIMMethod CIMType. Functions the same as
         CIMMethod getType();         CIMMethod getType();
         @see CIMMethod         @see CIMMethod
   
     */     */
     CIMType getType() const;     CIMType getType() const;
  
     /**  gets ClassOrigin attribute. Functions the same     /**  gets ClassOrigin attribute. Functions the same
          as CIMMethod getClassOrigin()          as CIMMethod getClassOrigin()
          @see CIMMethod          @see CIMMethod
   
     */     */
     const CIMName& getClassOrigin() const;     const CIMName& getClassOrigin() const;
  

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