Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / e4396b8b1b417e22129f1d512c1c758594d8186f / . / TestON / Documentation / TestON_Document / TestON.examples.Topology.Topology.Topology-class.html
blob: fc102171f3d3566ecc3d104db17e2be6c6598f7a [file] [log] [blame]
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>TestON.examples.Topology.Topology.Topology</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21 <!-- Tree link -->
22 <th>&nbsp;&nbsp;&nbsp;<a
23 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25 <!-- Index link -->
26 <th>&nbsp;&nbsp;&nbsp;<a
27 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29 <!-- Help link -->
30 <th>&nbsp;&nbsp;&nbsp;<a
31 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]33 <!-- Project homepage -->
34 <th class="navbar" align="right" width="100%">
35 <table border="0" cellpadding="0" cellspacing="0">
36 <tr><th class="navbar" align="center"
37 >TestON</th>
38 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]39 </tr>
40</table>
41<table width="100%" cellpadding="0" cellspacing="0">
42 <tr valign="top">
43 <td width="100%">
44 <span class="breadcrumbs">
45 <a href="TestON-module.html">Package&nbsp;TestON</a> ::
46 <a href="TestON.examples-module.html">Package&nbsp;examples</a> ::
47 <a href="TestON.examples.Topology-module.html">Package&nbsp;Topology</a> ::
48 <a href="TestON.examples.Topology.Topology-module.html">Module&nbsp;Topology</a> ::
49 Class&nbsp;Topology
50 </span>
51 </td>
52 <td>
53 <table cellpadding="0" cellspacing="0">
54 <!-- hide/show private -->
55 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
56 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
57 <tr><td align="right"><span class="options"
58 >[<a href="frames.html" target="_top">frames</a
59 >]&nbsp;|&nbsp;<a href="TestON.examples.Topology.Topology.Topology-class.html"
60 target="_top">no&nbsp;frames</a>]</span></td></tr>
61 </table>
62 </td>
63 </tr>
64</table>
65<!-- ==================== CLASS DESCRIPTION ==================== -->
66<h1 class="epydoc">Class Topology</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.examples.Topology.Topology-pysrc.html#Topology">source&nbsp;code</a></span></p>
67<pre class="literalblock">
68
69
70This example shows, how we can use the topology file:
71
72In topo file we can specify the component like below:
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]73[TOPOLOGY]
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]74
75 [[COMPONENT]]
76 [[[&quot;Mininet1&quot;]]]
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]77
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]78The usage of this component in the test script like below:
79
80main.Mininet1.checkIP(main.params['CASE1']['destination'])
81
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]82Here we are using the Mininet1 which of type Mininet
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]83
84
85
86ofautomation&gt;run Topology example 1
87 will execute this example.
88
89</pre>
90
91<!-- ==================== INSTANCE METHODS ==================== -->
92<a name="section-InstanceMethods"></a>
93<table class="summary" border="1" cellpadding="3"
94 cellspacing="0" width="100%" bgcolor="white">
95<tr bgcolor="#70b0f0" class="table-header">
96 <td colspan="2" class="table-header">
97 <table border="0" cellpadding="0" cellspacing="0" width="100%">
98 <tr valign="top">
99 <td align="left"><span class="table-header">Instance Methods</span></td>
100 <td align="right" valign="top"
101 ><span class="options">[<a href="#section-InstanceMethods"
102 class="privatelink" onclick="toggle_private();"
103 >hide private</a>]</span></td>
104 </tr>
105 </table>
106 </td>
107</tr>
108<tr>
109 <td width="15%" align="right" valign="top" class="summary">
110 <span class="summary-type">&nbsp;</span>
111 </td><td class="summary">
112 <table width="100%" cellpadding="0" cellspacing="0" border="0">
113 <tr>
114 <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>)</span></td>
115 <td align="right" valign="top">
116 <span class="codelink"><a href="TestON.examples.Topology.Topology-pysrc.html#Topology.__init__">source&nbsp;code</a></span>
117
118 </td>
119 </tr>
120 </table>
121
122 </td>
123 </tr>
124<tr>
125 <td width="15%" align="right" valign="top" class="summary">
126 <span class="summary-type">&nbsp;</span>
127 </td><td class="summary">
128 <table width="100%" cellpadding="0" cellspacing="0" border="0">
129 <tr>
130 <td><span class="summary-sig"><a name="CASE1"></a><span class="summary-sig-name">CASE1</span>(<span class="summary-sig-arg">self</span>,
131 <span class="summary-sig-arg">main</span>)</span><br />
132 This will showcase the usage of Topology</td>
133 <td align="right" valign="top">
134 <span class="codelink"><a href="TestON.examples.Topology.Topology-pysrc.html#Topology.CASE1">source&nbsp;code</a></span>
135
136 </td>
137 </tr>
138 </table>
139
140 </td>
141 </tr>
142</table>
143<!-- ==================== NAVIGATION BAR ==================== -->
144<table class="navbar" border="0" width="100%" cellpadding="0"
145 bgcolor="#a0c0ff" cellspacing="0">
146 <tr valign="middle">
147 <!-- Home link -->
148 <th>&nbsp;&nbsp;&nbsp;<a
149 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
150
151 <!-- Tree link -->
152 <th>&nbsp;&nbsp;&nbsp;<a
153 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
154
155 <!-- Index link -->
156 <th>&nbsp;&nbsp;&nbsp;<a
157 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
158
159 <!-- Help link -->
160 <th>&nbsp;&nbsp;&nbsp;<a
161 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
162
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]163 <!-- Project homepage -->
164 <th class="navbar" align="right" width="100%">
165 <table border="0" cellpadding="0" cellspacing="0">
166 <tr><th class="navbar" align="center"
167 >TestON</th>
168 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]169 </tr>
170</table>
171<table border="0" cellpadding="0" cellspacing="0" width="100%%">
172 <tr>
173 <td align="left" class="footer">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]174 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:35 2015
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]175 </td>
176 <td align="right" class="footer">
177 <a target="mainFrame" href="http://epydoc.sourceforge.net"
178 >http://epydoc.sourceforge.net</a>
179 </td>
180 </tr>
181</table>
182
183<script type="text/javascript">
184 <!--
185 // Private objects are initially displayed (because if
186 // javascript is turned off then we want them to be
187 // visible); but by default, we want to hide them. So hide
188 // them unless we have a cookie that says to show them.
189 checkCookie();
190 // -->
191</script>
192</body>
193</html>