autodoc/inc/ary/idl/i_param.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: i_param.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef ARY_IDL_I_PARAM_HXX
  32 #define ARY_IDL_I_PARAM_HXX
  33
  34 // BASE CLASSES
  35 #include <ary/idl/i_types4idl.hxx>
  36
  37
  38
  39
  40 namespace ary
  41 {
  42 namespace idl
  43 {
  44
  45
  46 /** Represents a parameter in an IDL function.
  47 */
  48 class Parameter
  49 {
  50   public:
  51     // LIFECYCLE
  52                         Parameter(
  53                             const String &      i_sName,
  54                             Type_id             i_nType,
  55                             E_ParameterDirection
  56                                                 i_eDirection );
  57                         ~Parameter();
  58
  59     // INQUIRY
  60     const String &      Name() const            { return sName; }
  61     Type_id             Type() const            { return nType; }
  62     E_ParameterDirection
  63                         Direction() const       { return eDirection; }
  64
  65   private:
  66     // DATA
  67     String              sName;
  68     Type_id             nType;
  69     E_ParameterDirection
  70                         eDirection;
  71 };
  72
  73
  74
  75
  76 }   // namespace idl
  77 }   // namespace ary
  78 #endif