1 /*******************************************************************************
2 * Copyright (c) 2015 Ericsson
4 * All rights reserved. This program and the accompanying materials are made
5 * available under the terms of the Eclipse Public License v1.0 which
6 * accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * Matthew Khouzam - Initial API and implementation
11 *******************************************************************************/
12 package org
.eclipse
.tracecompass
.ctf
.core
.trace
;
15 * CTF Packet descriptor, can come from a packet header or an index file, this
16 * will show certain information about the packet such as the size and
21 public interface ICTFPacketDescriptor
{
24 * Returns whether the packet includes (inclusively) the given timestamp in
25 * the begin-end timestamp range.
28 * The timestamp to check.
29 * @return True if the packet includes the timestamp.
31 boolean includes(long ts
);
34 * Gets the offset of a packet within a stream in bits
36 * @return the offset bits
41 * Gets the size of the packet in bits. If you have a 1mb packet that is 499kb
42 * used and the header is 1kb, this will return 1mb
44 * @return the packetSizeBits
46 long getPacketSizeBits();
49 * Get the content size of the packet in bits. If you have a 1mb packet that is 499kb
50 * used and the header is 1kb, this will return 500kb (used data + header
52 * @return the contentSizeBits
54 long getContentSizeBits();
57 * Gets the beginning timestamp of the packet, all events within the packet will have timestamps after or at this time
59 * @return the timestampBegin
61 long getTimestampBegin();
64 * Gets the ending timestamp of the packet, all events within the packet will have timestamps before or at this time
66 * @return the timestampEnd
68 long getTimestampEnd();
71 * Gets the number of lost events in this packet
73 * @return the lostEvents in this packet
78 * Retrieve the value of an existing attribute
81 * The name of the attribute
82 * @return The value that was stored, or null if it wasn't found
84 Object
lookupAttribute(String field
);
87 * Get the target of the packet (what device generated this packet)
89 * @return The target that is being traced
94 * Get the id of the target of the packet (a number helper)
96 * @return The ID of the target
101 * Get the offset of the packet in bytes within the stream
103 * @return The offset of the packet in bytes
105 long getOffsetBytes();
This page took 0.032997 seconds and 5 git commands to generate.