org.eclipse.tracecompass.ctf.core/src/org/eclipse/tracecompass/ctf/core/CTFStrings.java

   1 /*******************************************************************************
   2  * Copyright (c) 2013, 2015 Ericsson
   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:
  10  *   Alexandre Montplaisir - Initial API and implementation
  11  *   Matthew Khouzam - Add packet header Strings
  12  *******************************************************************************/
  13
  14 package org.eclipse.tracecompass.ctf.core;
  15
  16 import org.eclipse.jdt.annotation.NonNullByDefault;
  17
  18 /**
  19  * Non-externalized strings for use with the CTF plugin (event names, field
  20  * names, etc.)
  21  *
  22  * @author Alexandre Montplaisir
  23  */
  24 @SuppressWarnings("nls")
  25 @NonNullByDefault
  26 public interface CTFStrings {
  27
  28     /** Event name for lost events */
  29     String LOST_EVENT_NAME = "Lost event";
  30
  31     /**
  32      * Name of the field in lost events indicating how many actual events were
  33      * lost
  34      */
  35     String LOST_EVENTS_FIELD = "Lost events";
  36
  37     /**
  38      * Name of the field in lost events indicating the time range
  39      */
  40     String LOST_EVENTS_DURATION = "duration";
  41
  42     // -------------------------------------------------------------------------
  43     // Packet header strings
  44     // -------------------------------------------------------------------------
  45
  46     /**
  47      * Lost events so far in this stream (LTTng Specific)
  48      *
  49      * @since 1.0
  50      */
  51     String EVENTS_DISCARDED = "events_discarded";
  52
  53     /**
  54      * The CPU ID of this packet (LTTng Specific)
  55      *
  56      * @since 1.0
  57      */
  58     String CPU_ID = "cpu_id";
  59
  60     /**
  61      * The device of this packet
  62      *
  63      * @since 1.0
  64      */
  65     String DEVICE = "device";
  66
  67     /**
  68      * The first time stamp of this packet
  69      *
  70      * @since 1.0
  71      */
  72     String TIMESTAMP_BEGIN = "timestamp_begin";
  73
  74     /**
  75      * The last time stamp of this packet
  76      *
  77      * @since 1.0
  78      */
  79     String TIMESTAMP_END = "timestamp_end";
  80
  81     /**
  82      * Size of this packet
  83      *
  84      * @since 1.0
  85      */
  86     String PACKET_SIZE = "packet_size";
  87
  88     /**
  89      * Size of data in this packet (not necessarily the packet size)
  90      *
  91      * @since 1.0
  92      */
  93     String CONTENT_SIZE = "content_size";
  94
  95     /**
  96      * Magic number
  97      *
  98      * @since 1.0
  99      */
 100     String MAGIC = "magic";
 101 }