tools/telemetry/docs/telemetry.core.platform.html - Issue 17150002: [telemetry] Initial (autogenerated) documentation plus support scripts

Side by Side Diff: tools/telemetry/docs/telemetry.core.platform.html

Issue 17150002: [telemetry] Initial (autogenerated) documentation plus support scripts (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: update with nits Created 7 years, 6 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch | Annotate | Revision Log

« no previous file with comments | « tools/telemetry/docs/telemetry.core.memory_cache_http_server.html ('k') | tools/telemetry/docs/telemetry.core.platform.android_platform_backend.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

OLD	NEW
(Empty)
	1

	2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

	3 <html><head><title>Python: package telemetry.core.platform</title>

	4 </head><body bgcolor="#f0f0f8">

	5

	6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">

	7 <tr bgcolor="#7799ee">

	8 <td valign=bottom> <br>

	9 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a hre f="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry .core.html"><font color="#ffffff">core</font></a>.platform</strong></big></big>< /font></td

	10 ><td align=right valign=bottom

	11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/__in it__.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/_ _init__.py</a></font></td></tr></table>

	12 <p><tt># Copyright (c) 2012 The Chromium Autho rs. All rights reserved.<br>

	13 # Use of this source code is governed by  a BSD-style license that can be<br>

	14 # found in the LICENSE file.</tt></p>

	15 <p>

	16 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

	17 <tr bgcolor="#aa55cc">

	18 <td colspan=3 valign=bottom> <br>

	19 <font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</str ong></big></font></td></tr>

	20

	21 <tr><td bgcolor="#aa55cc"><tt>      </tt></td><td>  </td>

	22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="telemetry.core.platform.android_platform_backend.html">android_platf orm_backend</a><br>

	23 <a href="telemetry.core.platform.cros_platform_backend.html">cros_platform_backe nd</a><br>

	24 <a href="telemetry.core.platform.linux_platform_backend.html">linux_platform_bac kend</a><br>

	25 </td><td width="25%" valign=top><a href="telemetry.core.platform.mac_platform_ba ckend.html">mac_platform_backend</a><br>

	26 <a href="telemetry.core.platform.platform_backend.html">platform_backend</a><br>

	27 <a href="telemetry.core.platform.posix_platform_backend.html">posix_platform_bac kend</a><br>

	28 </td><td width="25%" valign=top><a href="telemetry.core.platform.posix_platform_ backend_unittest.html">posix_platform_backend_unittest</a><br>

	29 <a href="telemetry.core.platform.profiler.html"><strong>profiler</strong> ( package)</a><br>

	30 <a href="telemetry.core.platform.win_platform_backend.html">win_platform_backend </a><br>

	31 </td><td width="25%" valign=top></td></tr></table></td></tr></table><p>

	32 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

	33 <tr bgcolor="#ee77aa">

	34 <td colspan=3 valign=bottom> <br>

	35 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big ></font></td></tr>

	36

	37 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td>  </td>

	38 <td width="100%"><dl>

	39 <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__. object</a>

	40 </font></dt><dd>

	41 <dl>

	42 <dt><font face="helvetica, arial"><a href="telemetry.core.platform.html#Platform ">Platform</a>

	43 </font></dt></dl>

	44 </dd>

	45 </dl>

	46 <p>

	47 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

	48 <tr bgcolor="#ffc8d8">

	49 <td colspan=3 valign=bottom> <br>

	50 <font color="#000000" face="helvetica, arial"><a name="Platform">class <strong>P latform</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</ font></td></tr>

	51

	52 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>

	53 <td colspan=2><tt>The platform that the target browser& nbsp;is running on.<br>

	54  <br>

	55 Provides a limited interface to interact with&nbsp ;the platform itself, where<br>

	56 possible. It's important to note that platforms&nb sp;may not provide a specific<br>

	57 API, so check with IsFooBar() for availability.<br > </tt></td></tr>

	58 <tr><td> </td>

	59 <td width="100%">Methods defined here:<br>

	60 <dl><dt><a name="Platform-CanMonitorThermalThrottling"><strong>CanMonitorThermal Throttling</strong></a>(self)</dt><dd><tt>Platforms may be able&n bsp;to detect thermal throttling.<br>

	61  <br>

	62 Some fan-less computers go into a reduced per formance mode when their heat<br>

	63 exceeds a certain threshold. Performance tests in& nbsp;particular should use this<br>

	64 API to detect if this has happened and i nterpret results accordingly.</tt></dd></dl>

	65

	66 <dl><dt><a name="Platform-GetOSName"><strong>GetOSName</strong></a>(self)</dt><d d><tt>Returns a string description of the <a href= "#Platform">Platform</a> OS.<br>

	67  <br>

	68 Examples: WIN, MAC, LINUX, CHROMEOS</tt></dd></dl>

	69

	70 <dl><dt><a name="Platform-GetOSVersionName"><strong>GetOSVersionName</strong></a >(self)</dt><dd><tt>Returns a string description of the  <a href="#Platform">Platform</a> OS version.<br>

	71  <br>

	72 Examples: VISTA, WIN7, LION, MOUNTAINLION</tt></dd></dl>

	73

	74 <dl><dt><a name="Platform-GetRawDisplayFrameRateMeasurements"><strong>GetRawDisp layFrameRateMeasurements</strong></a>(self)</dt><dd><tt>Returns a list  of RawDisplayFrameRateMeasurement.</tt></dd></dl>

	75

	76 <dl><dt><a name="Platform-HasBeenThermallyThrottled"><strong>HasBeenThermallyThr ottled</strong></a>(self)</dt><dd><tt>Returns True if the de vice has been thermally throttled.</tt></dd></dl>

	77

	78 <dl><dt><a name="Platform-IsRawDisplayFrameRateSupported"><strong>IsRawDisplayFr ameRateSupported</strong></a>(self)</dt><dd><tt>Platforms may be  able to collect GL surface stats.</tt></dd></dl>

	79

	80 <dl><dt><a name="Platform-IsThermallyThrottled"><strong>IsThermallyThrottled</st rong></a>(self)</dt><dd><tt>Returns True if the device  is currently thermally throttled.</tt></dd></dl>

	81

	82 <dl><dt><a name="Platform-SetFullPerformanceModeEnabled"><strong>SetFullPerforma nceModeEnabled</strong></a>(self, enabled)</dt><dd><tt>Platforms may t weak their CPU governor, system status, etc.<br>

	83  <br>

	84 Most platforms can operate in a battery savin g mode. While good for battery<br>

	85 life, this can cause confusing performance results  and add noise. Turning<br>

	86 full performance mode on disables these features,& nbsp;which is useful for<br>

	87 performance testing.</tt></dd></dl>

	88

	89 <dl><dt><a name="Platform-StartRawDisplayFrameRateMeasurement"><strong>StartRawD isplayFrameRateMeasurement</strong></a>(self)</dt><dd><tt>Start measuring&n bsp;GL surface stats.</tt></dd></dl>

	90

	91 <dl><dt><a name="Platform-StopRawDisplayFrameRateMeasurement"><strong>StopRawDis playFrameRateMeasurement</strong></a>(self)</dt><dd><tt>Stop measuring&nbsp ;GL surface stats.</tt></dd></dl>

	92

	93 <dl><dt><a name="Platform-__init__"><strong>__init__</strong></a>(self, platform _backend)</dt></dl>

	94

	95 <hr>

	96 Data descriptors defined here:<br>

	97 <dl><dt><strong>__dict__</strong></dt>

	98 <dd><tt>dictionary for instance variables (if defined)< /tt></dd>

	99 </dl>

	100 <dl><dt><strong>__weakref__</strong></dt>

	101 <dd><tt>list of weak references to the object&nbsp ;(if defined)</tt></dd>

	102 </dl>

	103 <hr>

	104 Data and other attributes defined here:<br>

	105 <dl><dt><strong>RawDisplayFrameRateMeasurement</strong> = <class 'telemetry.c ore.platform.RawDisplayFrameRateMeasurement'></dl>

	106

	107 </td></tr></table></td></tr></table>

	108 </body></html>

OLD	NEW