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
|
<HTML>
<HEAD>
<TITLE>class DebugEnabler</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 DebugEnabler</h1>
</TD>
<TD valign="top" align="right" colspan="1">A holder for a debug level. <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>::DebugEnabler</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="yateclass_h.html">yateclass.h</A>></code></TD></TR>
<TR><TH>Inherited by</TH><TD><A HREF="TelEngine__AnalogLineGroup.html">AnalogLineGroup</A>, <i><A HREF="TelEngine__ChanAssistList.html">ChanAssistList</A></i>, <A HREF="TelEngine__Channel.html">Channel</A>, <A HREF="TelEngine__ClientChannel.html">ClientChannel</A>, <i><A HREF="TelEngine__ClientDriver.html">ClientDriver</A></i>, <i><A HREF="TelEngine__Driver.html">Driver</A></i>, <A HREF="TelEngine__ETSIModem.html">ETSIModem</A>, <A HREF="TelEngine__IAXEngine.html">IAXEngine</A>, <A HREF="TelEngine__ISDNIUA.html">ISDNIUA</A>, <i><A HREF="TelEngine__ISDNLayer2.html">ISDNLayer2</A></i>, <i><A HREF="TelEngine__ISDNLayer3.html">ISDNLayer3</A></i>, <A HREF="TelEngine__ISDNQ921.html">ISDNQ921</A>, <A HREF="TelEngine__ISDNQ921.html">ISDNQ921</A>, <A HREF="TelEngine__ISDNQ921Management.html">ISDNQ921Management</A>, <A HREF="TelEngine__ISDNQ921Management.html">ISDNQ921Management</A>, <A HREF="TelEngine__ISDNQ921Management.html">ISDNQ921Management</A>, <A HREF="TelEngine__ISDNQ921Passive.html">ISDNQ921Passive</A>, <A HREF="TelEngine__ISDNQ921Passive.html">ISDNQ921Passive</A>, <A HREF="TelEngine__ISDNQ931.html">ISDNQ931</A>, <A HREF="TelEngine__ISDNQ931Monitor.html">ISDNQ931Monitor</A>, <A HREF="TelEngine__JBEngine.html">JBEngine</A>, <A HREF="TelEngine__JBMessage.html">JBMessage</A>, <A HREF="TelEngine__JBPresence.html">JBPresence</A>, <A HREF="TelEngine__JBService.html">JBService</A>, <A HREF="TelEngine__JGEngine.html">JGEngine</A>, <A HREF="TelEngine__MGCPEngine.html">MGCPEngine</A>, <A HREF="TelEngine__Module.html">Module</A>, <A HREF="TelEngine__SDPParser.html">SDPParser</A>, <i><A HREF="TelEngine__SIGTransport.html">SIGTransport</A></i>, <i><A HREF="TelEngine__SIPEngine.html">SIPEngine</A></i>, <A HREF="TelEngine__SS7ASP.html">SS7ASP</A>, <A HREF="TelEngine__SS7BICC.html">SS7BICC</A>, <A HREF="TelEngine__SS7ISUP.html">SS7ISUP</A>, <i><A HREF="TelEngine__SS7L2User.html">SS7L2User</A></i>, <i><A HREF="TelEngine__SS7L3User.html">SS7L3User</A></i>, <i><A HREF="TelEngine__SS7Layer2.html">SS7Layer2</A></i>, <i><A HREF="TelEngine__SS7Layer3.html">SS7Layer3</A></i>, <A HREF="TelEngine__SS7Layer4.html">SS7Layer4</A>, <A HREF="TelEngine__SS7M2PA.html">SS7M2PA</A>, <A HREF="TelEngine__SS7M2UA.html">SS7M2UA</A>, <A HREF="TelEngine__SS7M3UA.html">SS7M3UA</A>, <A HREF="TelEngine__SS7MTP2.html">SS7MTP2</A>, <A HREF="TelEngine__SS7MTP2.html">SS7MTP2</A>, <A HREF="TelEngine__SS7MTP3.html">SS7MTP3</A>, <A HREF="TelEngine__SS7MTP3.html">SS7MTP3</A>, <A HREF="TelEngine__SS7Maintenance.html">SS7Maintenance</A>, <A HREF="TelEngine__SS7Management.html">SS7Management</A>, <A HREF="TelEngine__SS7Router.html">SS7Router</A>, <A HREF="TelEngine__SS7Router.html">SS7Router</A>, <A HREF="TelEngine__SS7SCCP.html">SS7SCCP</A>, <A HREF="TelEngine__SS7TCAP.html">SS7TCAP</A>, <A HREF="TelEngine__SS7TUP.html">SS7TUP</A>, <A HREF="TelEngine__SignallingCircuitGroup.html">SignallingCircuitGroup</A>, <A HREF="TelEngine__SignallingCircuitSpan.html">SignallingCircuitSpan</A>, <A HREF="TelEngine__SignallingComponent.html">SignallingComponent</A>, <A HREF="TelEngine__SignallingEngine.html">SignallingEngine</A>, <i><A HREF="TelEngine__SignallingInterface.html">SignallingInterface</A></i>, <i><A HREF="TelEngine__SignallingReceiver.html">SignallingReceiver</A></i>, <A HREF="TelEngine__UART.html">UART</A></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__DebugEnabler.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>inline <b><A HREF="#ref1">DebugEnabler</A></b> (int level = <A HREF="TelEngine.html#debugLevel">TelEngine::debugLevel</A>(), bool enabled = true)
</LI>
<LI>inline <b><A HREF="#ref2">~DebugEnabler</A></b> ()
</LI>
<LI>inline int <b><A HREF="#ref3">debugLevel</A></b> () const
</LI>
<LI>int <b><A HREF="#ref4">debugLevel</A></b> (int level)
</LI>
<LI>inline bool <b><A HREF="#ref5">debugEnabled</A></b> () const
</LI>
<LI>inline void <b><A HREF="#ref6">debugEnabled</A></b> (bool enable)
</LI>
<LI>inline const char* <b><A HREF="#ref7">debugName</A></b> () const
</LI>
<LI>bool <b><A HREF="#ref8">debugAt</A></b> (int level) const
</LI>
<LI>inline bool <b><A HREF="#ref9">debugChained</A></b> () const
</LI>
<LI>inline void <b><A HREF="#ref10">debugChain</A></b> (const DebugEnabler* chain = 0)
</LI>
<LI>void <b><A HREF="#ref11">debugCopy</A></b> (const DebugEnabler* original = 0)
</LI>
</ul><h4>Protected Methods</h4><ul><LI>inline void <b><A HREF="#ref12">debugName</A></b> (const char* name)
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
Holds a local debugging level that can be modified separately from the
global debugging
</p>
<A NAME="DebugEnabler"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <strong>DebugEnabler</strong> (int level = <A HREF="TelEngine.html#debugLevel">TelEngine::debugLevel</A>(), bool enabled = true)
<br></td><td align="right"><h3><strong>DebugEnabler</strong></h3></td></tr></table><p></p><p>
Constructor
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>level</i></TD><TD align="left" valign="top">The initial local debug level
</TD></TR>
<TR><TD align="left" valign="top"><i>enabled</i></TD><TD align="left" valign="top">Enable debugging on this object
</TD></TR>
</TABLE></P>
<A NAME="~DebugEnabler"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <strong>~DebugEnabler</strong> ()
<br></td><td align="right"><h3><strong>~DebugEnabler</strong></h3></td></tr></table><p></p><A NAME="debugLevel"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline int <strong>debugLevel</strong> ()
<br></td><td align="right"><h3><strong>debugLevel</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Retrive the current local debug level
</p>
<p><b>Returns</b>: The current local debug level
</p>
<A NAME="debugLevel"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td>int <strong>debugLevel</strong> (int level)
<br></td><td align="right"><h3><strong>debugLevel</strong></h3></td></tr></table><p></p><p>
Set the current local debug level.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>level</i></TD><TD align="left" valign="top">The desired debug level
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: The new debug level (may be different)
</p>
<A NAME="debugEnabled"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>debugEnabled</strong> ()
<br></td><td align="right"><h3><strong>debugEnabled</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Retrive the current debug activation status
</p>
<p><b>Returns</b>: True if local debugging is enabled
</p>
<A NAME="debugEnabled"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>debugEnabled</strong> (bool enable)
<br></td><td align="right"><h3><strong>debugEnabled</strong></h3></td></tr></table><p></p><p>
Set the current debug activation status
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>enable</i></TD><TD align="left" valign="top">The new debug activation status, true to enable
</TD></TR>
</TABLE></P>
<A NAME="debugName"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const char* <strong>debugName</strong> ()
<br></td><td align="right"><h3><strong>debugName</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the current debug name
</p>
<p><b>Returns</b>: Name of the debug activation if set or NULL
</p>
<A NAME="debugAt"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>debugAt</strong> (int level)
<br></td><td align="right"><h3><strong>debugAt</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if debugging output should be generated
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>level</i></TD><TD align="left" valign="top">The debug level we are testing
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True if messages should be output, false otherwise
</p>
<A NAME="debugChained"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>debugChained</strong> ()
<br></td><td align="right"><h3><strong>debugChained</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Check if this enabler is chained to another one
</p>
<p><b>Returns</b>: True if local debugging is chained to other enabler
</p>
<A NAME="debugChain"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>debugChain</strong> (const DebugEnabler* chain = 0)
<br></td><td align="right"><h3><strong>debugChain</strong></h3></td></tr></table><p></p><p>
Chain this debug holder to a parent or detach from existing one
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>chain</i></TD><TD align="left" valign="top">Pointer to parent debug level, NULL to detach
</TD></TR>
</TABLE></P>
<A NAME="debugCopy"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>debugCopy</strong> (const DebugEnabler* original = 0)
<br></td><td align="right"><h3><strong>debugCopy</strong></h3></td></tr></table><p></p><p>
Copy debug settings from another object or from engine globals
</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">Pointer to a DebugEnabler to copy settings from
</TD></TR>
</TABLE></P>
<A NAME="debugName"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>debugName</strong> (const char* name)
<br></td><td align="right"><h3><strong>debugName</strong></h3></td></tr></table><p> <small>[protected]</small></p><p>
Set the current debug name
</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">Static debug name or NULL
</TD></TR>
</TABLE></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>
|
