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
|
<HTML>
<HEAD>
<TITLE>class Array</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 Array</h1>
</TD>
<TD valign="top" align="right" colspan="1">A list based Array. <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>::Array</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="yateclass_h.html">yateclass.h</A>></code></TD></TR>
<TR><TH>Inherits</TH><TD><A HREF="TelEngine__RefObject.html">TelEngine::RefObject</A> <small>[public ]</small></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__Array.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">Array</A></b> (int columns = 0, int rows = 0)
</LI>
<LI>virtual <b><A HREF="#ref2">~Array</A></b> ()
</LI>
<LI>virtual void* <b><A HREF="#ref3">getObject</A></b> (const String& name) const
</LI>
<LI>bool <b><A HREF="#ref4">addRow</A></b> (ObjList* row = 0, int index = -1)
</LI>
<LI>bool <b><A HREF="#ref5">addColumn</A></b> (ObjList* column = 0, int index = -1)
</LI>
<LI>bool <b><A HREF="#ref6">delRow</A></b> (int index)
</LI>
<LI>bool <b><A HREF="#ref7">delColumn</A></b> (int index)
</LI>
<LI>GenObject* <b><A HREF="#ref8">get</A></b> (int column, int row) const
</LI>
<LI>GenObject* <b><A HREF="#ref9">take</A></b> (int column, int row)
</LI>
<LI>bool <b><A HREF="#ref10">set</A></b> (GenObject* obj, int column, int row)
</LI>
<LI>inline int <b><A HREF="#ref11">getRows</A></b> () const
</LI>
<LI>inline int <b><A HREF="#ref12">getColumns</A></b> () const
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
A simple Array class derivated from RefObject
It uses one ObjList to keep the pointers to other ObjList's.
Data is organized in columns - the main ObjList holds pointers to one
ObjList for each column.
This class has been written by Diana
</p>
<A NAME="Array"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>Array</strong> (int columns = 0, int rows = 0)
<br></td><td align="right"><h3><strong>Array</strong></h3></td></tr></table><p></p><p>
Creates a new empty array.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>columns</i></TD><TD align="left" valign="top">Initial number of columns
</TD></TR>
<TR><TD align="left" valign="top"><i>rows</i></TD><TD align="left" valign="top">Initial number of rows
</TD></TR>
</TABLE></P>
<A NAME="~Array"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~Array</strong> ()
<br></td><td align="right"><h3><strong>~Array</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Destructor. Destructs all objects in the array
</p>
<A NAME="getObject"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void* <strong>getObject</strong> (const String& name)
<br></td><td align="right"><h3><strong>getObject</strong></h3></td></tr></table><p> <small>[const virtual]</small></p><p>
Get a pointer to a derived class given that class 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">Name of the class we are asking for
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Pointer to the requested class or NULL if this object doesn't implement it
</p>
<p>Reimplemented from <A HREF="TelEngine__GenObject.html#getObject">GenObject</A>.</p>
<A NAME="addRow"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>addRow</strong> (ObjList* row = 0, int index = -1)
<br></td><td align="right"><h3><strong>addRow</strong></h3></td></tr></table><p></p><p>
Insert a row of objects
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>row</i></TD><TD align="left" valign="top">List of objects to insert or NULL
</TD></TR>
<TR><TD align="left" valign="top"><i>index</i></TD><TD align="left" valign="top">Number of the row to insert before, negative to append
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True for success, false if index was larger than the array
</p>
<A NAME="addColumn"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>addColumn</strong> (ObjList* column = 0, int index = -1)
<br></td><td align="right"><h3><strong>addColumn</strong></h3></td></tr></table><p></p><p>
Insert a column of objects
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>column</i></TD><TD align="left" valign="top">List of objects to insert or NULL
</TD></TR>
<TR><TD align="left" valign="top"><i>index</i></TD><TD align="left" valign="top">Number of the column to insert before, negative to append
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True for success, false if index was larger than the array
</p>
<A NAME="delRow"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>delRow</strong> (int index)
<br></td><td align="right"><h3><strong>delRow</strong></h3></td></tr></table><p></p><p>
Delete an entire row of objects
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>index</i></TD><TD align="left" valign="top">Number of the row to delete
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True for success, false if index was out of bounds
</p>
<A NAME="delColumn"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>delColumn</strong> (int index)
<br></td><td align="right"><h3><strong>delColumn</strong></h3></td></tr></table><p></p><p>
Delete an entire column of objects
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>index</i></TD><TD align="left" valign="top">Number of the column to delete
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True for success, false if index was out of bounds
</p>
<A NAME="get"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td>GenObject* <strong>get</strong> (int column, int row)
<br></td><td align="right"><h3><strong>get</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Retrive an object from the array
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>column</i></TD><TD align="left" valign="top">Number of the column in the array
</TD></TR>
<TR><TD align="left" valign="top"><i>row</i></TD><TD align="left" valign="top">Number of the row in the array
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Pointer to the stored object, NULL for out of bound indexes
</p>
<A NAME="take"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td>GenObject* <strong>take</strong> (int column, int row)
<br></td><td align="right"><h3><strong>take</strong></h3></td></tr></table><p></p><p>
Retrive and remove an object from the array
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>column</i></TD><TD align="left" valign="top">Number of the column in the array
</TD></TR>
<TR><TD align="left" valign="top"><i>row</i></TD><TD align="left" valign="top">Number of the row in the array
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: Pointer to the stored object, NULL for out of bound indexes
</p>
<A NAME="set"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td>bool <strong>set</strong> (GenObject* obj, int column, int row)
<br></td><td align="right"><h3><strong>set</strong></h3></td></tr></table><p></p><p>
Store an object in the array
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>obj</i></TD><TD align="left" valign="top">Object to store in the array
</TD></TR>
<TR><TD align="left" valign="top"><i>column</i></TD><TD align="left" valign="top">Number of the column in the array
</TD></TR>
<TR><TD align="left" valign="top"><i>row</i></TD><TD align="left" valign="top">Number of the row in the array
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: True for success, false if indexes were out of bounds
</p>
<A NAME="getRows"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline int <strong>getRows</strong> ()
<br></td><td align="right"><h3><strong>getRows</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the number of rows in the array
</p>
<p><b>Returns</b>: Total number of rows
</p>
<A NAME="getColumns"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline int <strong>getColumns</strong> ()
<br></td><td align="right"><h3><strong>getColumns</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the number of columns in the array
</p>
<p><b>Returns</b>: Total number of columns
</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>
|
