vnfs/VES5.0/doxygen-1.8.12/html/examples/tclexample/latex/classns_1_1oo__class.tex

   1 \hypertarget{classns_1_1oo__class}{}\subsection{ns\+:\+:oo\+\_\+class Class Reference}
   2 \label{classns_1_1oo__class}\index{ns\+::oo\+\_\+class@{ns\+::oo\+\_\+class}}
   3
   4
   5 Documented oo class {\ttfamily \hyperlink{classns_1_1oo__class}{oo\+\_\+class}} .
   6
   7
   8 \subsubsection*{Public Member Functions}
   9 \begin{DoxyCompactItemize}
  10 \item
  11 \hyperlink{classns_1_1oo__class_aa26b64151d4b4b0e8b4977aae7048f9b}{constructor} args
  12 \begin{DoxyCompactList}\small\item\em Create object. \end{DoxyCompactList}\item
  13 \hyperlink{classns_1_1oo__class_af148cfc1c090a05986c68ac9452a510a}{destructor}
  14 \begin{DoxyCompactList}\small\item\em Destroy object. \end{DoxyCompactList}\item
  15 \hyperlink{classns_1_1oo__class_a8a3cfbae3b3fca463f08adb9174a5fe8}{oo\+\_\+method\+\_\+z} arg
  16 \begin{DoxyCompactList}\small\item\em Documented oo method {\ttfamily oo\+\_\+method\+\_\+z} . \end{DoxyCompactList}\end{DoxyCompactItemize}
  17 \subsubsection*{Static Public Attributes}
  18 \begin{DoxyCompactItemize}
  19 \item
  20 \hyperlink{classns_1_1oo__class_a741f11f4a2db3876205658d4a9a279ba}{oo\+\_\+var}
  21 \begin{DoxyCompactList}\small\item\em Documented oo var {\ttfamily oo\+\_\+var} . \end{DoxyCompactList}\item
  22 \hyperlink{classns_1_1oo__class_af46293ede16067c38ca2901416cad8ee}{oo\+\_\+var\+\_\+out}
  23 \begin{DoxyCompactList}\small\item\em Outside defined variable {\ttfamily oo\+\_\+var\+\_\+out} . \end{DoxyCompactList}\end{DoxyCompactItemize}
  24 \subsubsection*{Protected Member Functions}
  25 \begin{DoxyCompactItemize}
  26 \item
  27 \hyperlink{classns_1_1oo__class_ad07feb192f34010ed66d123338c7acdd}{oo\+\_\+method\+\_\+y} arg
  28 \begin{DoxyCompactList}\small\item\em Documented oo method {\ttfamily oo\+\_\+method\+\_\+y} . \end{DoxyCompactList}\end{DoxyCompactItemize}
  29
  30
  31 \subsubsection{Detailed Description}
  32 Documented oo class {\ttfamily \hyperlink{classns_1_1oo__class}{oo\+\_\+class}} .
  33
  34 \subsubsection{Constructor \& Destructor Documentation}
  35 \hypertarget{classns_1_1oo__class_aa26b64151d4b4b0e8b4977aae7048f9b}{}\label{classns_1_1oo__class_aa26b64151d4b4b0e8b4977aae7048f9b}
  36 \index{ns\+::oo\+\_\+class@{ns\+::oo\+\_\+class}!constructor@{constructor}}
  37 \index{constructor@{constructor}!ns\+::oo\+\_\+class@{ns\+::oo\+\_\+class}}
  38 \paragraph{\texorpdfstring{constructor()}{constructor()}}
  39 {\footnotesize\ttfamily ns\+::oo\+\_\+class\+::constructor\begin{DoxyParamCaption}\item[{}]{args  }\end{DoxyParamCaption}}
  40
  41
  42
  43 Create object.
  44
  45 Configure with args
  46 \begin{DoxyCode}
  47 44     \textcolor{keyword}{constructor} \{args\} \{\textcolor{keyword}{eval} $args\}
  48 \end{DoxyCode}
  49 \hypertarget{classns_1_1oo__class_af148cfc1c090a05986c68ac9452a510a}{}\label{classns_1_1oo__class_af148cfc1c090a05986c68ac9452a510a}
  50 \index{ns\+::oo\+\_\+class@{ns\+::oo\+\_\+class}!destructor@{destructor}}
  51 \index{destructor@{destructor}!ns\+::oo\+\_\+class@{ns\+::oo\+\_\+class}}
  52 \paragraph{\texorpdfstring{destructor()}{destructor()}}
  53 {\footnotesize\ttfamily ns\+::oo\+\_\+class\+::destructor}
  54
  55
  56
  57 Destroy object.
  58
  59 Exit.
  60 \begin{DoxyCode}
  61 47     \textcolor{keyword}{destructor} \{\textcolor{keyword}{exit}\}
  62 \end{DoxyCode}
  63
  64
  65 \subsubsection{Member Function Documentation}
  66 \hypertarget{classns_1_1oo__class_ad07feb192f34010ed66d123338c7acdd}{}\label{classns_1_1oo__class_ad07feb192f34010ed66d123338c7acdd}
  67 \index{ns\+::oo\+\_\+class@{ns\+::oo\+\_\+class}!oo\+\_\+method\+\_\+y@{oo\+\_\+method\+\_\+y}}
  68 \index{oo\+\_\+method\+\_\+y@{oo\+\_\+method\+\_\+y}!ns\+::oo\+\_\+class@{ns\+::oo\+\_\+class}}
  69 \paragraph{\texorpdfstring{oo\+\_\+method\+\_\+y()}{oo\_method\_y()}}
  70 {\footnotesize\ttfamily ns\+::oo\+\_\+class\+::oo\+\_\+method\+\_\+y\begin{DoxyParamCaption}\item[{}]{arg  }\end{DoxyParamCaption}\hspace{0.3cm}{\ttfamily [protected]}}
  71
  72
  73
  74 Documented oo method {\ttfamily oo\+\_\+method\+\_\+y} .
  75
  76 param\mbox{[}in\mbox{]} arg Argument
  77 \begin{DoxyCode}
  78 56     \textcolor{keyword}{method} oo\_method\_y \{arg\} \{\}
  79 \end{DoxyCode}
  80 \hypertarget{classns_1_1oo__class_a8a3cfbae3b3fca463f08adb9174a5fe8}{}\label{classns_1_1oo__class_a8a3cfbae3b3fca463f08adb9174a5fe8}
  81 \index{ns\+::oo\+\_\+class@{ns\+::oo\+\_\+class}!oo\+\_\+method\+\_\+z@{oo\+\_\+method\+\_\+z}}
  82 \index{oo\+\_\+method\+\_\+z@{oo\+\_\+method\+\_\+z}!ns\+::oo\+\_\+class@{ns\+::oo\+\_\+class}}
  83 \paragraph{\texorpdfstring{oo\+\_\+method\+\_\+z()}{oo\_method\_z()}}
  84 {\footnotesize\ttfamily ns\+::oo\+\_\+class\+::oo\+\_\+method\+\_\+z\begin{DoxyParamCaption}\item[{}]{arg  }\end{DoxyParamCaption}}
  85
  86
  87
  88 Documented oo method {\ttfamily oo\+\_\+method\+\_\+z} .
  89
  90 param\mbox{[}in\mbox{]} arg Argument
  91 \begin{DoxyCode}
  92 59     \textcolor{keyword}{method} oo\_method\_z \{arg\} \{\}
  93 \end{DoxyCode}
  94
  95
  96 \subsubsection{Member Data Documentation}
  97 \hypertarget{classns_1_1oo__class_a741f11f4a2db3876205658d4a9a279ba}{}\label{classns_1_1oo__class_a741f11f4a2db3876205658d4a9a279ba}
  98 \index{ns\+::oo\+\_\+class@{ns\+::oo\+\_\+class}!oo\+\_\+var@{oo\+\_\+var}}
  99 \index{oo\+\_\+var@{oo\+\_\+var}!ns\+::oo\+\_\+class@{ns\+::oo\+\_\+class}}
 100 \paragraph{\texorpdfstring{oo\+\_\+var}{oo\_var}}
 101 {\footnotesize\ttfamily ns\+::oo\+\_\+class\+::oo\+\_\+var\hspace{0.3cm}{\ttfamily [static]}}
 102
 103
 104
 105 Documented oo var {\ttfamily oo\+\_\+var} .
 106
 107 Defined inside class
 108 \begin{DoxyCode}
 109 50     \textcolor{keyword}{variable} oo\_var
 110 \end{DoxyCode}
 111 \hypertarget{classns_1_1oo__class_af46293ede16067c38ca2901416cad8ee}{}\label{classns_1_1oo__class_af46293ede16067c38ca2901416cad8ee}
 112 \index{ns\+::oo\+\_\+class@{ns\+::oo\+\_\+class}!oo\+\_\+var\+\_\+out@{oo\+\_\+var\+\_\+out}}
 113 \index{oo\+\_\+var\+\_\+out@{oo\+\_\+var\+\_\+out}!ns\+::oo\+\_\+class@{ns\+::oo\+\_\+class}}
 114 \paragraph{\texorpdfstring{oo\+\_\+var\+\_\+out}{oo\_var\_out}}
 115 {\footnotesize\ttfamily ns\+::oo\+\_\+class\+::oo\+\_\+var\+\_\+out\hspace{0.3cm}{\ttfamily [static]}}
 116
 117
 118
 119 Outside defined variable {\ttfamily oo\+\_\+var\+\_\+out} .
 120
 121 Inside \hyperlink{classns_1_1oo__class}{oo\+\_\+class}
 122 \begin{DoxyCode}
 123 71   \textcolor{keyword}{variable} oo\_var\_out
 124 \end{DoxyCode}
 125
 126
 127 The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
 128 \item
 129 \hyperlink{tclexample_8tcl}{tclexample.\+tcl}\end{DoxyCompactItemize}