ia64/xen-unstable

changeset 12161:cdd926419883

New PIF class.

Signed-off-by: Ewan Mellor <ewan@xensource.com>
author Ewan Mellor <ewan@xensource.com>
date Thu Oct 26 15:47:46 2006 +0100 (2006-10-26)
parents 84fe4d413d59
children ea32c4e70a8b
files docs/xen-api/xenapi-datamodel.tex
line diff
     1.1 --- a/docs/xen-api/xenapi-datamodel.tex	Thu Oct 26 15:46:46 2006 +0100
     1.2 +++ b/docs/xen-api/xenapi-datamodel.tex	Thu Oct 26 15:47:46 2006 +0100
     1.3 @@ -29,6 +29,7 @@ Name & Description \\
     1.4  {\tt host\_cpu} & A physical CPU \\
     1.5  {\tt network} & A virtual network \\
     1.6  {\tt VIF} & A virtual network interface \\
     1.7 +{\tt PIF} & A physical network interface (note separate VLANs are represented as several PIFs) \\
     1.8  {\tt SR} & A storage repository \\
     1.9  {\tt VDI} & A virtual disk image \\
    1.10  {\tt VBD} & A virtual block device \\
    1.11 @@ -49,6 +50,8 @@ VDI.parent & VDI.children & one-to-many\
    1.12  VBD.VM & VM.VBDs & one-to-many\\
    1.13  VIF.VM & VM.VIFs & one-to-many\\
    1.14  VIF.network & network.VIFs & one-to-many\\
    1.15 +PIF.host & host.PIFs & one-to-many\\
    1.16 +PIF.network & network.PIFs & one-to-many\\
    1.17  SR.VDIs & VDI.SR & many-to-one\\
    1.18  VTPM.VM & VM.VTPMs & one-to-many\\
    1.19  host.resident\_VMs & VM.resident\_on & many-to-one\\
    1.20 @@ -3921,6 +3924,7 @@ Quals & Field & Type & Description \\
    1.21  $\mathit{RW}$ &  {\tt name/description} & string & a notes field containg human-readable description \\
    1.22  $\mathit{RO}_\mathit{run}$ &  {\tt software\_version} & (string $\rightarrow$ string) Map & version strings \\
    1.23  $\mathit{RO}_\mathit{run}$ &  {\tt resident\_VMs} & (VM ref) Set & list of VMs currently resident on host \\
    1.24 +$\mathit{RO}_\mathit{run}$ &  {\tt PIFs} & (PIF ref) Set & physical network interfaces \\
    1.25  $\mathit{RO}_\mathit{run}$ &  {\tt host\_CPUs} & (host\_cpu ref) Set & The physical CPUs on this host \\
    1.26  \hline
    1.27  \end{longtable}
    1.28 @@ -4302,6 +4306,38 @@ value of the field
    1.29  \vspace{0.3cm}
    1.30  \vspace{0.3cm}
    1.31  \vspace{0.3cm}
    1.32 +\subsubsection{RPC name:~get\_PIFs}
    1.33 +
    1.34 +{\bf Overview:} 
    1.35 +get accessor message derived from field PIFs of object host
    1.36 +
    1.37 + \noindent {\bf Signature:} 
    1.38 +\begin{verbatim} ((PIF ref) Set) get_PIFs (session_id s, host ref self)\end{verbatim}
    1.39 +
    1.40 +
    1.41 +\noindent{\bf Arguments:}
    1.42 +
    1.43 + 
    1.44 +\vspace{0.3cm}
    1.45 +\begin{tabular}{|c|c|p{7cm}|}
    1.46 + \hline
    1.47 +{\bf type} & {\bf name} & {\bf description} \\ \hline
    1.48 +{\tt host ref } & self & object instance \\ \hline 
    1.49 +
    1.50 +\end{tabular}
    1.51 +
    1.52 +\vspace{0.3cm}
    1.53 +
    1.54 + \noindent {\bf Return Type:} 
    1.55 +{\tt 
    1.56 +(PIF ref) Set
    1.57 +}
    1.58 +
    1.59 +
    1.60 +value of the field
    1.61 +\vspace{0.3cm}
    1.62 +\vspace{0.3cm}
    1.63 +\vspace{0.3cm}
    1.64  \subsubsection{RPC name:~get\_host\_CPUs}
    1.65  
    1.66  {\bf Overview:} 
    1.67 @@ -4860,6 +4896,7 @@ Quals & Field & Type & Description \\
    1.68  $\mathit{RW}$ &  {\tt name/label} & string & a human-readable name \\
    1.69  $\mathit{RW}$ &  {\tt name/description} & string & a notes field containg human-readable description \\
    1.70  $\mathit{RO}_\mathit{run}$ &  {\tt VIFs} & (VIF ref) Set & list of connected vifs \\
    1.71 +$\mathit{RO}_\mathit{run}$ &  {\tt PIFs} & (PIF ref) Set & list of connected pifs \\
    1.72  $\mathit{RW}$ &  {\tt default\_gateway} & string & default gateway IP address. Used for auto-configuring guests with fixed IP setting \\
    1.73  $\mathit{RW}$ &  {\tt default\_netmask} & string & default netmask. Used for auto-configuring guests with fixed IP setting \\
    1.74  \hline
    1.75 @@ -5082,6 +5119,38 @@ value of the field
    1.76  \vspace{0.3cm}
    1.77  \vspace{0.3cm}
    1.78  \vspace{0.3cm}
    1.79 +\subsubsection{RPC name:~get\_PIFs}
    1.80 +
    1.81 +{\bf Overview:} 
    1.82 +get accessor message derived from field PIFs of object network
    1.83 +
    1.84 + \noindent {\bf Signature:} 
    1.85 +\begin{verbatim} ((PIF ref) Set) get_PIFs (session_id s, network ref self)\end{verbatim}
    1.86 +
    1.87 +
    1.88 +\noindent{\bf Arguments:}
    1.89 +
    1.90 + 
    1.91 +\vspace{0.3cm}
    1.92 +\begin{tabular}{|c|c|p{7cm}|}
    1.93 + \hline
    1.94 +{\bf type} & {\bf name} & {\bf description} \\ \hline
    1.95 +{\tt network ref } & self & object instance \\ \hline 
    1.96 +
    1.97 +\end{tabular}
    1.98 +
    1.99 +\vspace{0.3cm}
   1.100 +
   1.101 + \noindent {\bf Return Type:} 
   1.102 +{\tt 
   1.103 +(PIF ref) Set
   1.104 +}
   1.105 +
   1.106 +
   1.107 +value of the field
   1.108 +\vspace{0.3cm}
   1.109 +\vspace{0.3cm}
   1.110 +\vspace{0.3cm}
   1.111  \subsubsection{RPC name:~get\_default\_gateway}
   1.112  
   1.113  {\bf Overview:} 
   1.114 @@ -6130,6 +6199,671 @@ references to all objects
   1.115  
   1.116  \vspace{1cm}
   1.117  \newpage
   1.118 +\section{Class: PIF}
   1.119 +\subsection{Fields for class: PIF}
   1.120 +\begin{longtable}{|lllp{0.38\textwidth}|}
   1.121 +\hline
   1.122 +\multicolumn{1}{|l}{Name} & \multicolumn{3}{l|}{\bf PIF} \\
   1.123 +\multicolumn{1}{|l}{Description} & \multicolumn{3}{l|}{\parbox{11cm}{\em A physical network interface (note separate VLANs are represented as several PIFs)}} \\
   1.124 +\hline
   1.125 +Quals & Field & Type & Description \\
   1.126 +\hline
   1.127 +$\mathit{RO}_\mathit{run}$ &  {\tt uuid} & string & unique identifier/object reference \\
   1.128 +$\mathit{RW}$ &  {\tt name} & string & human-readable name of the interface \\
   1.129 +$\mathit{RW}$ &  {\tt network} & network ref & virtual network to which this pif is connected \\
   1.130 +$\mathit{RW}$ &  {\tt host} & host ref & physical machine to which this pif is connected \\
   1.131 +$\mathit{RW}$ &  {\tt MAC} & string & ethernet MAC address of physical interface \\
   1.132 +$\mathit{RW}$ &  {\tt MTU} & int & MTU in octets \\
   1.133 +$\mathit{RW}$ &  {\tt VLAN} & string & VLAN tag for all traffic passing through this interface \\
   1.134 +$\mathit{RO}_\mathit{run}$ &  {\tt io/read\_kbs} & float & Read bandwidth (KiB/s) \\
   1.135 +$\mathit{RO}_\mathit{run}$ &  {\tt io/write\_kbs} & float & Write bandwidth (KiB/s) \\
   1.136 +\hline
   1.137 +\end{longtable}
   1.138 +\subsection{Additional RPCs associated with class: PIF}
   1.139 +\subsubsection{RPC name:~get\_uuid}
   1.140 +
   1.141 +{\bf Overview:} 
   1.142 +get accessor message derived from field uuid of object PIF
   1.143 +
   1.144 + \noindent {\bf Signature:} 
   1.145 +\begin{verbatim} string get_uuid (session_id s, PIF ref self)\end{verbatim}
   1.146 +
   1.147 +
   1.148 +\noindent{\bf Arguments:}
   1.149 +
   1.150 + 
   1.151 +\vspace{0.3cm}
   1.152 +\begin{tabular}{|c|c|p{7cm}|}
   1.153 + \hline
   1.154 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.155 +{\tt PIF ref } & self & object instance \\ \hline 
   1.156 +
   1.157 +\end{tabular}
   1.158 +
   1.159 +\vspace{0.3cm}
   1.160 +
   1.161 + \noindent {\bf Return Type:} 
   1.162 +{\tt 
   1.163 +string
   1.164 +}
   1.165 +
   1.166 +
   1.167 +value of the field
   1.168 +\vspace{0.3cm}
   1.169 +\vspace{0.3cm}
   1.170 +\vspace{0.3cm}
   1.171 +\subsubsection{RPC name:~get\_name}
   1.172 +
   1.173 +{\bf Overview:} 
   1.174 +get accessor message derived from field name of object PIF
   1.175 +
   1.176 + \noindent {\bf Signature:} 
   1.177 +\begin{verbatim} string get_name (session_id s, PIF ref self)\end{verbatim}
   1.178 +
   1.179 +
   1.180 +\noindent{\bf Arguments:}
   1.181 +
   1.182 + 
   1.183 +\vspace{0.3cm}
   1.184 +\begin{tabular}{|c|c|p{7cm}|}
   1.185 + \hline
   1.186 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.187 +{\tt PIF ref } & self & object instance \\ \hline 
   1.188 +
   1.189 +\end{tabular}
   1.190 +
   1.191 +\vspace{0.3cm}
   1.192 +
   1.193 + \noindent {\bf Return Type:} 
   1.194 +{\tt 
   1.195 +string
   1.196 +}
   1.197 +
   1.198 +
   1.199 +value of the field
   1.200 +\vspace{0.3cm}
   1.201 +\vspace{0.3cm}
   1.202 +\vspace{0.3cm}
   1.203 +\subsubsection{RPC name:~set\_name}
   1.204 +
   1.205 +{\bf Overview:} 
   1.206 +set accessor message derived from field name of object PIF
   1.207 +
   1.208 + \noindent {\bf Signature:} 
   1.209 +\begin{verbatim} void set_name (session_id s, PIF ref self, string value)\end{verbatim}
   1.210 +
   1.211 +
   1.212 +\noindent{\bf Arguments:}
   1.213 +
   1.214 + 
   1.215 +\vspace{0.3cm}
   1.216 +\begin{tabular}{|c|c|p{7cm}|}
   1.217 + \hline
   1.218 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.219 +{\tt PIF ref } & self & object instance \\ \hline 
   1.220 +
   1.221 +{\tt string } & value & New value to set \\ \hline 
   1.222 +
   1.223 +\end{tabular}
   1.224 +
   1.225 +\vspace{0.3cm}
   1.226 +
   1.227 + \noindent {\bf Return Type:} 
   1.228 +{\tt 
   1.229 +void
   1.230 +}
   1.231 +
   1.232 +
   1.233 +
   1.234 +\vspace{0.3cm}
   1.235 +\vspace{0.3cm}
   1.236 +\vspace{0.3cm}
   1.237 +\subsubsection{RPC name:~get\_network}
   1.238 +
   1.239 +{\bf Overview:} 
   1.240 +get accessor message derived from field network of object PIF
   1.241 +
   1.242 + \noindent {\bf Signature:} 
   1.243 +\begin{verbatim} (network ref) get_network (session_id s, PIF ref self)\end{verbatim}
   1.244 +
   1.245 +
   1.246 +\noindent{\bf Arguments:}
   1.247 +
   1.248 + 
   1.249 +\vspace{0.3cm}
   1.250 +\begin{tabular}{|c|c|p{7cm}|}
   1.251 + \hline
   1.252 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.253 +{\tt PIF ref } & self & object instance \\ \hline 
   1.254 +
   1.255 +\end{tabular}
   1.256 +
   1.257 +\vspace{0.3cm}
   1.258 +
   1.259 + \noindent {\bf Return Type:} 
   1.260 +{\tt 
   1.261 +network ref
   1.262 +}
   1.263 +
   1.264 +
   1.265 +value of the field
   1.266 +\vspace{0.3cm}
   1.267 +\vspace{0.3cm}
   1.268 +\vspace{0.3cm}
   1.269 +\subsubsection{RPC name:~set\_network}
   1.270 +
   1.271 +{\bf Overview:} 
   1.272 +set accessor message derived from field network of object PIF
   1.273 +
   1.274 + \noindent {\bf Signature:} 
   1.275 +\begin{verbatim} void set_network (session_id s, PIF ref self, network ref value)\end{verbatim}
   1.276 +
   1.277 +
   1.278 +\noindent{\bf Arguments:}
   1.279 +
   1.280 + 
   1.281 +\vspace{0.3cm}
   1.282 +\begin{tabular}{|c|c|p{7cm}|}
   1.283 + \hline
   1.284 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.285 +{\tt PIF ref } & self & object instance \\ \hline 
   1.286 +
   1.287 +{\tt network ref } & value & New value to set \\ \hline 
   1.288 +
   1.289 +\end{tabular}
   1.290 +
   1.291 +\vspace{0.3cm}
   1.292 +
   1.293 + \noindent {\bf Return Type:} 
   1.294 +{\tt 
   1.295 +void
   1.296 +}
   1.297 +
   1.298 +
   1.299 +
   1.300 +\vspace{0.3cm}
   1.301 +\vspace{0.3cm}
   1.302 +\vspace{0.3cm}
   1.303 +\subsubsection{RPC name:~get\_host}
   1.304 +
   1.305 +{\bf Overview:} 
   1.306 +get accessor message derived from field host of object PIF
   1.307 +
   1.308 + \noindent {\bf Signature:} 
   1.309 +\begin{verbatim} (host ref) get_host (session_id s, PIF ref self)\end{verbatim}
   1.310 +
   1.311 +
   1.312 +\noindent{\bf Arguments:}
   1.313 +
   1.314 + 
   1.315 +\vspace{0.3cm}
   1.316 +\begin{tabular}{|c|c|p{7cm}|}
   1.317 + \hline
   1.318 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.319 +{\tt PIF ref } & self & object instance \\ \hline 
   1.320 +
   1.321 +\end{tabular}
   1.322 +
   1.323 +\vspace{0.3cm}
   1.324 +
   1.325 + \noindent {\bf Return Type:} 
   1.326 +{\tt 
   1.327 +host ref
   1.328 +}
   1.329 +
   1.330 +
   1.331 +value of the field
   1.332 +\vspace{0.3cm}
   1.333 +\vspace{0.3cm}
   1.334 +\vspace{0.3cm}
   1.335 +\subsubsection{RPC name:~set\_host}
   1.336 +
   1.337 +{\bf Overview:} 
   1.338 +set accessor message derived from field host of object PIF
   1.339 +
   1.340 + \noindent {\bf Signature:} 
   1.341 +\begin{verbatim} void set_host (session_id s, PIF ref self, host ref value)\end{verbatim}
   1.342 +
   1.343 +
   1.344 +\noindent{\bf Arguments:}
   1.345 +
   1.346 + 
   1.347 +\vspace{0.3cm}
   1.348 +\begin{tabular}{|c|c|p{7cm}|}
   1.349 + \hline
   1.350 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.351 +{\tt PIF ref } & self & object instance \\ \hline 
   1.352 +
   1.353 +{\tt host ref } & value & New value to set \\ \hline 
   1.354 +
   1.355 +\end{tabular}
   1.356 +
   1.357 +\vspace{0.3cm}
   1.358 +
   1.359 + \noindent {\bf Return Type:} 
   1.360 +{\tt 
   1.361 +void
   1.362 +}
   1.363 +
   1.364 +
   1.365 +
   1.366 +\vspace{0.3cm}
   1.367 +\vspace{0.3cm}
   1.368 +\vspace{0.3cm}
   1.369 +\subsubsection{RPC name:~get\_MAC}
   1.370 +
   1.371 +{\bf Overview:} 
   1.372 +get accessor message derived from field MAC of object PIF
   1.373 +
   1.374 + \noindent {\bf Signature:} 
   1.375 +\begin{verbatim} string get_MAC (session_id s, PIF ref self)\end{verbatim}
   1.376 +
   1.377 +
   1.378 +\noindent{\bf Arguments:}
   1.379 +
   1.380 + 
   1.381 +\vspace{0.3cm}
   1.382 +\begin{tabular}{|c|c|p{7cm}|}
   1.383 + \hline
   1.384 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.385 +{\tt PIF ref } & self & object instance \\ \hline 
   1.386 +
   1.387 +\end{tabular}
   1.388 +
   1.389 +\vspace{0.3cm}
   1.390 +
   1.391 + \noindent {\bf Return Type:} 
   1.392 +{\tt 
   1.393 +string
   1.394 +}
   1.395 +
   1.396 +
   1.397 +value of the field
   1.398 +\vspace{0.3cm}
   1.399 +\vspace{0.3cm}
   1.400 +\vspace{0.3cm}
   1.401 +\subsubsection{RPC name:~set\_MAC}
   1.402 +
   1.403 +{\bf Overview:} 
   1.404 +set accessor message derived from field MAC of object PIF
   1.405 +
   1.406 + \noindent {\bf Signature:} 
   1.407 +\begin{verbatim} void set_MAC (session_id s, PIF ref self, string value)\end{verbatim}
   1.408 +
   1.409 +
   1.410 +\noindent{\bf Arguments:}
   1.411 +
   1.412 + 
   1.413 +\vspace{0.3cm}
   1.414 +\begin{tabular}{|c|c|p{7cm}|}
   1.415 + \hline
   1.416 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.417 +{\tt PIF ref } & self & object instance \\ \hline 
   1.418 +
   1.419 +{\tt string } & value & New value to set \\ \hline 
   1.420 +
   1.421 +\end{tabular}
   1.422 +
   1.423 +\vspace{0.3cm}
   1.424 +
   1.425 + \noindent {\bf Return Type:} 
   1.426 +{\tt 
   1.427 +void
   1.428 +}
   1.429 +
   1.430 +
   1.431 +
   1.432 +\vspace{0.3cm}
   1.433 +\vspace{0.3cm}
   1.434 +\vspace{0.3cm}
   1.435 +\subsubsection{RPC name:~get\_MTU}
   1.436 +
   1.437 +{\bf Overview:} 
   1.438 +get accessor message derived from field MTU of object PIF
   1.439 +
   1.440 + \noindent {\bf Signature:} 
   1.441 +\begin{verbatim} int get_MTU (session_id s, PIF ref self)\end{verbatim}
   1.442 +
   1.443 +
   1.444 +\noindent{\bf Arguments:}
   1.445 +
   1.446 + 
   1.447 +\vspace{0.3cm}
   1.448 +\begin{tabular}{|c|c|p{7cm}|}
   1.449 + \hline
   1.450 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.451 +{\tt PIF ref } & self & object instance \\ \hline 
   1.452 +
   1.453 +\end{tabular}
   1.454 +
   1.455 +\vspace{0.3cm}
   1.456 +
   1.457 + \noindent {\bf Return Type:} 
   1.458 +{\tt 
   1.459 +int
   1.460 +}
   1.461 +
   1.462 +
   1.463 +value of the field
   1.464 +\vspace{0.3cm}
   1.465 +\vspace{0.3cm}
   1.466 +\vspace{0.3cm}
   1.467 +\subsubsection{RPC name:~set\_MTU}
   1.468 +
   1.469 +{\bf Overview:} 
   1.470 +set accessor message derived from field MTU of object PIF
   1.471 +
   1.472 + \noindent {\bf Signature:} 
   1.473 +\begin{verbatim} void set_MTU (session_id s, PIF ref self, int value)\end{verbatim}
   1.474 +
   1.475 +
   1.476 +\noindent{\bf Arguments:}
   1.477 +
   1.478 + 
   1.479 +\vspace{0.3cm}
   1.480 +\begin{tabular}{|c|c|p{7cm}|}
   1.481 + \hline
   1.482 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.483 +{\tt PIF ref } & self & object instance \\ \hline 
   1.484 +
   1.485 +{\tt int } & value & New value to set \\ \hline 
   1.486 +
   1.487 +\end{tabular}
   1.488 +
   1.489 +\vspace{0.3cm}
   1.490 +
   1.491 + \noindent {\bf Return Type:} 
   1.492 +{\tt 
   1.493 +void
   1.494 +}
   1.495 +
   1.496 +
   1.497 +
   1.498 +\vspace{0.3cm}
   1.499 +\vspace{0.3cm}
   1.500 +\vspace{0.3cm}
   1.501 +\subsubsection{RPC name:~get\_VLAN}
   1.502 +
   1.503 +{\bf Overview:} 
   1.504 +get accessor message derived from field VLAN of object PIF
   1.505 +
   1.506 + \noindent {\bf Signature:} 
   1.507 +\begin{verbatim} string get_VLAN (session_id s, PIF ref self)\end{verbatim}
   1.508 +
   1.509 +
   1.510 +\noindent{\bf Arguments:}
   1.511 +
   1.512 + 
   1.513 +\vspace{0.3cm}
   1.514 +\begin{tabular}{|c|c|p{7cm}|}
   1.515 + \hline
   1.516 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.517 +{\tt PIF ref } & self & object instance \\ \hline 
   1.518 +
   1.519 +\end{tabular}
   1.520 +
   1.521 +\vspace{0.3cm}
   1.522 +
   1.523 + \noindent {\bf Return Type:} 
   1.524 +{\tt 
   1.525 +string
   1.526 +}
   1.527 +
   1.528 +
   1.529 +value of the field
   1.530 +\vspace{0.3cm}
   1.531 +\vspace{0.3cm}
   1.532 +\vspace{0.3cm}
   1.533 +\subsubsection{RPC name:~set\_VLAN}
   1.534 +
   1.535 +{\bf Overview:} 
   1.536 +set accessor message derived from field VLAN of object PIF
   1.537 +
   1.538 + \noindent {\bf Signature:} 
   1.539 +\begin{verbatim} void set_VLAN (session_id s, PIF ref self, string value)\end{verbatim}
   1.540 +
   1.541 +
   1.542 +\noindent{\bf Arguments:}
   1.543 +
   1.544 + 
   1.545 +\vspace{0.3cm}
   1.546 +\begin{tabular}{|c|c|p{7cm}|}
   1.547 + \hline
   1.548 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.549 +{\tt PIF ref } & self & object instance \\ \hline 
   1.550 +
   1.551 +{\tt string } & value & New value to set \\ \hline 
   1.552 +
   1.553 +\end{tabular}
   1.554 +
   1.555 +\vspace{0.3cm}
   1.556 +
   1.557 + \noindent {\bf Return Type:} 
   1.558 +{\tt 
   1.559 +void
   1.560 +}
   1.561 +
   1.562 +
   1.563 +
   1.564 +\vspace{0.3cm}
   1.565 +\vspace{0.3cm}
   1.566 +\vspace{0.3cm}
   1.567 +\subsubsection{RPC name:~get\_io\_read\_kbs}
   1.568 +
   1.569 +{\bf Overview:} 
   1.570 +get accessor message derived from field io/read\_kbs of object PIF
   1.571 +
   1.572 + \noindent {\bf Signature:} 
   1.573 +\begin{verbatim} float get_io_read_kbs (session_id s, PIF ref self)\end{verbatim}
   1.574 +
   1.575 +
   1.576 +\noindent{\bf Arguments:}
   1.577 +
   1.578 + 
   1.579 +\vspace{0.3cm}
   1.580 +\begin{tabular}{|c|c|p{7cm}|}
   1.581 + \hline
   1.582 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.583 +{\tt PIF ref } & self & object instance \\ \hline 
   1.584 +
   1.585 +\end{tabular}
   1.586 +
   1.587 +\vspace{0.3cm}
   1.588 +
   1.589 + \noindent {\bf Return Type:} 
   1.590 +{\tt 
   1.591 +float
   1.592 +}
   1.593 +
   1.594 +
   1.595 +value of the field
   1.596 +\vspace{0.3cm}
   1.597 +\vspace{0.3cm}
   1.598 +\vspace{0.3cm}
   1.599 +\subsubsection{RPC name:~get\_io\_write\_kbs}
   1.600 +
   1.601 +{\bf Overview:} 
   1.602 +get accessor message derived from field io/write\_kbs of object PIF
   1.603 +
   1.604 + \noindent {\bf Signature:} 
   1.605 +\begin{verbatim} float get_io_write_kbs (session_id s, PIF ref self)\end{verbatim}
   1.606 +
   1.607 +
   1.608 +\noindent{\bf Arguments:}
   1.609 +
   1.610 + 
   1.611 +\vspace{0.3cm}
   1.612 +\begin{tabular}{|c|c|p{7cm}|}
   1.613 + \hline
   1.614 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.615 +{\tt PIF ref } & self & object instance \\ \hline 
   1.616 +
   1.617 +\end{tabular}
   1.618 +
   1.619 +\vspace{0.3cm}
   1.620 +
   1.621 + \noindent {\bf Return Type:} 
   1.622 +{\tt 
   1.623 +float
   1.624 +}
   1.625 +
   1.626 +
   1.627 +value of the field
   1.628 +\vspace{0.3cm}
   1.629 +\vspace{0.3cm}
   1.630 +\vspace{0.3cm}
   1.631 +\subsubsection{RPC name:~create}
   1.632 +
   1.633 +{\bf Overview:} 
   1.634 +constructor for class PIF
   1.635 +
   1.636 + \noindent {\bf Signature:} 
   1.637 +\begin{verbatim} (PIF ref) create (session_id s, PIF record args)\end{verbatim}
   1.638 +
   1.639 +
   1.640 +\noindent{\bf Arguments:}
   1.641 +
   1.642 + 
   1.643 +\vspace{0.3cm}
   1.644 +\begin{tabular}{|c|c|p{7cm}|}
   1.645 + \hline
   1.646 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.647 +{\tt PIF record } & args & All constructor arguments \\ \hline 
   1.648 +
   1.649 +\end{tabular}
   1.650 +
   1.651 +\vspace{0.3cm}
   1.652 +
   1.653 + \noindent {\bf Return Type:} 
   1.654 +{\tt 
   1.655 +PIF ref
   1.656 +}
   1.657 +
   1.658 +
   1.659 +reference to the newly created object
   1.660 +\vspace{0.3cm}
   1.661 +\vspace{0.3cm}
   1.662 +\vspace{0.3cm}
   1.663 +\subsubsection{RPC name:~destroy}
   1.664 +
   1.665 +{\bf Overview:} 
   1.666 +destructor for class PIF
   1.667 +
   1.668 + \noindent {\bf Signature:} 
   1.669 +\begin{verbatim} void destroy (session_id s, PIF ref self)\end{verbatim}
   1.670 +
   1.671 +
   1.672 +\noindent{\bf Arguments:}
   1.673 +
   1.674 + 
   1.675 +\vspace{0.3cm}
   1.676 +\begin{tabular}{|c|c|p{7cm}|}
   1.677 + \hline
   1.678 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.679 +{\tt PIF ref } & self & object instance \\ \hline 
   1.680 +
   1.681 +\end{tabular}
   1.682 +
   1.683 +\vspace{0.3cm}
   1.684 +
   1.685 + \noindent {\bf Return Type:} 
   1.686 +{\tt 
   1.687 +void
   1.688 +}
   1.689 +
   1.690 +
   1.691 +
   1.692 +\vspace{0.3cm}
   1.693 +\vspace{0.3cm}
   1.694 +\vspace{0.3cm}
   1.695 +\subsubsection{RPC name:~get\_by\_uuid}
   1.696 +
   1.697 +{\bf Overview:} 
   1.698 +returns the PIF instance with a particular uuid
   1.699 +
   1.700 + \noindent {\bf Signature:} 
   1.701 +\begin{verbatim} (PIF ref) get_by_uuid (session_id s, string uuid)\end{verbatim}
   1.702 +
   1.703 +
   1.704 +\noindent{\bf Arguments:}
   1.705 +
   1.706 + 
   1.707 +\vspace{0.3cm}
   1.708 +\begin{tabular}{|c|c|p{7cm}|}
   1.709 + \hline
   1.710 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.711 +{\tt string } & uuid & UUID of object to return \\ \hline 
   1.712 +
   1.713 +\end{tabular}
   1.714 +
   1.715 +\vspace{0.3cm}
   1.716 +
   1.717 + \noindent {\bf Return Type:} 
   1.718 +{\tt 
   1.719 +PIF ref
   1.720 +}
   1.721 +
   1.722 +
   1.723 +reference to the object
   1.724 +\vspace{0.3cm}
   1.725 +\vspace{0.3cm}
   1.726 +\vspace{0.3cm}
   1.727 +\subsubsection{RPC name:~get\_record}
   1.728 +
   1.729 +{\bf Overview:} 
   1.730 +returns a record containing the state of an instance of class PIF
   1.731 +
   1.732 + \noindent {\bf Signature:} 
   1.733 +\begin{verbatim} (PIF record) get_record (session_id s, PIF ref self)\end{verbatim}
   1.734 +
   1.735 +
   1.736 +\noindent{\bf Arguments:}
   1.737 +
   1.738 + 
   1.739 +\vspace{0.3cm}
   1.740 +\begin{tabular}{|c|c|p{7cm}|}
   1.741 + \hline
   1.742 +{\bf type} & {\bf name} & {\bf description} \\ \hline
   1.743 +{\tt PIF ref } & self & reference to the object \\ \hline 
   1.744 +
   1.745 +\end{tabular}
   1.746 +
   1.747 +\vspace{0.3cm}
   1.748 +
   1.749 + \noindent {\bf Return Type:} 
   1.750 +{\tt 
   1.751 +PIF record
   1.752 +}
   1.753 +
   1.754 +
   1.755 +all fields from the object
   1.756 +\vspace{0.3cm}
   1.757 +\vspace{0.3cm}
   1.758 +\vspace{0.3cm}
   1.759 +\subsubsection{RPC name:~get\_all}
   1.760 +
   1.761 +{\bf Overview:} 
   1.762 +returns a set of references to all objects
   1.763 +
   1.764 + \noindent {\bf Signature:} 
   1.765 +\begin{verbatim} ((PIF ref) Set) get_all (session_id s)\end{verbatim}
   1.766 +
   1.767 +
   1.768 +\vspace{0.3cm}
   1.769 +
   1.770 + \noindent {\bf Return Type:} 
   1.771 +{\tt 
   1.772 +(PIF ref) Set
   1.773 +}
   1.774 +
   1.775 +
   1.776 +references to all objects
   1.777 +\vspace{0.3cm}
   1.778 +\vspace{0.3cm}
   1.779 +\vspace{0.3cm}
   1.780 +
   1.781 +\vspace{1cm}
   1.782 +\newpage
   1.783  \section{Class: SR}
   1.784  \subsection{Fields for class: SR}
   1.785  \begin{longtable}{|lllp{0.38\textwidth}|}