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
|
<HTML>
<HEAD>
<TITLE>class AnalogLineGroup</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 AnalogLineGroup</h1>
</TD>
<TD valign="top" align="right" colspan="1">A group of analog lines. <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>::AnalogLineGroup</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__SignallingCircuitGroup.html">TelEngine::SignallingCircuitGroup</A> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__AnalogLineGroup.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 Methods</h4><ul><LI> <b><A HREF="#ref1">AnalogLineGroup</A></b> (AnalogLine::Type type, const char* name, bool slave = false)
</LI>
<LI> <b><A HREF="#ref2">AnalogLineGroup</A></b> (const char* name, AnalogLineGroup* fxo)
</LI>
<LI>virtual <b><A HREF="#ref3">~AnalogLineGroup</A></b> ()
</LI>
<LI>inline AnalogLine::Type <b><A HREF="#ref4">type</A></b> () const
</LI>
<LI>inline ObjList& <b><A HREF="#ref5">lines</A></b> ()
</LI>
<LI>inline AnalogLineGroup* <b><A HREF="#ref6">fxo</A></b> ()
</LI>
<LI>inline bool <b><A HREF="#ref7">slave</A></b> ()
</LI>
<LI>bool <b><A HREF="#ref8">appendLine</A></b> (AnalogLine* line, bool destructOnFail = true)
</LI>
<LI>void <b><A HREF="#ref9">removeLine</A></b> (unsigned int cic)
</LI>
<LI>void <b><A HREF="#ref10">removeLine</A></b> (AnalogLine* line)
</LI>
<LI>AnalogLine* <b><A HREF="#ref11">findLine</A></b> (unsigned int cic)
</LI>
<LI>AnalogLine* <b><A HREF="#ref12">findLine</A></b> (const String& address)
</LI>
<LI>virtual AnalogLineEvent* <b><A HREF="#ref13">getEvent</A></b> (const Time& when)
</LI>
</ul><h4>Protected Methods</h4><ul><LI>virtual void <b><A HREF="#ref14">destroyed</A></b> ()
</LI>
</ul><h4>Protected Members</h4><ul><LI>ObjList <b><A HREF="#ref15">m_lines</A></b></LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
This class is an analog line container.
It may contain another group when used to monitor analog lines
</p>
<A NAME="AnalogLineGroup"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>AnalogLineGroup</strong> (AnalogLine::Type type, const char* name, bool slave = false)
<br></td><td align="right"><h3><strong>AnalogLineGroup</strong></h3></td></tr></table><p></p><p>
Constructor. Construct an analog line group owning single lines
</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">Line type as enumeration
</TD></TR>
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">Name of this component
</TD></TR>
<TR><TD align="left" valign="top"><i>slave</i></TD><TD align="left" valign="top">True if this is an FXO group owned by an FXS one. Ignored if type is not FXO
</TD></TR>
</TABLE></P>
<A NAME="AnalogLineGroup"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>AnalogLineGroup</strong> (const char* name, AnalogLineGroup* fxo)
<br></td><td align="right"><h3><strong>AnalogLineGroup</strong></h3></td></tr></table><p></p><p>
Constructor. Construct an FXS analog line group owning another group of FXO analog lines.
The fxo group is owned by this component and will be destructed if invalid (not FXO type)
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>name</i></TD><TD align="left" valign="top">Name of this component
</TD></TR>
<TR><TD align="left" valign="top"><i>fxo</i></TD><TD align="left" valign="top">The FXO group
</TD></TR>
</TABLE></P>
<A NAME="~AnalogLineGroup"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~AnalogLineGroup</strong> ()
<br></td><td align="right"><h3><strong>~AnalogLineGroup</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Destructor
</p>
<A NAME="type"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline AnalogLine::Type <strong>type</strong> ()
<br></td><td align="right"><h3><strong>type</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get this group's type
</p>
<p><b>Returns</b>: The group's type
</p>
<A NAME="lines"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline ObjList& <strong>lines</strong> ()
<br></td><td align="right"><h3><strong>lines</strong></h3></td></tr></table><p></p><p>
Get the analog lines belonging to this group
</p>
<p><b>Returns</b>: The group's lines list
</p>
<A NAME="fxo"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline AnalogLineGroup* <strong>fxo</strong> ()
<br></td><td align="right"><h3><strong>fxo</strong></h3></td></tr></table><p></p><p>
Get the group holding the FXO lines if present
</p>
<p><b>Returns</b>: The group holding the FXO lines or 0
</p>
<A NAME="slave"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>slave</strong> ()
<br></td><td align="right"><h3><strong>slave</strong></h3></td></tr></table><p></p><p>
Check if this is an FXO group owned by an FXS one
</p>
<p><b>Returns</b>: True if this is an FXO group owned by an FXS one
</p>
<A NAME="appendLine"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>appendLine</strong> (AnalogLine* line, bool destructOnFail = true)
<br></td><td align="right"><h3><strong>appendLine</strong></h3></td></tr></table><p></p><p>
Append a line to this group. Line must have the same type as this group and must be owned by this group
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>line</i></TD><TD align="left" valign="top">The line to append
</TD></TR>
<TR><TD align="left" valign="top"><i>destructOnFail</i></TD><TD align="left" valign="top">Destroy line if failed to append. Defaults to true
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True on success
</p>
<A NAME="removeLine"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>removeLine</strong> (unsigned int cic)
<br></td><td align="right"><h3><strong>removeLine</strong></h3></td></tr></table><p></p><p>
Remove a line from the list and destruct it
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>cic</i></TD><TD align="left" valign="top">The signalling circuit's code used by the line
</TD></TR>
</TABLE></P>
<A NAME="removeLine"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>removeLine</strong> (AnalogLine* line)
<br></td><td align="right"><h3><strong>removeLine</strong></h3></td></tr></table><p></p><p>
Remove a line from the list without destroying it
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>line</i></TD><TD align="left" valign="top">The line to be removed
</TD></TR>
</TABLE></P>
<A NAME="findLine"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>AnalogLine* <strong>findLine</strong> (unsigned int cic)
<br></td><td align="right"><h3><strong>findLine</strong></h3></td></tr></table><p></p><p>
Find a line by its circuit
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>cic</i></TD><TD align="left" valign="top">The signalling circuit's code used by the line
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: AnalogLine pointer or 0 if not found
</p>
<A NAME="findLine"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>AnalogLine* <strong>findLine</strong> (const String& address)
<br></td><td align="right"><h3><strong>findLine</strong></h3></td></tr></table><p></p><p>
Find a line by its address
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>address</i></TD><TD align="left" valign="top">The address of the line
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: AnalogLine pointer or 0 if not found
</p>
<A NAME="getEvent"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td> AnalogLineEvent* <strong>getEvent</strong> (const Time& when)
<br></td><td align="right"><h3><strong>getEvent</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Iterate through the line list to get an event
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>when</i></TD><TD align="left" valign="top">The current time
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: AnalogLineEvent pointer or 0 if no events
</p>
<A NAME="destroyed"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>destroyed</strong> ()
<br></td><td align="right"><h3><strong>destroyed</strong></h3></td></tr></table><p> <small>[protected virtual]</small></p><p>
Remove all lines. Release object
</p>
<p>Reimplemented from <A HREF="TelEngine__SignallingCircuitGroup.html#destroyed">SignallingCircuitGroup</A>.</p>
<A NAME="m_lines"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td>ObjList <strong>m_lines</strong>
</td><td align="right"><h3><strong>m_lines</strong></h3></td></tr></table><p> <small>[protected]</small></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>
|
