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