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

Unified 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 side-by-side diff with in-line comments

Download patch

« 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 »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: tools/telemetry/docs/telemetry.core.platform.html

diff --git a/tools/telemetry/docs/telemetry.core.platform.html b/tools/telemetry/docs/telemetry.core.platform.html

new file mode 100644

index 0000000000000000000000000000000000000000..4a9d9b67e8ff79041fa235db352ddaa510c076f7

--- /dev/null

+++ b/tools/telemetry/docs/telemetry.core.platform.html

@@ -0,0 +1,108 @@

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

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

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

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

+<tr bgcolor="#7799ee">

+<td valign=bottom>

+  <big><big><a href="telemetry.html">telemetry</a>.<a href="telemetry.core.html">core</a>.platform</big></big></td

+><td align=right valign=bottom

+><a href=".">index</a> <a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/__init__.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/__init__.py</a></td></tr></table>

+ <tt># Copyright (c) 2012 The Chromium Authors. All rights reserved.

+# Use of this source code is governed by a BSD-style license that can be

+# found in the LICENSE file.</tt>

+

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

+<tr bgcolor="#aa55cc">

+<td colspan=3 valign=bottom>

+<big>Package Contents</big></td></tr>

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

+<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.core.platform.android_platform_backend.html">android_platform_backend</a>

+<a href="telemetry.core.platform.cros_platform_backend.html">cros_platform_backend</a>

+<a href="telemetry.core.platform.linux_platform_backend.html">linux_platform_backend</a>

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

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

+<a href="telemetry.core.platform.posix_platform_backend.html">posix_platform_backend</a>

+</td><td width="25%" valign=top><a href="telemetry.core.platform.posix_platform_backend_unittest.html">posix_platform_backend_unittest</a>

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

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

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

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

+<tr bgcolor="#ee77aa">

+<td colspan=3 valign=bottom>

+<big>Classes</big></td></tr>

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

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

+<dt><a href="__builtin__.html#object">__builtin__.object</a>

+</dt><dd>

+<dl>

+<dt><a href="telemetry.core.platform.html#Platform">Platform</a>

+</dt></dl>

+</dd>

+</dl>

+

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

+<tr bgcolor="#ffc8d8">

+<td colspan=3 valign=bottom>

+<a name="Platform">class Platform</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

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

+<td colspan=2><tt>The platform that the target browser is running on.

+

+Provides a limited interface to interact with the platform itself, where

+possible. It's important to note that platforms may not provide a specific

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

+<tr><td> </td>

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

+<dl><dt><a name="Platform-CanMonitorThermalThrottling">CanMonitorThermalThrottling</a>(self)</dt><dd><tt>Platforms may be able to detect thermal throttling.

+

+Some fan-less computers go into a reduced performance mode when their heat

+exceeds a certain threshold. Performance tests in particular should use this

+API to detect if this has happened and interpret results accordingly.</tt></dd></dl>

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

+

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

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

+

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

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

+<dl><dt><a name="Platform-HasBeenThermallyThrottled">HasBeenThermallyThrottled</a>(self)</dt><dd><tt>Returns True if the device has been thermally throttled.</tt></dd></dl>

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

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

+<dl><dt><a name="Platform-SetFullPerformanceModeEnabled">SetFullPerformanceModeEnabled</a>(self, enabled)</dt><dd><tt>Platforms may tweak their CPU governor, system status, etc.

+

+Most platforms can operate in a battery saving mode. While good for battery

+life, this can cause confusing performance results and add noise. Turning

+full performance mode on disables these features, which is useful for

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

+<dl><dt><a name="Platform-StartRawDisplayFrameRateMeasurement">StartRawDisplayFrameRateMeasurement</a>(self)</dt><dd><tt>Start measuring GL surface stats.</tt></dd></dl>

+<dl><dt><a name="Platform-StopRawDisplayFrameRateMeasurement">StopRawDisplayFrameRateMeasurement</a>(self)</dt><dd><tt>Stop measuring GL surface stats.</tt></dd></dl>

+<dl><dt><a name="Platform-__init__">__init__</a>(self, platform_backend)</dt></dl>

+<hr>

+Data descriptors defined here:

+<dl><dt>__dict__</dt>

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

+</dl>

+<dl><dt>__weakref__</dt>

+<dd><tt>list of weak references to the object (if defined)</tt></dd>

+</dl>

+<hr>

+Data and other attributes defined here:

+<dl><dt>RawDisplayFrameRateMeasurement = <class 'telemetry.core.platform.RawDisplayFrameRateMeasurement'></dl>

+</td></tr></table></td></tr></table>

+</body></html>