xref: /trunk/main/autodoc/inc/ary/idl/i_param.hxx (revision 1c78a5d6)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef ARY_IDL_I_PARAM_HXX
25 #define ARY_IDL_I_PARAM_HXX
26 
27 // BASE CLASSES
28 #include <ary/idl/i_types4idl.hxx>
29 
30 
31 
32 
33 namespace ary
34 {
35 namespace idl
36 {
37 
38 
39 /** Represents a parameter in an IDL function.
40 */
41 class Parameter
42 {
43   public:
44     // LIFECYCLE
45                         Parameter(
46                             const String &      i_sName,
47                             Type_id             i_nType,
48                             E_ParameterDirection
49                                                 i_eDirection );
50                         ~Parameter();
51 
52     // INQUIRY
Name() const53     const String &      Name() const            { return sName; }
Type() const54     Type_id             Type() const            { return nType; }
55     E_ParameterDirection
Direction() const56                         Direction() const       { return eDirection; }
57 
58   private:
59     // DATA
60     String              sName;
61     Type_id             nType;
62     E_ParameterDirection
63                         eDirection;
64 };
65 
66 
67 
68 
69 }   // namespace idl
70 }   // namespace ary
71 #endif
72