1orber_tc(3)                Erlang Module Definition                orber_tc(3)
2
3
4

NAME

6       orber_tc - Help functions for IDL typecodes
7

DESCRIPTION

9       This  module contains some functions that gives support in creating IDL
10       typecodes that can be used in for example the any types typecode field.
11       For  the  simple  types it is meaningless to use this API but the func‐
12       tions exist to get the interface complete.
13
14       The type TC used below describes an IDL type and is a  tuple  according
15       to the to the Erlang language mapping.
16

EXPORTS

18       null() -> TC
19       void() -> TC
20       short() -> TC
21       unsigned_short() -> TC
22       long() -> TC
23       unsigned_long() -> TC
24       long_long() -> TC
25       unsigned_long_long() -> TC
26       wchar() -> TC
27       float() -> TC
28       double() -> TC
29       boolean() -> TC
30       char() -> TC
31       octet() -> TC
32       any() -> TC
33       typecode() -> TC
34       principal() -> TC
35
36              These functions return the IDL typecodes for simple types.
37
38       object_reference(Id, Name) -> TC
39
40              Types:
41
42                 Id = string()
43                   the repository ID
44                 Name = string()
45                   the type name of the object
46
47              Function returns the IDL typecode for object_reference.
48
49       struct(Id, Name, ElementList) -> TC
50
51              Types:
52
53                 Id = string()
54                   the repository ID
55                 Name = string()
56                   the type name of the struct
57                 ElementList = [{MemberName, TC}]
58                   a list of the struct elements
59                 MemberName = string()
60                   the element name
61
62              Function returns the IDL typecode for struct.
63
64       union(Id, Name, DiscrTC, Default, ElementList) -> TC
65
66              Types:
67
68                 Id = string()
69                   the repository ID
70                 Name = string()
71                   the type name of the union
72                 DiscrTC = TC
73                   the typecode for the unions discriminant
74                 Default = integer()
75                   a value that indicates which tuple in the element list that
76                   is default (value < 0 means no default)
77                 ElementList = [{Label, MemberName, TC}]
78                   a list of the union elements
79                 Label = term()
80                   the label value should be of the DiscrTCtype
81                 MemberName = string()
82                   the element name
83
84              Function returns the IDL typecode for union.
85
86       enum(Id, Name, ElementList) -> TC
87
88              Types:
89
90                 Id = string()
91                   the repository ID
92                 Name = string()
93                   the type name of the enum
94                 ElementList = [MemberName]
95                   a list of the enums elements
96                 MemberName = string()
97                   the element name
98
99              Function returns the IDL typecode for enum.
100
101       string(Length) -> TC
102
103              Types:
104
105                 Length = integer()
106                   the length of the string (0 means unbounded)
107
108              Function returns the IDL typecode for string.
109
110       wstring(Length) -> TC
111
112              Types:
113
114                 Length = integer()
115                   the length of the wstring (0 means unbounded)
116
117              Function returns the IDL typecode for wstring.
118
119       fixed(Digits, Scale) -> TC
120
121              Types:
122
123                 Digits = Scale = integer()
124                   the digits and scale parameters of a Fixed type
125
126              Function returns the IDL typecode for fixed.
127
128       sequence(ElemTC, Length) -> TC
129
130              Types:
131
132                 ElemTC = TC
133                   the typecode for the sequence elements
134                 Length = integer()
135                   the length of the sequence (0 means unbounded)
136
137              Function returns the IDL typecode for sequence.
138
139       array(ElemTC, Length) -> TC
140
141              Types:
142
143                 ElemTC = TC
144                   the typecode for the array elements
145                 Length = integer()
146                   the length of the array
147
148              Function returns the IDL typecode for array.
149
150       alias(Id, Name, AliasTC) -> TC
151
152              Types:
153
154                 Id = string()
155                   the repository ID
156                 Name = string()
157                   the type name of the alias
158                 AliasTC = TC
159                   the typecode for the type which the alias refer to
160
161              Function returns the IDL typecode for alias.
162
163       exception(Id, Name, ElementList) -> TC
164
165              Types:
166
167                 Id = string()
168                   the repository ID
169                 Name = string()
170                   the type name of the exception
171                 ElementList = [{MemberName, TC}]
172                   a list of the exception elements
173                 MemberName = string()
174                   the element name
175
176              Function returns the IDL typecode for exception.
177
178       get_tc(Object) -> TC
179       get_tc(Id) -> TC
180
181              Types:
182
183                 Object = record()
184                   an IDL specified struct, union or exception
185                 Id = string()
186                   the repository ID
187
188              If the get_tc/1 gets a record that is and IDL specified  struct,
189              union or exception as a parameter it returns the typecode.
190
191              If the parameter is a repository ID it uses the Interface Repos‐
192              itory to get the typecode.
193
194       check_tc(TC) -> boolean()
195
196              Function checks the syntax of an IDL typecode.
197
198
199
200Ericsson AB                       orber 5.0.2                      orber_tc(3)