Java Doc and API clean up of TMF UML Sequence diagram framework
[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / views / uml2sd / core / SDTimeEvent.java
1 /**********************************************************************
2 * Copyright (c) 2005, 2006 IBM Corporation and others.
3 * Copyright (c) 2011, 2012 Ericsson.
4 *
5 * All rights reserved. This program and the accompanying materials
6 * are made available under the terms of the Eclipse Public License v1.0
7 * which accompanies this distribution, and is available at
8 * http://www.eclipse.org/legal/epl-v10.html
9 *
10 * Contributors:
11 * IBM - Initial API and implementation
12 * Bernd Hufmann - Updated for TMF
13 **********************************************************************/
14 package org.eclipse.linuxtools.tmf.ui.views.uml2sd.core;
15
16 import org.eclipse.linuxtools.tmf.core.event.ITmfTimestamp;
17
18 /**
19 * Class implementation of a sequence diagram time event.
20 *
21 * @version 1.0
22 * @author sveyrier
23 *
24 */
25 public class SDTimeEvent {
26
27 // ------------------------------------------------------------------------
28 // Attributes
29 // ------------------------------------------------------------------------
30
31 /**
32 * The time stamp of the event
33 */
34 protected ITmfTimestamp time;
35 /**
36 * The event index.
37 */
38 protected int event;
39 /**
40 * The time range implementing node.
41 */
42 protected ITimeRange node;
43
44 // ------------------------------------------------------------------------
45 // Constructors
46 // ------------------------------------------------------------------------
47 /**
48 * The default constructor.
49 *
50 * @param _time The time stamp of the event.
51 * @param _event The event index.
52 * @param _node The time range implementing node.
53 */
54 public SDTimeEvent(ITmfTimestamp _time, int _event, ITimeRange _node) {
55 time = _time;
56 event = _event;
57 node = _node;
58 }
59
60 // ------------------------------------------------------------------------
61 // Operations
62 // ------------------------------------------------------------------------
63 /**
64 * Returns the timestamp of the event.
65 *
66 * @return the timestamp of the event.
67 */
68 public ITmfTimestamp getTime() {
69 return time;
70 }
71
72 /**
73 * Returns the event index.
74 *
75 * @return the event index.
76 */
77 public int getEvent() {
78 return event;
79 }
80
81 /**
82 * Returns the time range implementing node.
83 *
84 * @return the time range implementing node.
85 */
86 public ITimeRange getGraphNode() {
87 return node;
88 }
89
90 }
This page took 0.03236 seconds and 5 git commands to generate.