1 /*******************************************************************************
2 * Copyright (c) 2011-2013 Ericsson, Ecole Polytechnique de Montreal and others
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
9 * Contributors: Matthew Khouzam - Initial API and implementation
10 * Contributors: Simon Marchi - Initial API and implementation
11 *******************************************************************************/
13 package org
.eclipse
.linuxtools
.ctf
.core
.trace
;
15 import java
.util
.HashMap
;
16 import java
.util
.HashSet
;
20 import org
.eclipse
.linuxtools
.ctf
.core
.event
.IEventDeclaration
;
21 import org
.eclipse
.linuxtools
.ctf
.core
.event
.types
.StructDeclaration
;
22 import org
.eclipse
.linuxtools
.internal
.ctf
.core
.event
.EventDeclaration
;
23 import org
.eclipse
.linuxtools
.internal
.ctf
.core
.event
.metadata
.exceptions
.ParseException
;
26 * <b><u>Stream</u></b>
28 * Represents a stream in a trace.
33 // ------------------------------------------------------------------------
35 // ------------------------------------------------------------------------
39 * The numerical ID of the stream
41 private Long id
= null;
44 * Declarations of the stream-specific structures
46 private StructDeclaration packetContextDecl
= null;
47 private StructDeclaration eventHeaderDecl
= null;
48 private StructDeclaration eventContextDecl
= null;
51 * The trace to which the stream belongs
53 private CTFTrace trace
= null;
56 * Maps event ids to events
58 private Map
<Long
, IEventDeclaration
> events
= new HashMap
<Long
, IEventDeclaration
>();
61 * The inputs associated to this stream
63 private final Set
<StreamInput
> inputs
= new HashSet
<StreamInput
>();
65 // ------------------------------------------------------------------------
67 // ------------------------------------------------------------------------
70 * Constructs a Stream that belongs to a Trace
73 * The trace to which belongs this stream.
75 public Stream(CTFTrace trace
) {
79 // ------------------------------------------------------------------------
80 // Getters/Setters/Predicates
81 // ------------------------------------------------------------------------
84 * Sets the id of a stream
85 * @param id the id of a stream
87 public void setId(long id
) {
89 this.events
= trace
.createEvents(this.id
);
93 * Gets the id of a stream
94 * @return id the id of a stream
101 * Is the id of a stream set
103 * @return If the ID is set or not
105 public boolean isIdSet() {
111 * @return is the event header set (timestamp and stuff) (see Ctf Spec)
113 public boolean isEventHeaderSet() {
114 return eventHeaderDecl
!= null;
119 * @return is the event context set (pid and stuff) (see Ctf Spec)
121 public boolean isEventContextSet() {
122 return eventContextDecl
!= null;
127 * @return Is the packet context set (see Ctf Spec)
129 public boolean isPacketContextSet() {
130 return packetContextDecl
!= null;
135 * @param eventHeader the current event header for all events in this stream
137 public void setEventHeader(StructDeclaration eventHeader
) {
138 this.eventHeaderDecl
= eventHeader
;
143 * @param eventContext the context for all events in this stream
145 public void setEventContext(StructDeclaration eventContext
) {
146 this.eventContextDecl
= eventContext
;
151 * @param packetContext the packet context for all packets in this stream
153 public void setPacketContext(StructDeclaration packetContext
) {
154 this.packetContextDecl
= packetContext
;
159 * @return the event header declaration in structdeclaration form
161 public StructDeclaration
getEventHeaderDecl() {
162 return eventHeaderDecl
;
167 * @return the event context declaration in structdeclaration form
169 public StructDeclaration
getEventContextDecl() {
170 return eventContextDecl
;
175 * @return the packet context declaration in structdeclaration form
177 public StructDeclaration
getPacketContextDecl() {
178 return packetContextDecl
;
183 * @return the set of all stream inputs for this stream
185 public Set
<StreamInput
> getStreamInputs() {
191 * @return the parent trace
193 public CTFTrace
getTrace() {
199 * @return all the event declarations for this stream, using the id as a key for the hashmap.
201 public Map
<Long
, IEventDeclaration
> getEvents() {
205 // ------------------------------------------------------------------------
207 // ------------------------------------------------------------------------
210 * Adds an event to the event map.
212 * An event in a stream can omit its id if it is the only event in this
213 * stream. An event for which no id has been specified has a null id. It is
214 * thus not possible to add an event with the null key if the map is not
215 * empty. It is also not possible to add an event to the map if the null key
216 * is present in the map.
220 * @throws ParseException
221 * If there was a problem reading the event or adding it to the
224 public void addEvent(IEventDeclaration event
) throws ParseException
{
226 * If there is an event without id (the null key), it must be the only
229 if (events
.get(null) != null) {
230 throw new ParseException(
231 "Event without id with multiple events in a stream"); //$NON-NLS-1$
235 * If there is an event without id (the null key), it must be the only
238 if ((event
.getId() == null) && (events
.size() != 0)) {
239 throw new ParseException(
240 "Event without id with multiple events in a stream"); //$NON-NLS-1$
243 /* Check if an event with the same ID already exists */
244 if (events
.get(event
.getId()) != null) {
245 throw new ParseException("Event id already exists"); //$NON-NLS-1$
247 if (event
.getId() == null) {
248 events
.put(EventDeclaration
.UNSET_EVENT_ID
, event
);
250 /* Put the event in the map */
251 events
.put(event
.getId(), event
);
256 * Add an input to this Stream
259 * The StreamInput to add.
261 public void addInput(StreamInput input
) {
266 public String
toString() {
267 return "Stream [id=" + id
+ ", packetContextDecl=" + packetContextDecl
//$NON-NLS-1$ //$NON-NLS-2$
268 + ", eventHeaderDecl=" + eventHeaderDecl
//$NON-NLS-1$
269 + ", eventContextDecl=" + eventContextDecl
+ ", trace=" + trace
//$NON-NLS-1$ //$NON-NLS-2$
270 + ", events=" + events
+ ", inputs=" + inputs
+ "]"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$