sdk/platform-tools/systrace/catapult/telemetry/docs/pydoc/telemetry.page.shared_page_state.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   3 <html><head><title>Python: module telemetry.page.shared_page_state</title>
   4 <meta charset="utf-8">
   5 </head><body bgcolor="#f0f0f8">
   6
   7 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
   8 <tr bgcolor="#7799ee">
   9 <td valign=bottom>&nbsp;<br>
  10 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.page.html"><font color="#ffffff">page</font></a>.shared_page_state</strong></big></big></font></td
  11 ><td align=right valign=bottom
  12 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/page/shared_page_state.py">telemetry/page/shared_page_state.py</a></font></td></tr></table>
  13     <p><tt>#&nbsp;Copyright&nbsp;2014&nbsp;The&nbsp;Chromium&nbsp;Authors.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
  14 #&nbsp;Use&nbsp;of&nbsp;this&nbsp;source&nbsp;code&nbsp;is&nbsp;governed&nbsp;by&nbsp;a&nbsp;BSD-style&nbsp;license&nbsp;that&nbsp;can&nbsp;be<br>
  15 #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;file.</tt></p>
  16 <p>
  17 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  18 <tr bgcolor="#aa55cc">
  19 <td colspan=3 valign=bottom>&nbsp;<br>
  20 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
  21
  22 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  23 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.internal.browser.browser_finder.html">telemetry.internal.browser.browser_finder</a><br>
  24 <a href="telemetry.internal.browser.browser_finder_exceptions.html">telemetry.internal.browser.browser_finder_exceptions</a><br>
  25 <a href="telemetry.internal.browser.browser_info.html">telemetry.internal.browser.browser_info</a><br>
  26 <a href="catapult_base.cloud_storage.html">catapult_base.cloud_storage</a><br>
  27 <a href="telemetry.decorators.html">telemetry.decorators</a><br>
  28 <a href="telemetry.internal.util.exception_formatter.html">telemetry.internal.util.exception_formatter</a><br>
  29 </td><td width="25%" valign=top><a href="telemetry.core.exceptions.html">telemetry.core.exceptions</a><br>
  30 <a href="telemetry.internal.util.file_handle.html">telemetry.internal.util.file_handle</a><br>
  31 <a href="telemetry.util.image_util.html">telemetry.util.image_util</a><br>
  32 <a href="logging.html">logging</a><br>
  33 <a href="os.html">os</a><br>
  34 <a href="telemetry.page.page_test.html">telemetry.page.page_test</a><br>
  35 </td><td width="25%" valign=top><a href="telemetry.internal.platform.profiler.profiler_finder.html">telemetry.internal.platform.profiler.profiler_finder</a><br>
  36 <a href="shutil.html">shutil</a><br>
  37 <a href="telemetry.story.html">telemetry.story</a><br>
  38 <a href="sys.html">sys</a><br>
  39 <a href="tempfile.html">tempfile</a><br>
  40 <a href="telemetry.web_perf.timeline_based_measurement.html">telemetry.web_perf.timeline_based_measurement</a><br>
  41 </td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.core.util</a><br>
  42 <a href="telemetry.util.wpr_modes.html">telemetry.util.wpr_modes</a><br>
  43 <a href="zipfile.html">zipfile</a><br>
  44 </td></tr></table></td></tr></table><p>
  45 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  46 <tr bgcolor="#ee77aa">
  47 <td colspan=3 valign=bottom>&nbsp;<br>
  48 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
  49
  50 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  51 <td width="100%"><dl>
  52 <dt><font face="helvetica, arial"><a href="telemetry.story.shared_state.html#SharedState">telemetry.story.shared_state.SharedState</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
  53 </font></dt><dd>
  54 <dl>
  55 <dt><font face="helvetica, arial"><a href="telemetry.page.shared_page_state.html#SharedPageState">SharedPageState</a>
  56 </font></dt><dd>
  57 <dl>
  58 <dt><font face="helvetica, arial"><a href="telemetry.page.shared_page_state.html#Shared10InchTabletPageState">Shared10InchTabletPageState</a>
  59 </font></dt><dt><font face="helvetica, arial"><a href="telemetry.page.shared_page_state.html#SharedDesktopPageState">SharedDesktopPageState</a>
  60 </font></dt><dt><font face="helvetica, arial"><a href="telemetry.page.shared_page_state.html#SharedMobilePageState">SharedMobilePageState</a>
  61 </font></dt><dt><font face="helvetica, arial"><a href="telemetry.page.shared_page_state.html#SharedTabletPageState">SharedTabletPageState</a>
  62 </font></dt></dl>
  63 </dd>
  64 </dl>
  65 </dd>
  66 </dl>
  67  <p>
  68 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  69 <tr bgcolor="#ffc8d8">
  70 <td colspan=3 valign=bottom>&nbsp;<br>
  71 <font color="#000000" face="helvetica, arial"><a name="Shared10InchTabletPageState">class <strong>Shared10InchTabletPageState</strong></a>(<a href="telemetry.page.shared_page_state.html#SharedPageState">SharedPageState</a>)</font></td></tr>
  72
  73 <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  74 <td width="100%"><dl><dt>Method resolution order:</dt>
  75 <dd><a href="telemetry.page.shared_page_state.html#Shared10InchTabletPageState">Shared10InchTabletPageState</a></dd>
  76 <dd><a href="telemetry.page.shared_page_state.html#SharedPageState">SharedPageState</a></dd>
  77 <dd><a href="telemetry.story.shared_state.html#SharedState">telemetry.story.shared_state.SharedState</a></dd>
  78 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
  79 </dl>
  80 <hr>
  81 Methods inherited from <a href="telemetry.page.shared_page_state.html#SharedPageState">SharedPageState</a>:<br>
  82 <dl><dt><a name="Shared10InchTabletPageState-CanRunOnBrowser"><strong>CanRunOnBrowser</strong></a>(self, browser_info, page)</dt><dd><tt>Override&nbsp;this&nbsp;to&nbsp;return&nbsp;whether&nbsp;the&nbsp;browser&nbsp;brought&nbsp;up&nbsp;by&nbsp;this&nbsp;state<br>
  83 instance&nbsp;is&nbsp;suitable&nbsp;for&nbsp;running&nbsp;the&nbsp;given&nbsp;page.<br>
  84 &nbsp;<br>
  85 Args:<br>
  86 &nbsp;&nbsp;browser_info:&nbsp;an&nbsp;instance&nbsp;of&nbsp;telemetry.core.browser_info.BrowserInfo<br>
  87 &nbsp;&nbsp;page:&nbsp;an&nbsp;instance&nbsp;of&nbsp;telemetry.page.Page</tt></dd></dl>
  88
  89 <dl><dt><a name="Shared10InchTabletPageState-CanRunStory"><strong>CanRunStory</strong></a>(self, page)</dt></dl>
  90
  91 <dl><dt><a name="Shared10InchTabletPageState-DidRunStory"><strong>DidRunStory</strong></a>(self, results)</dt></dl>
  92
  93 <dl><dt><a name="Shared10InchTabletPageState-GetPregeneratedProfileArchiveDir"><strong>GetPregeneratedProfileArchiveDir</strong></a>(self)</dt></dl>
  94
  95 <dl><dt><a name="Shared10InchTabletPageState-RunStory"><strong>RunStory</strong></a>(self, results)</dt></dl>
  96
  97 <dl><dt><a name="Shared10InchTabletPageState-SetPregeneratedProfileArchiveDir"><strong>SetPregeneratedProfileArchiveDir</strong></a>(self, archive_path)</dt><dd><tt>Benchmarks&nbsp;can&nbsp;set&nbsp;a&nbsp;pre-generated&nbsp;profile&nbsp;archive&nbsp;to&nbsp;indicate&nbsp;that&nbsp;when<br>
  98 Chrome&nbsp;is&nbsp;launched,&nbsp;it&nbsp;should&nbsp;have&nbsp;a&nbsp;--user-data-dir&nbsp;set&nbsp;to&nbsp;the<br>
  99 pregenerated&nbsp;profile,&nbsp;rather&nbsp;than&nbsp;to&nbsp;an&nbsp;empty&nbsp;profile.<br>
 100 &nbsp;<br>
 101 If&nbsp;the&nbsp;benchmark&nbsp;is&nbsp;invoked&nbsp;with&nbsp;the&nbsp;option&nbsp;--profile-dir=&lt;dir&gt;,&nbsp;that<br>
 102 option&nbsp;overrides&nbsp;this&nbsp;value.</tt></dd></dl>
 103
 104 <dl><dt><a name="Shared10InchTabletPageState-TearDownState"><strong>TearDownState</strong></a>(self)</dt></dl>
 105
 106 <dl><dt><a name="Shared10InchTabletPageState-WillRunStory"><strong>WillRunStory</strong></a>(self, page)</dt></dl>
 107
 108 <dl><dt><a name="Shared10InchTabletPageState-__init__"><strong>__init__</strong></a>(self, test, finder_options, story_set)</dt></dl>
 109
 110 <hr>
 111 Data descriptors inherited from <a href="telemetry.page.shared_page_state.html#SharedPageState">SharedPageState</a>:<br>
 112 <dl><dt><strong>browser</strong></dt>
 113 </dl>
 114 <dl><dt><strong>current_page</strong></dt>
 115 </dl>
 116 <dl><dt><strong>current_tab</strong></dt>
 117 </dl>
 118 <dl><dt><strong>page_test</strong></dt>
 119 </dl>
 120 <dl><dt><strong>platform</strong></dt>
 121 </dl>
 122 <hr>
 123 Data descriptors inherited from <a href="telemetry.story.shared_state.html#SharedState">telemetry.story.shared_state.SharedState</a>:<br>
 124 <dl><dt><strong>__dict__</strong></dt>
 125 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 126 </dl>
 127 <dl><dt><strong>__weakref__</strong></dt>
 128 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 129 </dl>
 130 </td></tr></table> <p>
 131 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 132 <tr bgcolor="#ffc8d8">
 133 <td colspan=3 valign=bottom>&nbsp;<br>
 134 <font color="#000000" face="helvetica, arial"><a name="SharedDesktopPageState">class <strong>SharedDesktopPageState</strong></a>(<a href="telemetry.page.shared_page_state.html#SharedPageState">SharedPageState</a>)</font></td></tr>
 135
 136 <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 137 <td width="100%"><dl><dt>Method resolution order:</dt>
 138 <dd><a href="telemetry.page.shared_page_state.html#SharedDesktopPageState">SharedDesktopPageState</a></dd>
 139 <dd><a href="telemetry.page.shared_page_state.html#SharedPageState">SharedPageState</a></dd>
 140 <dd><a href="telemetry.story.shared_state.html#SharedState">telemetry.story.shared_state.SharedState</a></dd>
 141 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
 142 </dl>
 143 <hr>
 144 Methods inherited from <a href="telemetry.page.shared_page_state.html#SharedPageState">SharedPageState</a>:<br>
 145 <dl><dt><a name="SharedDesktopPageState-CanRunOnBrowser"><strong>CanRunOnBrowser</strong></a>(self, browser_info, page)</dt><dd><tt>Override&nbsp;this&nbsp;to&nbsp;return&nbsp;whether&nbsp;the&nbsp;browser&nbsp;brought&nbsp;up&nbsp;by&nbsp;this&nbsp;state<br>
 146 instance&nbsp;is&nbsp;suitable&nbsp;for&nbsp;running&nbsp;the&nbsp;given&nbsp;page.<br>
 147 &nbsp;<br>
 148 Args:<br>
 149 &nbsp;&nbsp;browser_info:&nbsp;an&nbsp;instance&nbsp;of&nbsp;telemetry.core.browser_info.BrowserInfo<br>
 150 &nbsp;&nbsp;page:&nbsp;an&nbsp;instance&nbsp;of&nbsp;telemetry.page.Page</tt></dd></dl>
 151
 152 <dl><dt><a name="SharedDesktopPageState-CanRunStory"><strong>CanRunStory</strong></a>(self, page)</dt></dl>
 153
 154 <dl><dt><a name="SharedDesktopPageState-DidRunStory"><strong>DidRunStory</strong></a>(self, results)</dt></dl>
 155
 156 <dl><dt><a name="SharedDesktopPageState-GetPregeneratedProfileArchiveDir"><strong>GetPregeneratedProfileArchiveDir</strong></a>(self)</dt></dl>
 157
 158 <dl><dt><a name="SharedDesktopPageState-RunStory"><strong>RunStory</strong></a>(self, results)</dt></dl>
 159
 160 <dl><dt><a name="SharedDesktopPageState-SetPregeneratedProfileArchiveDir"><strong>SetPregeneratedProfileArchiveDir</strong></a>(self, archive_path)</dt><dd><tt>Benchmarks&nbsp;can&nbsp;set&nbsp;a&nbsp;pre-generated&nbsp;profile&nbsp;archive&nbsp;to&nbsp;indicate&nbsp;that&nbsp;when<br>
 161 Chrome&nbsp;is&nbsp;launched,&nbsp;it&nbsp;should&nbsp;have&nbsp;a&nbsp;--user-data-dir&nbsp;set&nbsp;to&nbsp;the<br>
 162 pregenerated&nbsp;profile,&nbsp;rather&nbsp;than&nbsp;to&nbsp;an&nbsp;empty&nbsp;profile.<br>
 163 &nbsp;<br>
 164 If&nbsp;the&nbsp;benchmark&nbsp;is&nbsp;invoked&nbsp;with&nbsp;the&nbsp;option&nbsp;--profile-dir=&lt;dir&gt;,&nbsp;that<br>
 165 option&nbsp;overrides&nbsp;this&nbsp;value.</tt></dd></dl>
 166
 167 <dl><dt><a name="SharedDesktopPageState-TearDownState"><strong>TearDownState</strong></a>(self)</dt></dl>
 168
 169 <dl><dt><a name="SharedDesktopPageState-WillRunStory"><strong>WillRunStory</strong></a>(self, page)</dt></dl>
 170
 171 <dl><dt><a name="SharedDesktopPageState-__init__"><strong>__init__</strong></a>(self, test, finder_options, story_set)</dt></dl>
 172
 173 <hr>
 174 Data descriptors inherited from <a href="telemetry.page.shared_page_state.html#SharedPageState">SharedPageState</a>:<br>
 175 <dl><dt><strong>browser</strong></dt>
 176 </dl>
 177 <dl><dt><strong>current_page</strong></dt>
 178 </dl>
 179 <dl><dt><strong>current_tab</strong></dt>
 180 </dl>
 181 <dl><dt><strong>page_test</strong></dt>
 182 </dl>
 183 <dl><dt><strong>platform</strong></dt>
 184 </dl>
 185 <hr>
 186 Data descriptors inherited from <a href="telemetry.story.shared_state.html#SharedState">telemetry.story.shared_state.SharedState</a>:<br>
 187 <dl><dt><strong>__dict__</strong></dt>
 188 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 189 </dl>
 190 <dl><dt><strong>__weakref__</strong></dt>
 191 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 192 </dl>
 193 </td></tr></table> <p>
 194 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 195 <tr bgcolor="#ffc8d8">
 196 <td colspan=3 valign=bottom>&nbsp;<br>
 197 <font color="#000000" face="helvetica, arial"><a name="SharedMobilePageState">class <strong>SharedMobilePageState</strong></a>(<a href="telemetry.page.shared_page_state.html#SharedPageState">SharedPageState</a>)</font></td></tr>
 198
 199 <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 200 <td width="100%"><dl><dt>Method resolution order:</dt>
 201 <dd><a href="telemetry.page.shared_page_state.html#SharedMobilePageState">SharedMobilePageState</a></dd>
 202 <dd><a href="telemetry.page.shared_page_state.html#SharedPageState">SharedPageState</a></dd>
 203 <dd><a href="telemetry.story.shared_state.html#SharedState">telemetry.story.shared_state.SharedState</a></dd>
 204 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
 205 </dl>
 206 <hr>
 207 Methods inherited from <a href="telemetry.page.shared_page_state.html#SharedPageState">SharedPageState</a>:<br>
 208 <dl><dt><a name="SharedMobilePageState-CanRunOnBrowser"><strong>CanRunOnBrowser</strong></a>(self, browser_info, page)</dt><dd><tt>Override&nbsp;this&nbsp;to&nbsp;return&nbsp;whether&nbsp;the&nbsp;browser&nbsp;brought&nbsp;up&nbsp;by&nbsp;this&nbsp;state<br>
 209 instance&nbsp;is&nbsp;suitable&nbsp;for&nbsp;running&nbsp;the&nbsp;given&nbsp;page.<br>
 210 &nbsp;<br>
 211 Args:<br>
 212 &nbsp;&nbsp;browser_info:&nbsp;an&nbsp;instance&nbsp;of&nbsp;telemetry.core.browser_info.BrowserInfo<br>
 213 &nbsp;&nbsp;page:&nbsp;an&nbsp;instance&nbsp;of&nbsp;telemetry.page.Page</tt></dd></dl>
 214
 215 <dl><dt><a name="SharedMobilePageState-CanRunStory"><strong>CanRunStory</strong></a>(self, page)</dt></dl>
 216
 217 <dl><dt><a name="SharedMobilePageState-DidRunStory"><strong>DidRunStory</strong></a>(self, results)</dt></dl>
 218
 219 <dl><dt><a name="SharedMobilePageState-GetPregeneratedProfileArchiveDir"><strong>GetPregeneratedProfileArchiveDir</strong></a>(self)</dt></dl>
 220
 221 <dl><dt><a name="SharedMobilePageState-RunStory"><strong>RunStory</strong></a>(self, results)</dt></dl>
 222
 223 <dl><dt><a name="SharedMobilePageState-SetPregeneratedProfileArchiveDir"><strong>SetPregeneratedProfileArchiveDir</strong></a>(self, archive_path)</dt><dd><tt>Benchmarks&nbsp;can&nbsp;set&nbsp;a&nbsp;pre-generated&nbsp;profile&nbsp;archive&nbsp;to&nbsp;indicate&nbsp;that&nbsp;when<br>
 224 Chrome&nbsp;is&nbsp;launched,&nbsp;it&nbsp;should&nbsp;have&nbsp;a&nbsp;--user-data-dir&nbsp;set&nbsp;to&nbsp;the<br>
 225 pregenerated&nbsp;profile,&nbsp;rather&nbsp;than&nbsp;to&nbsp;an&nbsp;empty&nbsp;profile.<br>
 226 &nbsp;<br>
 227 If&nbsp;the&nbsp;benchmark&nbsp;is&nbsp;invoked&nbsp;with&nbsp;the&nbsp;option&nbsp;--profile-dir=&lt;dir&gt;,&nbsp;that<br>
 228 option&nbsp;overrides&nbsp;this&nbsp;value.</tt></dd></dl>
 229
 230 <dl><dt><a name="SharedMobilePageState-TearDownState"><strong>TearDownState</strong></a>(self)</dt></dl>
 231
 232 <dl><dt><a name="SharedMobilePageState-WillRunStory"><strong>WillRunStory</strong></a>(self, page)</dt></dl>
 233
 234 <dl><dt><a name="SharedMobilePageState-__init__"><strong>__init__</strong></a>(self, test, finder_options, story_set)</dt></dl>
 235
 236 <hr>
 237 Data descriptors inherited from <a href="telemetry.page.shared_page_state.html#SharedPageState">SharedPageState</a>:<br>
 238 <dl><dt><strong>browser</strong></dt>
 239 </dl>
 240 <dl><dt><strong>current_page</strong></dt>
 241 </dl>
 242 <dl><dt><strong>current_tab</strong></dt>
 243 </dl>
 244 <dl><dt><strong>page_test</strong></dt>
 245 </dl>
 246 <dl><dt><strong>platform</strong></dt>
 247 </dl>
 248 <hr>
 249 Data descriptors inherited from <a href="telemetry.story.shared_state.html#SharedState">telemetry.story.shared_state.SharedState</a>:<br>
 250 <dl><dt><strong>__dict__</strong></dt>
 251 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 252 </dl>
 253 <dl><dt><strong>__weakref__</strong></dt>
 254 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 255 </dl>
 256 </td></tr></table> <p>
 257 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 258 <tr bgcolor="#ffc8d8">
 259 <td colspan=3 valign=bottom>&nbsp;<br>
 260 <font color="#000000" face="helvetica, arial"><a name="SharedPageState">class <strong>SharedPageState</strong></a>(<a href="telemetry.story.shared_state.html#SharedState">telemetry.story.shared_state.SharedState</a>)</font></td></tr>
 261
 262 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
 263 <td colspan=2><tt>This&nbsp;class&nbsp;contains&nbsp;all&nbsp;specific&nbsp;logic&nbsp;necessary&nbsp;to&nbsp;run&nbsp;a&nbsp;Chrome&nbsp;browser<br>
 264 benchmark.<br>&nbsp;</tt></td></tr>
 265 <tr><td>&nbsp;</td>
 266 <td width="100%"><dl><dt>Method resolution order:</dt>
 267 <dd><a href="telemetry.page.shared_page_state.html#SharedPageState">SharedPageState</a></dd>
 268 <dd><a href="telemetry.story.shared_state.html#SharedState">telemetry.story.shared_state.SharedState</a></dd>
 269 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
 270 </dl>
 271 <hr>
 272 Methods defined here:<br>
 273 <dl><dt><a name="SharedPageState-CanRunOnBrowser"><strong>CanRunOnBrowser</strong></a>(self, browser_info, page)</dt><dd><tt>Override&nbsp;this&nbsp;to&nbsp;return&nbsp;whether&nbsp;the&nbsp;browser&nbsp;brought&nbsp;up&nbsp;by&nbsp;this&nbsp;state<br>
 274 instance&nbsp;is&nbsp;suitable&nbsp;for&nbsp;running&nbsp;the&nbsp;given&nbsp;page.<br>
 275 &nbsp;<br>
 276 Args:<br>
 277 &nbsp;&nbsp;browser_info:&nbsp;an&nbsp;instance&nbsp;of&nbsp;telemetry.core.browser_info.BrowserInfo<br>
 278 &nbsp;&nbsp;page:&nbsp;an&nbsp;instance&nbsp;of&nbsp;telemetry.page.Page</tt></dd></dl>
 279
 280 <dl><dt><a name="SharedPageState-CanRunStory"><strong>CanRunStory</strong></a>(self, page)</dt></dl>
 281
 282 <dl><dt><a name="SharedPageState-DidRunStory"><strong>DidRunStory</strong></a>(self, results)</dt></dl>
 283
 284 <dl><dt><a name="SharedPageState-GetPregeneratedProfileArchiveDir"><strong>GetPregeneratedProfileArchiveDir</strong></a>(self)</dt></dl>
 285
 286 <dl><dt><a name="SharedPageState-RunStory"><strong>RunStory</strong></a>(self, results)</dt></dl>
 287
 288 <dl><dt><a name="SharedPageState-SetPregeneratedProfileArchiveDir"><strong>SetPregeneratedProfileArchiveDir</strong></a>(self, archive_path)</dt><dd><tt>Benchmarks&nbsp;can&nbsp;set&nbsp;a&nbsp;pre-generated&nbsp;profile&nbsp;archive&nbsp;to&nbsp;indicate&nbsp;that&nbsp;when<br>
 289 Chrome&nbsp;is&nbsp;launched,&nbsp;it&nbsp;should&nbsp;have&nbsp;a&nbsp;--user-data-dir&nbsp;set&nbsp;to&nbsp;the<br>
 290 pregenerated&nbsp;profile,&nbsp;rather&nbsp;than&nbsp;to&nbsp;an&nbsp;empty&nbsp;profile.<br>
 291 &nbsp;<br>
 292 If&nbsp;the&nbsp;benchmark&nbsp;is&nbsp;invoked&nbsp;with&nbsp;the&nbsp;option&nbsp;--profile-dir=&lt;dir&gt;,&nbsp;that<br>
 293 option&nbsp;overrides&nbsp;this&nbsp;value.</tt></dd></dl>
 294
 295 <dl><dt><a name="SharedPageState-TearDownState"><strong>TearDownState</strong></a>(self)</dt></dl>
 296
 297 <dl><dt><a name="SharedPageState-WillRunStory"><strong>WillRunStory</strong></a>(self, page)</dt></dl>
 298
 299 <dl><dt><a name="SharedPageState-__init__"><strong>__init__</strong></a>(self, test, finder_options, story_set)</dt></dl>
 300
 301 <hr>
 302 Data descriptors defined here:<br>
 303 <dl><dt><strong>browser</strong></dt>
 304 </dl>
 305 <dl><dt><strong>current_page</strong></dt>
 306 </dl>
 307 <dl><dt><strong>current_tab</strong></dt>
 308 </dl>
 309 <dl><dt><strong>page_test</strong></dt>
 310 </dl>
 311 <dl><dt><strong>platform</strong></dt>
 312 </dl>
 313 <hr>
 314 Data descriptors inherited from <a href="telemetry.story.shared_state.html#SharedState">telemetry.story.shared_state.SharedState</a>:<br>
 315 <dl><dt><strong>__dict__</strong></dt>
 316 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 317 </dl>
 318 <dl><dt><strong>__weakref__</strong></dt>
 319 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 320 </dl>
 321 </td></tr></table> <p>
 322 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 323 <tr bgcolor="#ffc8d8">
 324 <td colspan=3 valign=bottom>&nbsp;<br>
 325 <font color="#000000" face="helvetica, arial"><a name="SharedTabletPageState">class <strong>SharedTabletPageState</strong></a>(<a href="telemetry.page.shared_page_state.html#SharedPageState">SharedPageState</a>)</font></td></tr>
 326
 327 <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 328 <td width="100%"><dl><dt>Method resolution order:</dt>
 329 <dd><a href="telemetry.page.shared_page_state.html#SharedTabletPageState">SharedTabletPageState</a></dd>
 330 <dd><a href="telemetry.page.shared_page_state.html#SharedPageState">SharedPageState</a></dd>
 331 <dd><a href="telemetry.story.shared_state.html#SharedState">telemetry.story.shared_state.SharedState</a></dd>
 332 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
 333 </dl>
 334 <hr>
 335 Methods inherited from <a href="telemetry.page.shared_page_state.html#SharedPageState">SharedPageState</a>:<br>
 336 <dl><dt><a name="SharedTabletPageState-CanRunOnBrowser"><strong>CanRunOnBrowser</strong></a>(self, browser_info, page)</dt><dd><tt>Override&nbsp;this&nbsp;to&nbsp;return&nbsp;whether&nbsp;the&nbsp;browser&nbsp;brought&nbsp;up&nbsp;by&nbsp;this&nbsp;state<br>
 337 instance&nbsp;is&nbsp;suitable&nbsp;for&nbsp;running&nbsp;the&nbsp;given&nbsp;page.<br>
 338 &nbsp;<br>
 339 Args:<br>
 340 &nbsp;&nbsp;browser_info:&nbsp;an&nbsp;instance&nbsp;of&nbsp;telemetry.core.browser_info.BrowserInfo<br>
 341 &nbsp;&nbsp;page:&nbsp;an&nbsp;instance&nbsp;of&nbsp;telemetry.page.Page</tt></dd></dl>
 342
 343 <dl><dt><a name="SharedTabletPageState-CanRunStory"><strong>CanRunStory</strong></a>(self, page)</dt></dl>
 344
 345 <dl><dt><a name="SharedTabletPageState-DidRunStory"><strong>DidRunStory</strong></a>(self, results)</dt></dl>
 346
 347 <dl><dt><a name="SharedTabletPageState-GetPregeneratedProfileArchiveDir"><strong>GetPregeneratedProfileArchiveDir</strong></a>(self)</dt></dl>
 348
 349 <dl><dt><a name="SharedTabletPageState-RunStory"><strong>RunStory</strong></a>(self, results)</dt></dl>
 350
 351 <dl><dt><a name="SharedTabletPageState-SetPregeneratedProfileArchiveDir"><strong>SetPregeneratedProfileArchiveDir</strong></a>(self, archive_path)</dt><dd><tt>Benchmarks&nbsp;can&nbsp;set&nbsp;a&nbsp;pre-generated&nbsp;profile&nbsp;archive&nbsp;to&nbsp;indicate&nbsp;that&nbsp;when<br>
 352 Chrome&nbsp;is&nbsp;launched,&nbsp;it&nbsp;should&nbsp;have&nbsp;a&nbsp;--user-data-dir&nbsp;set&nbsp;to&nbsp;the<br>
 353 pregenerated&nbsp;profile,&nbsp;rather&nbsp;than&nbsp;to&nbsp;an&nbsp;empty&nbsp;profile.<br>
 354 &nbsp;<br>
 355 If&nbsp;the&nbsp;benchmark&nbsp;is&nbsp;invoked&nbsp;with&nbsp;the&nbsp;option&nbsp;--profile-dir=&lt;dir&gt;,&nbsp;that<br>
 356 option&nbsp;overrides&nbsp;this&nbsp;value.</tt></dd></dl>
 357
 358 <dl><dt><a name="SharedTabletPageState-TearDownState"><strong>TearDownState</strong></a>(self)</dt></dl>
 359
 360 <dl><dt><a name="SharedTabletPageState-WillRunStory"><strong>WillRunStory</strong></a>(self, page)</dt></dl>
 361
 362 <dl><dt><a name="SharedTabletPageState-__init__"><strong>__init__</strong></a>(self, test, finder_options, story_set)</dt></dl>
 363
 364 <hr>
 365 Data descriptors inherited from <a href="telemetry.page.shared_page_state.html#SharedPageState">SharedPageState</a>:<br>
 366 <dl><dt><strong>browser</strong></dt>
 367 </dl>
 368 <dl><dt><strong>current_page</strong></dt>
 369 </dl>
 370 <dl><dt><strong>current_tab</strong></dt>
 371 </dl>
 372 <dl><dt><strong>page_test</strong></dt>
 373 </dl>
 374 <dl><dt><strong>platform</strong></dt>
 375 </dl>
 376 <hr>
 377 Data descriptors inherited from <a href="telemetry.story.shared_state.html#SharedState">telemetry.story.shared_state.SharedState</a>:<br>
 378 <dl><dt><strong>__dict__</strong></dt>
 379 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 380 </dl>
 381 <dl><dt><strong>__weakref__</strong></dt>
 382 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 383 </dl>
 384 </td></tr></table></td></tr></table>
 385 </body></html>