(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.11 and 1.19

version 1.11, 2001/05/21 17:15:44 version 1.19, 2002/03/24 13:33:07
Line 1 
Line 1 
 //%///////////////////////////////////////////////////////////////////////////// //%/////////////////////////////////////////////////////////////////////////////
 // //
 // Copyright (c) 2000 The Open Group, BMC Software, Tivoli Systems, IBM  // Copyright (c) 2000, 2001 The Open group, BMC Software, Tivoli Systems, IBM
 // //
 // Permission is hereby granted, free of charge, to any person obtaining a  // Permission is hereby granted, free of charge, to any person obtaining a copy
 // copy of this software and associated documentation files (the "Software"),  // of this software and associated documentation files (the "Software"), to
 // to deal in the Software without restriction, including without limitation  // deal in the Software without restriction, including without limitation the
 // the rights to use, copy, modify, merge, publish, distribute, sublicense,  // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 // and/or sell copies of the Software, and to permit persons to whom the  // sell copies of the Software, and to permit persons to whom the Software is
 // Software is furnished to do so, subject to the following conditions:  // furnished to do so, subject to the following conditions:
 // //
 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR  // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,  // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL  // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER  // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING  // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER  // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 // DEALINGS IN THE SOFTWARE.  // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
   // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 // //
 //============================================================================== //==============================================================================
 // //
Line 93 
Line 94 
         Dec(_rep);         Dec(_rep);
     }     }
  
     /** CIMMethod getName - Gets the name of the method      /** getName - Gets the name of the method
         @return String with the name of the method         @return String with the name of the method
     */     */
     const String& getName() const     const String& getName() const
Line 102 
Line 103 
         return _rep->getName();         return _rep->getName();
     }     }
  
     /** CIMMethod setName - Set the method name      /** setName - Set the method name
         @param name         @param name
         @exception IllegalName if name argument not legal CIM identifier.         @exception IllegalName if name argument not legal CIM identifier.
     */     */
Line 112 
Line 113 
         _rep->setName(name);         _rep->setName(name);
     }     }
  
     /** CIMMethod getType - gets the method type      /** getType - gets the method type
         @return The CIM method type for this method.         @return The CIM method type for this method.
     */     */
     CIMType getType() const     CIMType getType() const
Line 121 
Line 122 
         return _rep->getType();         return _rep->getType();
     }     }
  
     /** CIMMethod setType - Sets the method type to the specified CIM method      /** setType - Sets the method type to the specified CIM method
         type as defined in CIMType /Ref{TYPE}         type as defined in CIMType /Ref{TYPE}
     */     */
     void setType(CIMType type)     void setType(CIMType type)
Line 130 
Line 131 
         _rep->setType(type);         _rep->setType(type);
     }     }
  
     /** CIMMethod getClassOrigin - Returns the class in which this method      /** getClassOrigin - Returns the class in which this method
         was defined.         was defined.
         @return ATTN:          @return String containing the classOrigin field.
     */     */
     const String& getClassOrigin() const     const String& getClassOrigin() const
     {     {
Line 140 
Line 141 
         return _rep->getClassOrigin();         return _rep->getClassOrigin();
     }     }
  
     /** CIMMethod setClassOrigin - ATTN: */      /** setClassOrigin - Set the ClassOrigin attribute with
                   the classname defined on input
                   @param classOrigin - String parameter defining the name
                   of the class origin
           */
     void setClassOrigin(const String& classOrigin)     void setClassOrigin(const String& classOrigin)
     {     {
         _checkRep();         _checkRep();
         _rep->setClassOrigin(classOrigin);         _rep->setClassOrigin(classOrigin);
     }     }
  
     /** method getPropagated - ATTN: */      /** getPropagated - Tests the propogated qualifier
           @return - returns True if method is propogated
           */
     Boolean getPropagated() const     Boolean getPropagated() const
     {     {
         _checkRep();         _checkRep();
         return _rep->getPropagated();         return _rep->getPropagated();
     }     }
  
     /** method setPropagated - ATTN: */      /** setPropagated - Sets the Propagaged Qualifier */
     void setPropagated(Boolean propagated)     void setPropagated(Boolean propagated)
     {     {
         _checkRep();         _checkRep();
         _rep->setPropagated(propagated);         _rep->setPropagated(propagated);
     }     }
  
     /** CIMMethod addQualifier - Adds a Qualifier to the method object.      /** addQualifier - Adds a Qualifier to the method object.
         @param CIMQualifier to be added         @param CIMQualifier to be added
         @return Throws AlreadyExists excetpion if the qualifier already exists         @return Throws AlreadyExists excetpion if the qualifier already exists
         in the method         in the method
Line 174 
Line 181 
         return *this;         return *this;
     }     }
  
     /** CIMMethod findQualifier - returns the position of the qualifier with      /** findQualifier - returns the position of the qualifier with
         the given name.         the given name.
         @param name Name of qualifier to be found.         @param name Name of qualifier to be found.
         @return index of the parameter if found; otherwise Uint32(-1).          @return index of the parameter if found; otherwise PEG_NOT_FOUND.
     */     */
     Uint32 findQualifier(const String& name)     Uint32 findQualifier(const String& name)
     {     {
Line 194 
Line 201 
     /** existsQualifier - returns the position of the qualifier with     /** existsQualifier - returns the position of the qualifier with
         the given name.         the given name.
         @param name Name of qualifier to be found.         @param name Name of qualifier to be found.
         @return index of the parameter if found; otherwise Uint32(-1).          @return index of the parameter if found; otherwise PEG_NOT_FOUND.
     */     */
     Boolean existsQualifier(const String& name)     Boolean existsQualifier(const String& name)
     {     {
Line 209 
Line 216 
     }     }
  
  
     /** CIMMethod getQualifier - Gets the CIMQualifier defined by the index      /** getQualifier - Gets the CIMQualifier defined by the index
         input as a parameter.         input as a parameter.
         @param Index of the qualifier requested.         @param Index of the qualifier requested.
         @return CIMQualifier object or exception         @return CIMQualifier object or exception
Line 242 
Line 249 
     }     }
  
  
     /** CIMMethod getQualifierCount - Returns the number of Qualifiers attached      /** getQualifierCount - Returns the number of Qualifiers attached
         to this method.          to this CIMmethod object.
         @return integer representing number of Qualifiers.         @return integer representing number of Qualifiers.
     */     */
     Uint32 getQualifierCount() const     Uint32 getQualifierCount() const
Line 252 
Line 259 
         return _rep->getQualifierCount();         return _rep->getQualifierCount();
     }     }
  
     /** CIMMethod addParameter - Adds the parameter defined by the input      /** addParameter - Adds the parameter defined by the input
         to the CIMMethod         to the CIMMethod
     */     */
     CIMMethod& addParameter(const CIMParameter& x)     CIMMethod& addParameter(const CIMParameter& x)
