blob: 797523b38b2f55f592569435fdc9ec3f5a0e94fe (
plain) (
blame)
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
|
hypertarget{votHandle_8c}{
\section{votHandle.c File Reference}
\label{votHandle_8c}\index{votHandle.c@{votHandle.c}}
}
(Private) Methods to manage interface handles.
{\tt \#include $<$stdio.h$>$}\par
{\tt \#include $<$string.h$>$}\par
{\tt \#include $<$stdlib.h$>$}\par
{\tt \#include \char`\"{}votParseP.h\char`\"{}}\par
\subsection*{Functions}
\begin{CompactItemize}
\item
int \hyperlink{votHandle_8c_e37223a92c5e6a2db9f8ec4ffba1be62}{vot\_\-handleCount} ()
\begin{CompactList}\small\item\em Get the number of handle\_\-t used (private method). \item\end{CompactList}\item
handle\_\-t \hyperlink{votHandle_8c_c29f604e3783afc6becd10d9f93ef600}{vot\_\-lookupHandle} (\hyperlink{structElement}{Element} $\ast$elem)
\begin{CompactList}\small\item\em Lookup the handle\_\-t to an \hyperlink{structElement}{Element} (private method). \item\end{CompactList}\item
handle\_\-t \hyperlink{votHandle_8c_1832eb6023a34c8e9d00d22c57276c6c}{vot\_\-setHandle} (\hyperlink{structElement}{Element} $\ast$elem)
\begin{CompactList}\small\item\em Assign the \hyperlink{structElement}{Element} a handle\_\-t (private method). \item\end{CompactList}\item
void \hyperlink{votHandle_8c_ebec0c91b335d39ddf5c036fc9846974}{vot\_\-freeHandle} (handle\_\-t handle)
\begin{CompactList}\small\item\em Free a handle for use (private method). \item\end{CompactList}\item
\hyperlink{structElement}{Element} $\ast$ \hyperlink{votHandle_8c_8e851db4a4ebff374de075e62026aa7a}{vot\_\-getElement} (handle\_\-t handle)
\begin{CompactList}\small\item\em Get the \hyperlink{structElement}{Element} refered to by handle\_\-t (private method). \item\end{CompactList}\item
void \hyperlink{votHandle_8c_f5544667e19d8d1844be84c1dbabc14f}{vot\_\-handleCleanup} (void)
\begin{CompactList}\small\item\em Free all the handle nodes (private method). \item\end{CompactList}\item
void \hyperlink{votHandle_8c_730838b4724580523ae84c297867a3bd}{vot\_\-newHandleTable} (void)
\begin{CompactList}\small\item\em Initialize a handle table (private method). \item\end{CompactList}\item
void \hyperlink{votHandle_8c_7d29f21f5d0633603e5313f96ea5e75b}{vot\_\-handleError} (char $\ast$msg)
\begin{CompactList}\small\item\em Print an error message. \item\end{CompactList}\end{CompactItemize}
\label{_details}
\hypertarget{_details}{}
\subsection{Detailed Description}
(Private) Methods to manage interface handles.
VOTHANDLE.C -- (Private) Methods to manage interface handles.
\begin{Desc}
\item[Author:]Mike Fitzpatrick and Eric Timmermann \end{Desc}
\begin{Desc}
\item[Date:]8/03/09 \end{Desc}
\subsection{Function Documentation}
\hypertarget{votHandle_8c_ebec0c91b335d39ddf5c036fc9846974}{
\index{votHandle.c@{votHandle.c}!vot\_\-freeHandle@{vot\_\-freeHandle}}
\index{vot\_\-freeHandle@{vot\_\-freeHandle}!votHandle.c@{votHandle.c}}
\subsubsection[{vot\_\-freeHandle}]{\setlength{\rightskip}{0pt plus 5cm}vot\_\-freeHandle (handle\_\-t {\em handle})}}
\label{votHandle_8c_ebec0c91b335d39ddf5c036fc9846974}
Free a handle for use (private method).
vot\_\-freeHandle -- Free a handle for use (private method)
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em handle}]A handle\_\-t to the \hyperlink{structElement}{Element} you wish to free \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]nothing \end{Desc}
\hypertarget{votHandle_8c_8e851db4a4ebff374de075e62026aa7a}{
\index{votHandle.c@{votHandle.c}!vot\_\-getElement@{vot\_\-getElement}}
\index{vot\_\-getElement@{vot\_\-getElement}!votHandle.c@{votHandle.c}}
\subsubsection[{vot\_\-getElement}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Element} $\ast$ vot\_\-getElement (handle\_\-t {\em handle})}}
\label{votHandle_8c_8e851db4a4ebff374de075e62026aa7a}
Get the \hyperlink{structElement}{Element} refered to by handle\_\-t (private method).
vot\_\-getElement -- Get the \hyperlink{structElement}{Element} refered to by handle\_\-t (private method)
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em handle}]A handle\_\-t to the \hyperlink{structElement}{Element}. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]A pointer to the requested \hyperlink{structElement}{Element}. \end{Desc}
\hypertarget{votHandle_8c_f5544667e19d8d1844be84c1dbabc14f}{
\index{votHandle.c@{votHandle.c}!vot\_\-handleCleanup@{vot\_\-handleCleanup}}
\index{vot\_\-handleCleanup@{vot\_\-handleCleanup}!votHandle.c@{votHandle.c}}
\subsubsection[{vot\_\-handleCleanup}]{\setlength{\rightskip}{0pt plus 5cm}vot\_\-handleCleanup (void)}}
\label{votHandle_8c_f5544667e19d8d1844be84c1dbabc14f}
Free all the handle nodes (private method).
vot\_\-handleCleanup -- Free all the handle nodes (private method)
\begin{Desc}
\item[Returns:]nothing \end{Desc}
\hypertarget{votHandle_8c_e37223a92c5e6a2db9f8ec4ffba1be62}{
\index{votHandle.c@{votHandle.c}!vot\_\-handleCount@{vot\_\-handleCount}}
\index{vot\_\-handleCount@{vot\_\-handleCount}!votHandle.c@{votHandle.c}}
\subsubsection[{vot\_\-handleCount}]{\setlength{\rightskip}{0pt plus 5cm}int vot\_\-handleCount (void)}}
\label{votHandle_8c_e37223a92c5e6a2db9f8ec4ffba1be62}
Get the number of handle\_\-t used (private method).
count of current used handles vot\_\-handleCount -- Get the number of handle\_\-t used (private method)
\begin{Desc}
\item[Returns:]The number of handle\_\-t types currently stored \end{Desc}
\hypertarget{votHandle_8c_7d29f21f5d0633603e5313f96ea5e75b}{
\index{votHandle.c@{votHandle.c}!vot\_\-handleError@{vot\_\-handleError}}
\index{vot\_\-handleError@{vot\_\-handleError}!votHandle.c@{votHandle.c}}
\subsubsection[{vot\_\-handleError}]{\setlength{\rightskip}{0pt plus 5cm}vot\_\-handleError (char $\ast$ {\em msg})}}
\label{votHandle_8c_7d29f21f5d0633603e5313f96ea5e75b}
Print an error message.
vot\_\-handleError -- Print an error message.
\begin{Desc}
\item[Returns:]nothing \end{Desc}
\hypertarget{votHandle_8c_c29f604e3783afc6becd10d9f93ef600}{
\index{votHandle.c@{votHandle.c}!vot\_\-lookupHandle@{vot\_\-lookupHandle}}
\index{vot\_\-lookupHandle@{vot\_\-lookupHandle}!votHandle.c@{votHandle.c}}
\subsubsection[{vot\_\-lookupHandle}]{\setlength{\rightskip}{0pt plus 5cm}handle\_\-t vot\_\-lookupHandle ({\bf Element} $\ast$ {\em elem})}}
\label{votHandle_8c_c29f604e3783afc6becd10d9f93ef600}
Lookup the handle\_\-t to an \hyperlink{structElement}{Element} (private method).
vot\_\-lookupHandle -- Lookup the handle\_\-t to an \hyperlink{structElement}{Element} (private method)
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em $\ast$elem}]A pointer to an \hyperlink{structElement}{Element} \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]A handle\_\-t to the \hyperlink{structElement}{Element} \end{Desc}
\hypertarget{votHandle_8c_730838b4724580523ae84c297867a3bd}{
\index{votHandle.c@{votHandle.c}!vot\_\-newHandleTable@{vot\_\-newHandleTable}}
\index{vot\_\-newHandleTable@{vot\_\-newHandleTable}!votHandle.c@{votHandle.c}}
\subsubsection[{vot\_\-newHandleTable}]{\setlength{\rightskip}{0pt plus 5cm}vot\_\-newHandleTable (void)}}
\label{votHandle_8c_730838b4724580523ae84c297867a3bd}
Initialize a handle table (private method).
vot\_\-newHandleTable -- Initialize a handle table (private method)
\begin{Desc}
\item[Returns:]nothing \end{Desc}
\hypertarget{votHandle_8c_1832eb6023a34c8e9d00d22c57276c6c}{
\index{votHandle.c@{votHandle.c}!vot\_\-setHandle@{vot\_\-setHandle}}
\index{vot\_\-setHandle@{vot\_\-setHandle}!votHandle.c@{votHandle.c}}
\subsubsection[{vot\_\-setHandle}]{\setlength{\rightskip}{0pt plus 5cm}handle\_\-t vot\_\-setHandle ({\bf Element} $\ast$ {\em elem})}}
\label{votHandle_8c_1832eb6023a34c8e9d00d22c57276c6c}
Assign the \hyperlink{structElement}{Element} a handle\_\-t (private method).
vot\_\-setHandle -- Assign the \hyperlink{structElement}{Element} a handle\_\-t (private method)
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em elem}]A pointer to an \hyperlink{structElement}{Element} to be assigned a handle\_\-t. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]A handle\_\-t refering to elem \end{Desc}
|
