1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
|
<HTML>
<HEAD>
<TITLE>class SS7PointCode</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>class SS7PointCode</h1>
</TD>
<TD valign="top" align="right" colspan="1">SS7 Code Point. <small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH>Full name</TH><TD><code><A HREF="TelEngine.html">TelEngine</A>::SS7PointCode</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="libs___ysig___yatesig_h.html">libs/ysig/yatesig.h</A>></code></TD></TR>
<TR><TH>Inherits</TH><TD><A HREF="TelEngine__GenObject.html">TelEngine::GenObject</A> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__SS7PointCode.html">List of all Methods</A></TH></TR>
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h4>Public Types</h4><ul><LI>enum <A HREF="#ref1">Type</A> { Other = 0,
ITU = 1,
ANSI = 2,
ANSI8 = 3,
China = 4,
Japan = 5,
Japan5 = 6,
DefinedTypes
}
</LI>
</ul><h4>Public Methods</h4><ul><LI>inline <b><A HREF="#ref2">SS7PointCode</A></b> (unsigned char network = 0, unsigned char cluster = 0, unsigned char member = 0)
</LI>
<LI>inline <b><A HREF="#ref3">SS7PointCode</A></b> (Type type, unsigned int packed)
</LI>
<LI>inline <b><A HREF="#ref4">SS7PointCode</A></b> (const SS7PointCode& original)
</LI>
<LI>inline <b><A HREF="#ref5">~SS7PointCode</A></b> ()
</LI>
<LI>inline unsigned char <b><A HREF="#ref6">network</A></b> () const
</LI>
<LI>inline unsigned char <b><A HREF="#ref7">cluster</A></b> () const
</LI>
<LI>inline unsigned char <b><A HREF="#ref8">member</A></b> () const
</LI>
<LI>inline void <b><A HREF="#ref9">assign</A></b> (unsigned char network, unsigned char cluster, unsigned char member)
</LI>
<LI>bool <b><A HREF="#ref10">assign</A></b> (const String& src, Type type = Other)
</LI>
<LI>bool <b><A HREF="#ref11">assign</A></b> (Type type, const unsigned char* src, int len = -1, unsigned char* spare = 0)
</LI>
<LI>inline SS7PointCode& <b><A HREF="#ref12">operator=</A></b> (const SS7PointCode& original)
</LI>
<LI>inline bool <b><A HREF="#ref13">operator==</A></b> (const SS7PointCode& original) const
</LI>
<LI>bool <b><A HREF="#ref14">compatible</A></b> (Type type) const
</LI>
<LI>unsigned int <b><A HREF="#ref15">pack</A></b> (Type type) const
</LI>
<LI>bool <b><A HREF="#ref16">unpack</A></b> (Type type, unsigned int packed)
</LI>
<LI>bool <b><A HREF="#ref17">store</A></b> (Type type, unsigned char* dest, unsigned char spare = 0) const
</LI>
</ul><h4>Public Static Methods</h4><ul><LI>static unsigned char <b><A HREF="#ref18">size</A></b> (Type type)
</LI>
<LI>static unsigned char <b><A HREF="#ref19">length</A></b> (Type type)
</LI>
<LI>static Type <b><A HREF="#ref20">lookup</A></b> (const char* text)
</LI>
<LI>static const char* <b><A HREF="#ref21">lookup</A></b> (Type type)
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
An universal SS7 Layer 3 routing Code Point
</p>
<A NAME="Type"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td>enum <strong>Type</strong> { Other = 0,
ITU = 1,
ANSI = 2,
ANSI8 = 3,
China = 4,
Japan = 5,
Japan5 = 6,
DefinedTypes
}
</td><td align="right"><h3><strong>Type</strong></h3></td></tr></table><p></p><p>
Different incompatible types of points codes
</p>
<A NAME="SS7PointCode"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <strong>SS7PointCode</strong> (unsigned char network = 0, unsigned char cluster = 0, unsigned char member = 0)
<br></td><td align="right"><h3><strong>SS7PointCode</strong></h3></td></tr></table><p></p><p>
Constructor from components
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>network</i></TD><TD align="left" valign="top">ANSI Network Identifier / ITU-T Zone Identification
</TD></TR>
<TR><TD align="left" valign="top"><i>cluster</i></TD><TD align="left" valign="top">ANSI Network Cluster / ITU-T Area/Network Identification
</TD></TR>
<TR><TD align="left" valign="top"><i>member</i></TD><TD align="left" valign="top">ANSI Cluster Member / ITU-T Signalling Point Identification
</TD></TR>
</TABLE></P>
<A NAME="SS7PointCode"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <strong>SS7PointCode</strong> (Type type, unsigned int packed)
<br></td><td align="right"><h3><strong>SS7PointCode</strong></h3></td></tr></table><p></p><p>
Constructor from unpacked format
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>type</i></TD><TD align="left" valign="top">Type of the unpacking desired
</TD></TR>
<TR><TD align="left" valign="top"><i>packed</i></TD><TD align="left" valign="top">Packed format of the point code
</TD></TR>
</TABLE></P>
<A NAME="SS7PointCode"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <strong>SS7PointCode</strong> (const SS7PointCode& original)
<br></td><td align="right"><h3><strong>SS7PointCode</strong></h3></td></tr></table><p></p><p>
Copy constructor
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>original</i></TD><TD align="left" valign="top">Code point to be copied
</TD></TR>
</TABLE></P>
<A NAME="~SS7PointCode"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <strong>~SS7PointCode</strong> ()
<br></td><td align="right"><h3><strong>~SS7PointCode</strong></h3></td></tr></table><p></p><p>
Destructor
</p>
<A NAME="network"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline unsigned char <strong>network</strong> ()
<br></td><td align="right"><h3><strong>network</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Retrive the Network / Zone component of the Code Point
</p>
<p><b>Returns</b>: ANSI Network Identifier / ITU-T Zone Identification
</p>
<A NAME="cluster"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline unsigned char <strong>cluster</strong> ()
<br></td><td align="right"><h3><strong>cluster</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Retrive the Cluster / Area component of the Code Point
</p>
<p><b>Returns</b>: ANSI Network Cluster / ITU-T Area/Network Identification
</p>
<A NAME="member"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline unsigned char <strong>member</strong> ()
<br></td><td align="right"><h3><strong>member</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Retrive the Cluster / Point component of the Code Point
</p>
<p><b>Returns</b>: ANSI Cluster Member / ITU-T Signalling Point Identification
</p>
<A NAME="assign"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>assign</strong> (unsigned char network, unsigned char cluster, unsigned char member)
<br></td><td align="right"><h3><strong>assign</strong></h3></td></tr></table><p></p><p>
Assignment from components
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>network</i></TD><TD align="left" valign="top">ANSI Network Identifier / ITU-T Zone Identification
</TD></TR>
<TR><TD align="left" valign="top"><i>cluster</i></TD><TD align="left" valign="top">ANSI Network Cluster / ITU-T Area/Network Identification
</TD></TR>
<TR><TD align="left" valign="top"><i>member</i></TD><TD align="left" valign="top">ANSI Cluster Member / ITU-T Signalling Point Identification
</TD></TR>
</TABLE></P>
<A NAME="assign"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>assign</strong> (const String& src, Type type = Other)
<br></td><td align="right"><h3><strong>assign</strong></h3></td></tr></table><p></p><p>
Assign data members from a given string of form 'network-cluster-member'
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>src</i></TD><TD align="left" valign="top">Source string
</TD></TR>
<TR><TD align="left" valign="top"><i>type</i></TD><TD align="left" valign="top">Type of the point code if numeric (packed) representation is used
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: False if the string has incorrect format or individual elements are not in the range 0..255
</p>
<A NAME="assign"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>assign</strong> (Type type, const unsigned char* src, int len = -1, unsigned char* spare = 0)
<br></td><td align="right"><h3><strong>assign</strong></h3></td></tr></table><p></p><p>
Assign data members from a packed memory block
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>type</i></TD><TD align="left" valign="top">Type of the point code in memory
</TD></TR>
<TR><TD align="left" valign="top"><i>src</i></TD><TD align="left" valign="top">Pointer to packed point code in memory
</TD></TR>
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">Length of data, negative to not check validity
</TD></TR>
<TR><TD align="left" valign="top"><i>spare</i></TD><TD align="left" valign="top">Pointer to variable to save spare bits, NULL to ignore them
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if success, false if invalid type or memory area
</p>
<A NAME="operator="></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline SS7PointCode& <strong>operator=</strong> (const SS7PointCode& original)
<br></td><td align="right"><h3><strong>operator=</strong></h3></td></tr></table><p></p><p>
Assignment operator
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>original</i></TD><TD align="left" valign="top">Code point to be copied
</TD></TR>
</TABLE></P>
<A NAME="operator=="></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>operator==</strong> (const SS7PointCode& original)
<br></td><td align="right"><h3><strong>operator==</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Equality operator
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>original</i></TD><TD align="left" valign="top">Code point to be compared with
</TD></TR>
</TABLE></P>
<A NAME="compatible"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>compatible</strong> (Type type)
<br></td><td align="right"><h3><strong>compatible</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if the point code is compatible with a packing type
</p>
<p><b>Returns</b>: True if the Network and Member fit in the packing format
</p>
<A NAME="pack"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td>unsigned int <strong>pack</strong> (Type type)
<br></td><td align="right"><h3><strong>pack</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Pack the code point into a single integer number.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>type</i></TD><TD align="left" valign="top">Type of the packing desired
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Compact code point as integer or zero if the packing type is not supported
</p>
<A NAME="unpack"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>unpack</strong> (Type type, unsigned int packed)
<br></td><td align="right"><h3><strong>unpack</strong></h3></td></tr></table><p></p><p>
Unpack an integer number into a point code
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>type</i></TD><TD align="left" valign="top">Type of the unpacking desired
</TD></TR>
<TR><TD align="left" valign="top"><i>packed</i></TD><TD align="left" valign="top">Packed format of the point code
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the unpacking succeeded and the point code was updated
</p>
<A NAME="store"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>store</strong> (Type type, unsigned char* dest, unsigned char spare = 0)
<br></td><td align="right"><h3><strong>store</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Store the point code in a memory area
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>type</i></TD><TD align="left" valign="top">Type of the packing desired
</TD></TR>
<TR><TD align="left" valign="top"><i>dest</i></TD><TD align="left" valign="top">Location to store the label info, must be at least length() long
</TD></TR>
<TR><TD align="left" valign="top"><i>spare</i></TD><TD align="left" valign="top">Spare bits to store after the point code if applicable (ITU)
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if the unpacking succeeded and the memory was updated
</p>
<A NAME="size"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td> unsigned char <strong>size</strong> (Type type)
<br></td><td align="right"><h3><strong>size</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Get the size (in bits) of a packed code point according to its type
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>type</i></TD><TD align="left" valign="top">Type of the packing
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Number of bits required to represent the code point, zero if unknown
</p>
<A NAME="length"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td> unsigned char <strong>length</strong> (Type type)
<br></td><td align="right"><h3><strong>length</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Get the length (in octets) of a packed code point according to its type
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>type</i></TD><TD align="left" valign="top">Type of the packing
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Number of octets required to represent the code point, zero if unknown
</p>
<A NAME="lookup"></A><A NAME="ref20"></A><table width="100%"><tr bgcolor="#eeeeee"><td> Type <strong>lookup</strong> (const char* text)
<br></td><td align="right"><h3><strong>lookup</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Get a point type associated to a given text
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>text</i></TD><TD align="left" valign="top">Text to find
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Point code type as enumeration
</p>
<A NAME="lookup"></A><A NAME="ref21"></A><table width="100%"><tr bgcolor="#eeeeee"><td> const char* <strong>lookup</strong> (Type type)
<br></td><td align="right"><h3><strong>lookup</strong></h3></td></tr></table><p> <small>[static]</small></p><p>
Get the text associated to a point type
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>type</i></TD><TD align="left" valign="top">Type to find
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: The requested text or 0 if not found
</p>
<HR>
<table>
<tr><td><small>Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54.</small></td></tr>
</table>
</BODY>
</HTML>
|
