ctf/org.eclipse.tracecompass.ctf.core/src/org/eclipse/tracecompass/ctf/core/event/IEventDeclaration.java

   1 /*******************************************************************************
   2  * Copyright (c) 2011-2014 Ericsson, Ecole Polytechnique de Montreal and others
   3  *
   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
   8  *
   9  * Contributors: Matthew Khouzam - Initial API and implementation
  10  *******************************************************************************/
  11
  12 package org.eclipse.tracecompass.ctf.core.event;
  13
  14 import java.util.Set;
  15
  16 import org.eclipse.jdt.annotation.NonNull;
  17 import org.eclipse.tracecompass.ctf.core.CTFException;
  18 import org.eclipse.tracecompass.ctf.core.event.io.BitBuffer;
  19 import org.eclipse.tracecompass.ctf.core.event.types.StructDeclaration;
  20 import org.eclipse.tracecompass.ctf.core.trace.CTFStreamInputReader;
  21 import org.eclipse.tracecompass.ctf.core.trace.ICTFStream;
  22 import org.eclipse.tracecompass.internal.ctf.core.trace.CTFStream;
  23
  24 /**
  25  * Representation of one type of event. A bit like "int" or "long" but for trace
  26  * events.
  27  *
  28  * @author Matthew Khouzam
  29  */
  30 public interface IEventDeclaration {
  31
  32     /**
  33      * Id of events when not set
  34      *
  35      * @since 1.0
  36      */
  37     public static final long UNSET_EVENT_ID = -2L;
  38
  39     /**
  40      * Creates an instance of {@link IEventDefinition} corresponding to this
  41      * declaration.
  42      *
  43      * @param streamInputReader
  44      *            The {@link CTFStreamInputReader} for which this definition is
  45      *            created.
  46      * @param input
  47      *            the {@link BitBuffer} input source
  48      * @param timestamp
  49      *            The timestamp when the event was taken
  50      * @return A new {@link IEventDefinition}
  51      * @throws CTFException
  52      *             As a bitbuffer is used to read, it could have wrapped
  53      *             IOExceptions.
  54      * @since 2.0
  55      */
  56     IEventDefinition createDefinition(CTFStreamInputReader streamInputReader, @NonNull BitBuffer input, long timestamp) throws CTFException;
  57
  58     /**
  59      * Gets the name of an event declaration
  60      *
  61      * @return the name
  62      */
  63     String getName();
  64
  65     /**
  66      * Gets the fields of an event declaration
  67      *
  68      * @return fields the fields in {@link StructDeclaration} format
  69      */
  70     StructDeclaration getFields();
  71
  72     /**
  73      * Gets the context of an event declaration
  74      *
  75      * @return context the fields in {@link StructDeclaration} format
  76      */
  77     StructDeclaration getContext();
  78
  79     /**
  80      * Gets the id of an event declaration
  81      *
  82      * @return The EventDeclaration ID
  83      */
  84     Long getId();
  85
  86     /**
  87      * Gets the {@link CTFStream} of an event declaration
  88      *
  89      * @return the stream
  90      * @since 2.0
  91      */
  92     ICTFStream getStream();
  93
  94     /**
  95      * What is the log level of this event?
  96      *
  97      * @return the log level.
  98      */
  99     long getLogLevel();
 100
 101     /**
 102      * Get the {@link Set} of names of the custom CTF attributes.
 103      *
 104      * @return The set of custom attributes
 105      */
 106     @NonNull Set<@NonNull String> getCustomAttributes();
 107
 108     /**
 109      * Get the value of a given CTF attribute.
 110      *
 111      * @param key
 112      *            The CTF attribute name
 113      * @return the CTF attribute
 114      */
 115     String getCustomAttribute(String key);
 116
 117 }