Line 262 
Line 269 
         return *this;         return *this;
     }     }
  
     /** CIMMethod findParameter - Finds the parameter whose name is given      /** findParameter - Finds the parameter whose name is given
         by the name parameter.         by the name parameter.
         @param name Name of parameter to be found.         @param name Name of parameter to be found.
         @return index of the parameter if found; otherwise Uint32(-1).          @return index of the parameter if found; otherwise PEG_NOT_FOUND.
     */     */
     Uint32 findParameter(const String& name)     Uint32 findParameter(const String& name)
     {     {
Line 279 
Line 286 
         return _rep->findParameter(name);         return _rep->findParameter(name);
     }     }
  
     /** CIMMethod getParameter - ATTN: */      /** getParameter - ATTN: */
     CIMParameter getParameter(Uint32 pos)     CIMParameter getParameter(Uint32 pos)
     {     {
         _checkRep();         _checkRep();
         return _rep->getParameter(pos);         return _rep->getParameter(pos);
     }     }
  
     /** CIMMethod getParameter - Gets the parameter defined by the index      /** getParameter - Gets the parameter defined by the index
         input as a parameter.         input as a parameter.
         @param index for the parameter to be returned.         @param index for the parameter to be returned.
         @return CIMParameter requested.         @return CIMParameter requested.
Line 299 
Line 306 
         return _rep->getParameter(pos);         return _rep->getParameter(pos);
     }     }
  
     /** CIMMethod getParameterCount - Gets the count of the numbeer of      /** getParameterCount - Gets the count of the numbeer of
         Parameters attached to the CIMMethod.         Parameters attached to the CIMMethod.
         @retrun - count of the number of parameters attached to the CIMMethod.         @retrun - count of the number of parameters attached to the CIMMethod.
     */     */
Line 309 
Line 316 
         return _rep->getParameterCount();         return _rep->getParameterCount();
     }     }
  
     /** method resolve - ATTN: */      /** resolve - resolves and completes the CIMMethod */
     void resolve(     void resolve(
         DeclContext* declContext,         DeclContext* declContext,
         const String& nameSpace,         const String& nameSpace,
Line 319 
Line 326 
         _rep->resolve(declContext, nameSpace, method);         _rep->resolve(declContext, nameSpace, method);
     }     }
  
     /** CIMMethod resolve */      /** resolve - Resolves and completes the CIMMethod */
     void resolve(     void resolve(
         DeclContext* declContext,         DeclContext* declContext,
         const String& nameSpace)         const String& nameSpace)
Line 334 
Line 341 
         return _rep != 0;         return _rep != 0;
     }     }
  
     /** method toXML - placing XML encoding of this object into out arguemnt. */      /** toXML - puts XML encoding of this CIMMethod object into out
           arguemnt.
       */
     void toXml(Array<Sint8>& out) const     void toXml(Array<Sint8>& out) const
     {     {
         _checkRep();         _checkRep();
         _rep->toXml(out);         _rep->toXml(out);
     }     }
  
     /** method print - prints this method (in CIM encoded form). */      /** print - formats and prints this CIMmethod (in CIM XML encoded form).
       */
     void print(PEGASUS_STD(ostream) &o=PEGASUS_STD(cout)) const     void print(PEGASUS_STD(ostream) &o=PEGASUS_STD(cout)) const
     {     {
         _checkRep();         _checkRep();
         _rep->print(o);         _rep->print(o);
     }     }
  
     /** CIMMethod identical - Returns true if this method is identical to the      /** toMof - puts MOF encoding of this object into out arguemnt.
       */
       void toMof(Array<Sint8>& out) const
       {
           _checkRep();
           _rep->toMof(out);
       }
   
       /** identical - Returns true if this method is identical to the
         one given by the argument x.         one given by the argument x.
     */     */
     Boolean identical(const CIMConstMethod& x) const;     Boolean identical(const CIMConstMethod& x) const;
Line 533 
Line 551 
     friend class CIMMethodRep;     friend class CIMMethodRep;
 }; };
  
   #define PEGASUS_ARRAY_T CIMMethod
   # include "ArrayInter.h"
   #undef PEGASUS_ARRAY_T
   
 PEGASUS_NAMESPACE_END PEGASUS_NAMESPACE_END
  
 #endif /* Pegasus_Method_h */ #endif /* Pegasus_Method_h */

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