Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(740)

Side by Side Diff: tools/telemetry/docs/pydoc/telemetry.web_perf.metrics.timeline_based_metric.html

Issue 1647513002: Delete tools/telemetry. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Created 4 years, 11 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
OLDNEW
(Empty)
1
2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3 <html><head><title>Python: module telemetry.web_perf.metrics.timeline_based_metr ic</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 hre f="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry .web_perf.html"><font color="#ffffff">web_perf</font></a>.<a href="telemetry.web _perf.metrics.html"><font color="#ffffff">metrics</font></a>.timeline_based_metr ic</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/web_perf/metrics/timeline_based_metric.py">telemetry/web_perf/metr ics/timeline_based_metric.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="#ee77aa">
19 <td colspan=3 valign=bottom>&nbsp;<br>
20 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big ></font></td></tr>
21
22 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td>
23 <td width="100%"><dl>
24 <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__. object</a>
25 </font></dt><dd>
26 <dl>
27 <dt><font face="helvetica, arial"><a href="telemetry.web_perf.metrics.timeline_b ased_metric.html#TimelineBasedMetric">TimelineBasedMetric</a>
28 </font></dt></dl>
29 </dd>
30 <dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions .Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException< /a>)
31 </font></dt><dd>
32 <dl>
33 <dt><font face="helvetica, arial"><a href="telemetry.web_perf.metrics.timeline_b ased_metric.html#TimelineBasedMetricException">TimelineBasedMetricException</a>
34 </font></dt></dl>
35 </dd>
36 </dl>
37 <p>
38 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
39 <tr bgcolor="#ffc8d8">
40 <td colspan=3 valign=bottom>&nbsp;<br>
41 <font color="#000000" face="helvetica, arial"><a name="TimelineBasedMetric">clas s <strong>TimelineBasedMetric</strong></a>(<a href="__builtin__.html#object">__b uiltin__.object</a>)</font></td></tr>
42
43 <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
44 <td width="100%">Methods defined here:<br>
45 <dl><dt><a name="TimelineBasedMetric-AddResults"><strong>AddResults</strong></a> (self, model, renderer_thread, interaction_records, results)</dt><dd><tt>Compute s&nbsp;and&nbsp;adds&nbsp;metrics&nbsp;for&nbsp;the&nbsp;interaction_records'&nb sp;time&nbsp;ranges.<br>
46 &nbsp;<br>
47 The&nbsp;override&nbsp;of&nbsp;this&nbsp;method&nbsp;should&nbsp;compute&nbsp;re sults&nbsp;on&nbsp;the&nbsp;data&nbsp;**only**<br>
48 within&nbsp;the&nbsp;interaction_records'&nbsp;start&nbsp;and&nbsp;end&nbsp;time &nbsp;ranges.<br>
49 &nbsp;<br>
50 Args:<br>
51 &nbsp;&nbsp;model:&nbsp;An&nbsp;instance&nbsp;of&nbsp;telemetry.timeline.model.T imelineModel.<br>
52 &nbsp;&nbsp;interaction_records:&nbsp;A&nbsp;list&nbsp;of&nbsp;instances&nbsp;of &nbsp;TimelineInteractionRecord.&nbsp;If<br>
53 &nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;override&nbsp;of&nbsp;this&nbsp;method&nbsp;doe sn't&nbsp;support&nbsp;overlapped&nbsp;ranges,&nbsp;use<br>
54 &nbsp;&nbsp;&nbsp;&nbsp;VerifyNonOverlappedRecords&nbsp;to&nbsp;check&nbsp;that& nbsp;no&nbsp;records&nbsp;are&nbsp;overlapped.<br>
55 &nbsp;&nbsp;results:&nbsp;An&nbsp;instance&nbsp;of&nbsp;page.PageTestResults.</t t></dd></dl>
56
57 <dl><dt><a name="TimelineBasedMetric-AddWholeTraceResults"><strong>AddWholeTrace Results</strong></a>(self, model, results)</dt><dd><tt>Computes&nbsp;and&nbsp;ad ds&nbsp;metrics&nbsp;corresponding&nbsp;to&nbsp;the&nbsp;entire&nbsp;trace.<br>
58 &nbsp;<br>
59 Override&nbsp;this&nbsp;method&nbsp;to&nbsp;compute&nbsp;results&nbsp;that&nbsp; correspond&nbsp;to&nbsp;the&nbsp;whole&nbsp;trace.<br>
60 &nbsp;<br>
61 Args:<br>
62 &nbsp;&nbsp;model:&nbsp;An&nbsp;instance&nbsp;of&nbsp;telemetry.timeline.model.T imelineModel.<br>
63 &nbsp;&nbsp;results:&nbsp;An&nbsp;instance&nbsp;of&nbsp;page.PageTestResults.</t t></dd></dl>
64
65 <dl><dt><a name="TimelineBasedMetric-VerifyNonOverlappedRecords"><strong>VerifyN onOverlappedRecords</strong></a>(self, interaction_records)</dt><dd><tt>This&nbs p;raises&nbsp;exceptions&nbsp;if&nbsp;interaction_records&nbsp;contain&nbsp;over lapped&nbsp;ranges.</tt></dd></dl>
66
67 <dl><dt><a name="TimelineBasedMetric-__init__"><strong>__init__</strong></a>(sel f)</dt><dd><tt>Computes&nbsp;metrics&nbsp;from&nbsp;a&nbsp;telemetry.timeline&nb sp;Model&nbsp;and&nbsp;a&nbsp;range</tt></dd></dl>
68
69 <hr>
70 Data descriptors defined here:<br>
71 <dl><dt><strong>__dict__</strong></dt>
72 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)< /tt></dd>
73 </dl>
74 <dl><dt><strong>__weakref__</strong></dt>
75 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp ;(if&nbsp;defined)</tt></dd>
76 </dl>
77 </td></tr></table> <p>
78 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
79 <tr bgcolor="#ffc8d8">
80 <td colspan=3 valign=bottom>&nbsp;<br>
81 <font color="#000000" face="helvetica, arial"><a name="TimelineBasedMetricExcept ion">class <strong>TimelineBasedMetricException</strong></a>(<a href="exceptions .html#Exception">exceptions.Exception</a>)</font></td></tr>
82
83 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
84 <td colspan=2><tt><a href="exceptions.html#Exception">Exception</a>&nbsp;that&nb sp;can&nbsp;be&nbsp;thrown&nbsp;from&nbsp;metrics&nbsp;that&nbsp;implements<br>
85 <a href="#TimelineBasedMetric">TimelineBasedMetric</a>&nbsp;to&nbsp;indicate&nbs p;a&nbsp;problem&nbsp;arised&nbsp;when&nbsp;computing&nbsp;the&nbsp;metric.<br>& nbsp;</tt></td></tr>
86 <tr><td>&nbsp;</td>
87 <td width="100%"><dl><dt>Method resolution order:</dt>
88 <dd><a href="telemetry.web_perf.metrics.timeline_based_metric.html#TimelineBased MetricException">TimelineBasedMetricException</a></dd>
89 <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
90 <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
91 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
92 </dl>
93 <hr>
94 Data descriptors defined here:<br>
95 <dl><dt><strong>__weakref__</strong></dt>
96 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp ;(if&nbsp;defined)</tt></dd>
97 </dl>
98 <hr>
99 Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception< /a>:<br>
100 <dl><dt><a name="TimelineBasedMetricException-__init__"><strong>__init__</strong ></a>(...)</dt><dd><tt>x.<a href="#TimelineBasedMetricException-__init__">__init __</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;help(type(x))&nbsp;for&nbsp;s ignature</tt></dd></dl>
101
102 <hr>
103 Data and other attributes inherited from <a href="exceptions.html#Exception">exc eptions.Exception</a>:<br>
104 <dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt ;<dd><tt>T.<a href="#TimelineBasedMetricException-__new__">__new__</a>(S,&nbsp;. ..)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;<a href="__builtin__.html#object">object</a> &nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
105
106 <hr>
107 Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseEx ception</a>:<br>
108 <dl><dt><a name="TimelineBasedMetricException-__delattr__"><strong>__delattr__</ strong></a>(...)</dt><dd><tt>x.<a href="#TimelineBasedMetricException-__delattr_ _">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
109
110 <dl><dt><a name="TimelineBasedMetricException-__getattribute__"><strong>__getatt ribute__</strong></a>(...)</dt><dd><tt>x.<a href="#TimelineBasedMetricException- __getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt>< /dd></dl>
111
112 <dl><dt><a name="TimelineBasedMetricException-__getitem__"><strong>__getitem__</ strong></a>(...)</dt><dd><tt>x.<a href="#TimelineBasedMetricException-__getitem_ _">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
113
114 <dl><dt><a name="TimelineBasedMetricException-__getslice__"><strong>__getslice__ </strong></a>(...)</dt><dd><tt>x.<a href="#TimelineBasedMetricException-__getsli ce__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
115 &nbsp;<br>
116 Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd ></dl>
117
118 <dl><dt><a name="TimelineBasedMetricException-__reduce__"><strong>__reduce__</st rong></a>(...)</dt></dl>
119
120 <dl><dt><a name="TimelineBasedMetricException-__repr__"><strong>__repr__</strong ></a>(...)</dt><dd><tt>x.<a href="#TimelineBasedMetricException-__repr__">__repr __</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
121
122 <dl><dt><a name="TimelineBasedMetricException-__setattr__"><strong>__setattr__</ strong></a>(...)</dt><dd><tt>x.<a href="#TimelineBasedMetricException-__setattr_ _">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;v alue</tt></dd></dl>
123
124 <dl><dt><a name="TimelineBasedMetricException-__setstate__"><strong>__setstate__ </strong></a>(...)</dt></dl>
125
126 <dl><dt><a name="TimelineBasedMetricException-__str__"><strong>__str__</strong>< /a>(...)</dt><dd><tt>x.<a href="#TimelineBasedMetricException-__str__">__str__</ a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
127
128 <dl><dt><a name="TimelineBasedMetricException-__unicode__"><strong>__unicode__</ strong></a>(...)</dt></dl>
129
130 <hr>
131 Data descriptors inherited from <a href="exceptions.html#BaseException">exceptio ns.BaseException</a>:<br>
132 <dl><dt><strong>__dict__</strong></dt>
133 </dl>
134 <dl><dt><strong>args</strong></dt>
135 </dl>
136 <dl><dt><strong>message</strong></dt>
137 </dl>
138 </td></tr></table></td></tr></table><p>
139 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
140 <tr bgcolor="#eeaa77">
141 <td colspan=3 valign=bottom>&nbsp;<br>
142 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></b ig></font></td></tr>
143
144 <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td> &nbsp;</td>
145 <td width="100%"><dl><dt><a name="-IsEventInInteractions"><strong>IsEventInInter actions</strong></a>(event, interaction_records)</dt><dd><tt>Return&nbsp;True&nb sp;if&nbsp;event&nbsp;is&nbsp;in&nbsp;any&nbsp;of&nbsp;the&nbsp;interaction&nbsp ;records'&nbsp;time&nbsp;range.<br>
146 &nbsp;<br>
147 Args:<br>
148 &nbsp;&nbsp;event:&nbsp;an&nbsp;instance&nbsp;of&nbsp;telemetry.timeline.event.T imelineEvent.<br>
149 &nbsp;&nbsp;interaction_records:&nbsp;a&nbsp;list&nbsp;of&nbsp;interaction&nbsp; records,&nbsp;whereas&nbsp;each&nbsp;record&nbsp;is<br>
150 &nbsp;&nbsp;&nbsp;&nbsp;an&nbsp;instance&nbsp;of<br>
151 &nbsp;&nbsp;&nbsp;&nbsp;telemetry.web_perf.timeline_interaction_record.TimelineI nteractionRecord.<br>
152 &nbsp;<br>
153 Returns:<br>
154 &nbsp;&nbsp;True&nbsp;if&nbsp;|event|'s&nbsp;start&nbsp;&amp;&nbsp;end&nbsp;time &nbsp;is&nbsp;in&nbsp;any&nbsp;of&nbsp;the&nbsp;|interaction_records|'s<br>
155 &nbsp;&nbsp;time&nbsp;range.</tt></dd></dl>
156 </td></tr></table>
157 </body></html>
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698