ctf/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  * @noimplement This interface only contains static definitions.
  24  */
  25 @SuppressWarnings("nls")
  26 @NonNullByDefault
  27 public interface CTFStrings {
  28
  29     /** Event name for lost events */
  30     String LOST_EVENT_NAME = "Lost event";
  31
  32     /**
  33      * Name of the field in lost events indicating how many actual events were
  34      * lost
  35      */
  36     String LOST_EVENTS_FIELD = "Lost events";
  37
  38     /**
  39      * Name of the field in lost events indicating the time range
  40      */
  41     String LOST_EVENTS_DURATION = "duration";
  42
  43     // -------------------------------------------------------------------------
  44     // Packet header strings
  45     // -------------------------------------------------------------------------
  46
  47     /**
  48      * Lost events so far in this stream (LTTng Specific)
  49      *
  50      * @since 1.0
  51      */
  52     String EVENTS_DISCARDED = "events_discarded";
  53
  54     /**
  55      * The CPU ID of this packet (LTTng Specific)
  56      *
  57      * @since 1.0
  58      */
  59     String CPU_ID = "cpu_id";
  60
  61     /**
  62      * The device of this packet
  63      *
  64      * @since 1.0
  65      */
  66     String DEVICE = "device";
  67
  68     /**
  69      * The first time stamp of this packet
  70      *
  71      * @since 1.0
  72      */
  73     String TIMESTAMP_BEGIN = "timestamp_begin";
  74
  75     /**
  76      * The last time stamp of this packet
  77      *
  78      * @since 1.0
  79      */
  80     String TIMESTAMP_END = "timestamp_end";
  81
  82     /**
  83      * Size of this packet
  84      *
  85      * @since 1.0
  86      */
  87     String PACKET_SIZE = "packet_size";
  88
  89     /**
  90      * Size of data in this packet (not necessarily the packet size)
  91      *
  92      * @since 1.0
  93      */
  94     String CONTENT_SIZE = "content_size";
  95
  96     /**
  97      * Magic number
  98      *
  99      * @since 1.1
 100      */
 101     String MAGIC = "magic";
 102     /**
 103      * Header
 104      *
 105      * @since 1.1
 106      */
 107     String HEADER = "header";
 108     /**
 109      * Context
 110      *
 111      * @since 1.1
 112      */
 113     String CONTEXT = "context";
 114     /**
 115      * Packet
 116      *
 117      * @since 1.1
 118      */
 119     String PACKET = "packet";
 120     /**
 121      * Timestamp
 122      *
 123      * @since 1.1
 124      */
 125     String TIMESTAMP = "timestamp";
 126 }