Home | History | Annotate | Download | only in docs
      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>&nbsp;<br>
      9 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="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="../telemetry/core/platform/__init__.py">telemetry/core/platform/__init__.py</a></font></td></tr></table>
     12     <p><tt>#&nbsp;Copyright&nbsp;(c)&nbsp;2012&nbsp;The&nbsp;Chromium&nbsp;Authors.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
     13 #&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>
     14 #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;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>&nbsp;<br>
     19 <font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
     20     
     21 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
     22 <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><br>
     23 <a href="telemetry.core.platform.cros_platform_backend.html">cros_platform_backend</a><br>
     24 <a href="telemetry.core.platform.linux_platform_backend.html">linux_platform_backend</a><br>
     25 </td><td width="25%" valign=top><a href="telemetry.core.platform.mac_platform_backend.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_backend</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>&nbsp;(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>&nbsp;<br>
     35 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
     36     
     37 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</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>&nbsp;<br>
     50 <font color="#000000" face="helvetica, arial"><a name="Platform">class <strong>Platform</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
     51     
     52 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
     53 <td colspan=2><tt>The&nbsp;platform&nbsp;that&nbsp;the&nbsp;target&nbsp;browser&nbsp;is&nbsp;running&nbsp;on.<br>
     54 &nbsp;<br>
     55 Provides&nbsp;a&nbsp;limited&nbsp;interface&nbsp;to&nbsp;interact&nbsp;with&nbsp;the&nbsp;platform&nbsp;itself,&nbsp;where<br>
     56 possible.&nbsp;It's&nbsp;important&nbsp;to&nbsp;note&nbsp;that&nbsp;platforms&nbsp;may&nbsp;not&nbsp;provide&nbsp;a&nbsp;specific<br>
     57 API,&nbsp;so&nbsp;check&nbsp;with&nbsp;IsFooBar()&nbsp;for&nbsp;availability.<br>&nbsp;</tt></td></tr>
     58 <tr><td>&nbsp;</td>
     59 <td width="100%">Methods defined here:<br>
     60 <dl><dt><a name="Platform-CanMonitorThermalThrottling"><strong>CanMonitorThermalThrottling</strong></a>(self)</dt><dd><tt>Platforms&nbsp;may&nbsp;be&nbsp;able&nbsp;to&nbsp;detect&nbsp;thermal&nbsp;throttling.<br>
     61 &nbsp;<br>
     62 Some&nbsp;fan-less&nbsp;computers&nbsp;go&nbsp;into&nbsp;a&nbsp;reduced&nbsp;performance&nbsp;mode&nbsp;when&nbsp;their&nbsp;heat<br>
     63 exceeds&nbsp;a&nbsp;certain&nbsp;threshold.&nbsp;Performance&nbsp;tests&nbsp;in&nbsp;particular&nbsp;should&nbsp;use&nbsp;this<br>
     64 API&nbsp;to&nbsp;detect&nbsp;if&nbsp;this&nbsp;has&nbsp;happened&nbsp;and&nbsp;interpret&nbsp;results&nbsp;accordingly.</tt></dd></dl>
     65 
     66 <dl><dt><a name="Platform-GetOSName"><strong>GetOSName</strong></a>(self)</dt><dd><tt>Returns&nbsp;a&nbsp;string&nbsp;description&nbsp;of&nbsp;the&nbsp;<a href="#Platform">Platform</a>&nbsp;OS.<br>
     67 &nbsp;<br>
     68 Examples:&nbsp;WIN,&nbsp;MAC,&nbsp;LINUX,&nbsp;CHROMEOS</tt></dd></dl>
     69 
     70 <dl><dt><a name="Platform-GetOSVersionName"><strong>GetOSVersionName</strong></a>(self)</dt><dd><tt>Returns&nbsp;a&nbsp;string&nbsp;description&nbsp;of&nbsp;the&nbsp;<a href="#Platform">Platform</a>&nbsp;OS&nbsp;version.<br>
     71 &nbsp;<br>
     72 Examples:&nbsp;VISTA,&nbsp;WIN7,&nbsp;LION,&nbsp;MOUNTAINLION</tt></dd></dl>
     73 
     74 <dl><dt><a name="Platform-GetRawDisplayFrameRateMeasurements"><strong>GetRawDisplayFrameRateMeasurements</strong></a>(self)</dt><dd><tt>Returns&nbsp;a&nbsp;list&nbsp;of&nbsp;RawDisplayFrameRateMeasurement.</tt></dd></dl>
     75 
     76 <dl><dt><a name="Platform-HasBeenThermallyThrottled"><strong>HasBeenThermallyThrottled</strong></a>(self)</dt><dd><tt>Returns&nbsp;True&nbsp;if&nbsp;the&nbsp;device&nbsp;has&nbsp;been&nbsp;thermally&nbsp;throttled.</tt></dd></dl>
     77 
     78 <dl><dt><a name="Platform-IsRawDisplayFrameRateSupported"><strong>IsRawDisplayFrameRateSupported</strong></a>(self)</dt><dd><tt>Platforms&nbsp;may&nbsp;be&nbsp;able&nbsp;to&nbsp;collect&nbsp;GL&nbsp;surface&nbsp;stats.</tt></dd></dl>
     79 
     80 <dl><dt><a name="Platform-IsThermallyThrottled"><strong>IsThermallyThrottled</strong></a>(self)</dt><dd><tt>Returns&nbsp;True&nbsp;if&nbsp;the&nbsp;device&nbsp;is&nbsp;currently&nbsp;thermally&nbsp;throttled.</tt></dd></dl>
     81 
     82 <dl><dt><a name="Platform-SetFullPerformanceModeEnabled"><strong>SetFullPerformanceModeEnabled</strong></a>(self, enabled)</dt><dd><tt>Platforms&nbsp;may&nbsp;tweak&nbsp;their&nbsp;CPU&nbsp;governor,&nbsp;system&nbsp;status,&nbsp;etc.<br>
     83 &nbsp;<br>
     84 Most&nbsp;platforms&nbsp;can&nbsp;operate&nbsp;in&nbsp;a&nbsp;battery&nbsp;saving&nbsp;mode.&nbsp;While&nbsp;good&nbsp;for&nbsp;battery<br>
     85 life,&nbsp;this&nbsp;can&nbsp;cause&nbsp;confusing&nbsp;performance&nbsp;results&nbsp;and&nbsp;add&nbsp;noise.&nbsp;Turning<br>
     86 full&nbsp;performance&nbsp;mode&nbsp;on&nbsp;disables&nbsp;these&nbsp;features,&nbsp;which&nbsp;is&nbsp;useful&nbsp;for<br>
     87 performance&nbsp;testing.</tt></dd></dl>
     88 
     89 <dl><dt><a name="Platform-StartRawDisplayFrameRateMeasurement"><strong>StartRawDisplayFrameRateMeasurement</strong></a>(self)</dt><dd><tt>Start&nbsp;measuring&nbsp;GL&nbsp;surface&nbsp;stats.</tt></dd></dl>
     90 
     91 <dl><dt><a name="Platform-StopRawDisplayFrameRateMeasurement"><strong>StopRawDisplayFrameRateMeasurement</strong></a>(self)</dt><dd><tt>Stop&nbsp;measuring&nbsp;GL&nbsp;surface&nbsp;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&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
     99 </dl>
    100 <dl><dt><strong>__weakref__</strong></dt>
    101 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
    102 </dl>
    103 <hr>
    104 Data and other attributes defined here:<br>
    105 <dl><dt><strong>RawDisplayFrameRateMeasurement</strong> = &lt;class 'telemetry.core.platform.RawDisplayFrameRateMeasurement'&gt;</dl>
    106 
    107 </td></tr></table></td></tr></table>
    108 </body></html>