1 2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 3<html><head><title>Python: module telemetry.timeline.model</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> <br> 10<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.timeline.html"><font color="#ffffff">timeline</font></a>.model</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/timeline/model.py">telemetry/timeline/model.py</a></font></td></tr></table> 13 <p><tt>A container for timeline-based events and traces and can handle importing<br> 14raw event data from different sources. This model closely resembles that in the<br> 15trace_viewer project:<br> 16https://code.google.com/p/trace-viewer/</tt></p> 17<p> 18<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 19<tr bgcolor="#aa55cc"> 20<td colspan=3 valign=bottom> <br> 21<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> 22 23<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> 24<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.timeline.async_slice.html">telemetry.timeline.async_slice</a><br> 25<a href="telemetry.timeline.bounds.html">telemetry.timeline.bounds</a><br> 26<a href="telemetry.timeline.event_container.html">telemetry.timeline.event_container</a><br> 27</td><td width="25%" valign=top><a href="telemetry.timeline.inspector_importer.html">telemetry.timeline.inspector_importer</a><br> 28<a href="telemetry.timeline.process.html">telemetry.timeline.process</a><br> 29<a href="telemetry.timeline.slice.html">telemetry.timeline.slice</a><br> 30</td><td width="25%" valign=top><a href="telemetry.timeline.surface_flinger_importer.html">telemetry.timeline.surface_flinger_importer</a><br> 31<a href="telemetry.timeline.tab_id_importer.html">telemetry.timeline.tab_id_importer</a><br> 32<a href="telemetry.timeline.trace_data.html">telemetry.timeline.trace_data</a><br> 33</td><td width="25%" valign=top><a href="telemetry.timeline.trace_event_importer.html">telemetry.timeline.trace_event_importer</a><br> 34</td></tr></table></td></tr></table><p> 35<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 36<tr bgcolor="#ee77aa"> 37<td colspan=3 valign=bottom> <br> 38<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> 39 40<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> 41<td width="100%"><dl> 42<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>) 43</font></dt><dd> 44<dl> 45<dt><font face="helvetica, arial"><a href="telemetry.timeline.model.html#MarkerMismatchError">MarkerMismatchError</a> 46</font></dt><dt><font face="helvetica, arial"><a href="telemetry.timeline.model.html#MarkerOverlapError">MarkerOverlapError</a> 47</font></dt></dl> 48</dd> 49<dt><font face="helvetica, arial"><a href="telemetry.timeline.event_container.html#TimelineEventContainer">telemetry.timeline.event_container.TimelineEventContainer</a>(<a href="__builtin__.html#object">__builtin__.object</a>) 50</font></dt><dd> 51<dl> 52<dt><font face="helvetica, arial"><a href="telemetry.timeline.model.html#TimelineModel">TimelineModel</a> 53</font></dt></dl> 54</dd> 55</dl> 56 <p> 57<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 58<tr bgcolor="#ffc8d8"> 59<td colspan=3 valign=bottom> <br> 60<font color="#000000" face="helvetica, arial"><a name="MarkerMismatchError">class <strong>MarkerMismatchError</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> 61 62<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> 63<td width="100%"><dl><dt>Method resolution order:</dt> 64<dd><a href="telemetry.timeline.model.html#MarkerMismatchError">MarkerMismatchError</a></dd> 65<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> 66<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> 67<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> 68</dl> 69<hr> 70Methods defined here:<br> 71<dl><dt><a name="MarkerMismatchError-__init__"><strong>__init__</strong></a>(self)</dt></dl> 72 73<hr> 74Data descriptors defined here:<br> 75<dl><dt><strong>__weakref__</strong></dt> 76<dd><tt>list of weak references to the object (if defined)</tt></dd> 77</dl> 78<hr> 79Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> 80<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#MarkerMismatchError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> 81 82<hr> 83Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> 84<dl><dt><a name="MarkerMismatchError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#MarkerMismatchError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> 85 86<dl><dt><a name="MarkerMismatchError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#MarkerMismatchError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> 87 88<dl><dt><a name="MarkerMismatchError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#MarkerMismatchError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> 89 90<dl><dt><a name="MarkerMismatchError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#MarkerMismatchError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> 91 <br> 92Use of negative indices is not supported.</tt></dd></dl> 93 94<dl><dt><a name="MarkerMismatchError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> 95 96<dl><dt><a name="MarkerMismatchError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#MarkerMismatchError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> 97 98<dl><dt><a name="MarkerMismatchError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#MarkerMismatchError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> 99 100<dl><dt><a name="MarkerMismatchError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> 101 102<dl><dt><a name="MarkerMismatchError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#MarkerMismatchError-__str__">__str__</a>() <==> str(x)</tt></dd></dl> 103 104<dl><dt><a name="MarkerMismatchError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> 105 106<hr> 107Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> 108<dl><dt><strong>__dict__</strong></dt> 109</dl> 110<dl><dt><strong>args</strong></dt> 111</dl> 112<dl><dt><strong>message</strong></dt> 113</dl> 114</td></tr></table> <p> 115<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 116<tr bgcolor="#ffc8d8"> 117<td colspan=3 valign=bottom> <br> 118<font color="#000000" face="helvetica, arial"><a name="MarkerOverlapError">class <strong>MarkerOverlapError</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> 119 120<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> 121<td width="100%"><dl><dt>Method resolution order:</dt> 122<dd><a href="telemetry.timeline.model.html#MarkerOverlapError">MarkerOverlapError</a></dd> 123<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> 124<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> 125<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> 126</dl> 127<hr> 128Methods defined here:<br> 129<dl><dt><a name="MarkerOverlapError-__init__"><strong>__init__</strong></a>(self)</dt></dl> 130 131<hr> 132Data descriptors defined here:<br> 133<dl><dt><strong>__weakref__</strong></dt> 134<dd><tt>list of weak references to the object (if defined)</tt></dd> 135</dl> 136<hr> 137Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> 138<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#MarkerOverlapError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl> 139 140<hr> 141Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> 142<dl><dt><a name="MarkerOverlapError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#MarkerOverlapError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> 143 144<dl><dt><a name="MarkerOverlapError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#MarkerOverlapError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> 145 146<dl><dt><a name="MarkerOverlapError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#MarkerOverlapError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> 147 148<dl><dt><a name="MarkerOverlapError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#MarkerOverlapError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> 149 <br> 150Use of negative indices is not supported.</tt></dd></dl> 151 152<dl><dt><a name="MarkerOverlapError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> 153 154<dl><dt><a name="MarkerOverlapError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#MarkerOverlapError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> 155 156<dl><dt><a name="MarkerOverlapError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#MarkerOverlapError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> 157 158<dl><dt><a name="MarkerOverlapError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> 159 160<dl><dt><a name="MarkerOverlapError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#MarkerOverlapError-__str__">__str__</a>() <==> str(x)</tt></dd></dl> 161 162<dl><dt><a name="MarkerOverlapError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> 163 164<hr> 165Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> 166<dl><dt><strong>__dict__</strong></dt> 167</dl> 168<dl><dt><strong>args</strong></dt> 169</dl> 170<dl><dt><strong>message</strong></dt> 171</dl> 172</td></tr></table> <p> 173<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 174<tr bgcolor="#ffc8d8"> 175<td colspan=3 valign=bottom> <br> 176<font color="#000000" face="helvetica, arial"><a name="TimelineModel">class <strong>TimelineModel</strong></a>(<a href="telemetry.timeline.event_container.html#TimelineEventContainer">telemetry.timeline.event_container.TimelineEventContainer</a>)</font></td></tr> 177 178<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> 179<td width="100%"><dl><dt>Method resolution order:</dt> 180<dd><a href="telemetry.timeline.model.html#TimelineModel">TimelineModel</a></dd> 181<dd><a href="telemetry.timeline.event_container.html#TimelineEventContainer">telemetry.timeline.event_container.TimelineEventContainer</a></dd> 182<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> 183</dl> 184<hr> 185Methods defined here:<br> 186<dl><dt><a name="TimelineModel-AddMappingFromTabIdToRendererThread"><strong>AddMappingFromTabIdToRendererThread</strong></a>(self, tab_id, renderer_thread)</dt></dl> 187 188<dl><dt><a name="TimelineModel-FinalizeImport"><strong>FinalizeImport</strong></a>(self, shift_world_to_zero<font color="#909090">=False</font>, importers<font color="#909090">=None</font>)</dt></dl> 189 190<dl><dt><a name="TimelineModel-FindTimelineMarkers"><strong>FindTimelineMarkers</strong></a>(self, timeline_marker_names)</dt><dd><tt>Find the timeline events with the given names.<br> 191 <br> 192If the number and order of events found does not match the names,<br> 193raise an error.</tt></dd></dl> 194 195<dl><dt><a name="TimelineModel-GetAllProcesses"><strong>GetAllProcesses</strong></a>(self)</dt></dl> 196 197<dl><dt><a name="TimelineModel-GetAllThreads"><strong>GetAllThreads</strong></a>(self)</dt></dl> 198 199<dl><dt><a name="TimelineModel-GetOrCreateProcess"><strong>GetOrCreateProcess</strong></a>(self, pid)</dt></dl> 200 201<dl><dt><a name="TimelineModel-GetRendererProcessFromTabId"><strong>GetRendererProcessFromTabId</strong></a>(self, tab_id)</dt></dl> 202 203<dl><dt><a name="TimelineModel-GetRendererThreadFromTabId"><strong>GetRendererThreadFromTabId</strong></a>(self, tab_id)</dt></dl> 204 205<dl><dt><a name="TimelineModel-ImportTraces"><strong>ImportTraces</strong></a>(self, trace_data, shift_world_to_zero<font color="#909090">=True</font>)</dt><dd><tt>Populates the model with the provided trace data.<br> 206 <br> 207trace_data must be an instance of TraceData.<br> 208 <br> 209Passing shift_world_to_zero=True causes the events to be shifted such that<br> 210the first event starts at time 0.</tt></dd></dl> 211 212<dl><dt><a name="TimelineModel-IterChildContainers"><strong>IterChildContainers</strong></a>(self)</dt></dl> 213 214<dl><dt><a name="TimelineModel-IterGlobalMemoryDumps"><strong>IterGlobalMemoryDumps</strong></a>(self)</dt><dd><tt>Iterate over the memory dump events of this model.</tt></dd></dl> 215 216<dl><dt><a name="TimelineModel-SetGlobalMemoryDumps"><strong>SetGlobalMemoryDumps</strong></a>(self, global_memory_dumps)</dt><dd><tt>Populates the model with a sequence of GlobalMemoryDump objects.</tt></dd></dl> 217 218<dl><dt><a name="TimelineModel-ShiftWorldToZero"><strong>ShiftWorldToZero</strong></a>(self)</dt></dl> 219 220<dl><dt><a name="TimelineModel-UpdateBounds"><strong>UpdateBounds</strong></a>(self)</dt></dl> 221 222<dl><dt><a name="TimelineModel-__init__"><strong>__init__</strong></a>(self, trace_data<font color="#909090">=None</font>, shift_world_to_zero<font color="#909090">=True</font>)</dt><dd><tt>Initializes a <a href="#TimelineModel">TimelineModel</a>.<br> 223 <br> 224Args:<br> 225 trace_data: trace_data.TraceData containing events to import<br> 226 shift_world_to_zero: If true, the events will be shifted such that the<br> 227 first event starts at time 0.</tt></dd></dl> 228 229<hr> 230Data descriptors defined here:<br> 231<dl><dt><strong>bounds</strong></dt> 232</dl> 233<dl><dt><strong>browser_process</strong></dt> 234</dl> 235<dl><dt><strong>gpu_process</strong></dt> 236</dl> 237<dl><dt><strong>processes</strong></dt> 238</dl> 239<dl><dt><strong>surface_flinger_process</strong></dt> 240</dl> 241<hr> 242Methods inherited from <a href="telemetry.timeline.event_container.html#TimelineEventContainer">telemetry.timeline.event_container.TimelineEventContainer</a>:<br> 243<dl><dt><a name="TimelineModel-GetAllEvents"><strong>GetAllEvents</strong></a>(self, recursive<font color="#909090">=True</font>)</dt><dd><tt># List versions. These should always be simple expressions that list() on<br> 244# an underlying iter method.</tt></dd></dl> 245 246<dl><dt><a name="TimelineModel-GetAllEventsOfName"><strong>GetAllEventsOfName</strong></a>(self, name, recursive<font color="#909090">=True</font>)</dt></dl> 247 248<dl><dt><a name="TimelineModel-GetAllToplevelSlicesOfName"><strong>GetAllToplevelSlicesOfName</strong></a>(self, name, recursive<font color="#909090">=True</font>)</dt></dl> 249 250<dl><dt><a name="TimelineModel-IterAllAsyncSlicesOfName"><strong>IterAllAsyncSlicesOfName</strong></a>(self, name, recursive<font color="#909090">=True</font>)</dt></dl> 251 252<dl><dt><a name="TimelineModel-IterAllAsyncSlicesStartsWithName"><strong>IterAllAsyncSlicesStartsWithName</strong></a>(self, name, recursive<font color="#909090">=True</font>)</dt></dl> 253 254<dl><dt><a name="TimelineModel-IterAllEvents"><strong>IterAllEvents</strong></a>(self, recursive<font color="#909090">=True</font>, event_type_predicate<font color="#909090">=<function <lambda>></font>, event_predicate<font color="#909090">=<function <lambda>></font>)</dt><dd><tt>Iterates all events in this container, pre-filtered by two predicates.<br> 255 <br> 256Only events with a type matching event_type_predicate AND matching event<br> 257event_predicate will be yielded.<br> 258 <br> 259event_type_predicate is given an actual type object, e.g.:<br> 260 event_type_predicate(slice_module.Slice)<br> 261 <br> 262event_predicate is given actual events:<br> 263 event_predicate(thread.slices[7])</tt></dd></dl> 264 265<dl><dt><a name="TimelineModel-IterAllEventsOfName"><strong>IterAllEventsOfName</strong></a>(self, name, recursive<font color="#909090">=True</font>)</dt><dd><tt># Helper functions for finding common kinds of events. Must always take an<br> 266# optinal recurisve parameter and be implemented in terms fo IterAllEvents.</tt></dd></dl> 267 268<dl><dt><a name="TimelineModel-IterAllFlowEvents"><strong>IterAllFlowEvents</strong></a>(self, recursive<font color="#909090">=True</font>)</dt></dl> 269 270<dl><dt><a name="TimelineModel-IterAllSlices"><strong>IterAllSlices</strong></a>(self, recursive<font color="#909090">=True</font>)</dt></dl> 271 272<dl><dt><a name="TimelineModel-IterAllSlicesInRange"><strong>IterAllSlicesInRange</strong></a>(self, start, end, recursive<font color="#909090">=True</font>)</dt></dl> 273 274<dl><dt><a name="TimelineModel-IterAllSlicesOfName"><strong>IterAllSlicesOfName</strong></a>(self, name, recursive<font color="#909090">=True</font>)</dt></dl> 275 276<dl><dt><a name="TimelineModel-IterAllToplevelSlicesOfName"><strong>IterAllToplevelSlicesOfName</strong></a>(self, name, recursive<font color="#909090">=True</font>)</dt></dl> 277 278<dl><dt><a name="TimelineModel-IterEventsInThisContainer"><strong>IterEventsInThisContainer</strong></a>(self, event_type_predicate, event_predicate)</dt><dd><tt>Iterates all the TimelineEvents in this container.<br> 279 <br> 280Only events with a type matching event_type_predicate AND matching event<br> 281event_predicate will be yielded.<br> 282 <br> 283event_type_predicate is given an actual type object, e.g.:<br> 284 event_type_predicate(slice_module.Slice)<br> 285 <br> 286event_predicate is given actual events:<br> 287 event_predicate(thread.slices[7])<br> 288 <br> 289DO NOT ASSUME that the event_type_predicate will be called for every event<br> 290found. The relative calling order of the two is left up to the implementer<br> 291of the method.</tt></dd></dl> 292 293<hr> 294Static methods inherited from <a href="telemetry.timeline.event_container.html#TimelineEventContainer">telemetry.timeline.event_container.TimelineEventContainer</a>:<br> 295<dl><dt><a name="TimelineModel-IsAsyncSlice"><strong>IsAsyncSlice</strong></a>(t)</dt></dl> 296 297<hr> 298Data descriptors inherited from <a href="telemetry.timeline.event_container.html#TimelineEventContainer">telemetry.timeline.event_container.TimelineEventContainer</a>:<br> 299<dl><dt><strong>__dict__</strong></dt> 300<dd><tt>dictionary for instance variables (if defined)</tt></dd> 301</dl> 302<dl><dt><strong>__weakref__</strong></dt> 303<dd><tt>list of weak references to the object (if defined)</tt></dd> 304</dl> 305</td></tr></table></td></tr></table><p> 306<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 307<tr bgcolor="#eeaa77"> 308<td colspan=3 valign=bottom> <br> 309<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> 310 311<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> 312<td width="100%"><dl><dt><a name="-IsSliceOrAsyncSlice"><strong>IsSliceOrAsyncSlice</strong></a>(t)</dt></dl> 313</td></tr></table> 314</body></html>