1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/*******************************************************************************
* Copyright (c) 2011-2012 Ericsson, Ecole Polytechnique de Montreal and others
*
* All rights reserved. This program and the accompanying materials are made
* available under the terms of the Eclipse Public License v1.0 which
* accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors: Matthew Khouzam - Initial API and implementation
* Contributors: Simon Marchi - Initial API and implementation
*******************************************************************************/
package org.eclipse.linuxtools.ctf.core.trace;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Set;
import org.eclipse.linuxtools.ctf.core.event.EventDeclaration;
import org.eclipse.linuxtools.ctf.core.event.metadata.exceptions.ParseException;
import org.eclipse.linuxtools.ctf.core.event.types.StructDeclaration;
/**
* <b><u>Stream</u></b>
* <p>
* Represents a stream in a trace.
*/
public class Stream {
// ------------------------------------------------------------------------
// Attributes
// ------------------------------------------------------------------------
/**
* The numerical ID of the stream
*/
private Long id = null;
/**
* Declarations of the stream-specific structures
*/
private StructDeclaration packetContextDecl = null;
private StructDeclaration eventHeaderDecl = null;
private StructDeclaration eventContextDecl = null;
/**
* The trace to which the stream belongs
*/
private CTFTrace trace = null;
/**
* Maps event ids to events
*/
private final HashMap<Long, EventDeclaration> events = new HashMap<Long, EventDeclaration>();
/**
* The inputs associated to this stream
*/
private final Set<StreamInput> inputs = new HashSet<StreamInput>();
// ------------------------------------------------------------------------
// Constructors
// ------------------------------------------------------------------------
/**
* Constructs a Stream that belongs to a Trace
*
* @param trace
* The trace to which belongs this stream.
*/
public Stream(CTFTrace trace) {
this.trace = trace;
}
// ------------------------------------------------------------------------
// Getters/Setters/Predicates
// ------------------------------------------------------------------------
public void setId(long id) {
this.id = id;
}
public Long getId() {
return id;
}
public boolean idIsSet() {
return id != null;
}
public boolean eventHeaderIsSet() {
return eventHeaderDecl != null;
}
public boolean eventContextIsSet() {
return eventContextDecl != null;
}
public boolean packetContextIsSet() {
return packetContextDecl != null;
}
public void setEventHeader(StructDeclaration eventHeader) {
this.eventHeaderDecl = eventHeader;
}
public void setEventContext(StructDeclaration eventContext) {
this.eventContextDecl = eventContext;
}
public void setPacketContext(StructDeclaration packetContext) {
this.packetContextDecl = packetContext;
}
public StructDeclaration getEventHeaderDecl() {
return eventHeaderDecl;
}
public StructDeclaration getEventContextDecl() {
return eventContextDecl;
}
public StructDeclaration getPacketContextDecl() {
return packetContextDecl;
}
public Set<StreamInput> getStreamInputs() {
return inputs;
}
public CTFTrace getTrace() {
return trace;
}
public HashMap<Long, EventDeclaration> getEvents() {
return events;
}
// ------------------------------------------------------------------------
// Operations
// ------------------------------------------------------------------------
/**
* Adds an event to the event map.
*
* An event in a stream can omit its id if it is the only event in this
* stream. An event for which no id has been specified has a null id. It is
* thus not possible to add an event with the null key if the map is not
* empty. It is also not possible to add an event to the map if the null key
* is present in the map.
*
* @param event
* The event to add.
* @throws ParseException
*/
public void addEvent(EventDeclaration event) throws ParseException {
/*
* If there is an event without id (the null key), it must be the only
* one
*/
if (events.get(null) != null) {
throw new ParseException(
"Event without id with multiple events in a stream"); //$NON-NLS-1$
}
/*
* If there is an event without id (the null key), it must be the only
* one
*/
if ((event.getId() == null) && (events.size() != 0)) {
throw new ParseException(
"Event without id with multiple events in a stream"); //$NON-NLS-1$
}
/* Check if an event with the same ID already exists */
if (events.get(event.getId()) != null) {
throw new ParseException("Event id already exists"); //$NON-NLS-1$
}
/* Put the event in the map */
events.put(event.getId(), event);
}
/**
* Add an input to this Stream
*
* @param input
* The StreamInput to add.
*/
public void addInput(StreamInput input) {
inputs.add(input);
}
/* (non-Javadoc)
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return "Stream [id=" + id + ", packetContextDecl=" + packetContextDecl //$NON-NLS-1$ //$NON-NLS-2$
+ ", eventHeaderDecl=" + eventHeaderDecl //$NON-NLS-1$
+ ", eventContextDecl=" + eventContextDecl + ", trace=" + trace //$NON-NLS-1$ //$NON-NLS-2$
+ ", events=" + events + ", inputs=" + inputs + "]"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
}
}
|
