Package org.eclipse.tracecompass.tmf.ui.signal

Class TmfTimeViewAlignmentSignal

java.lang.Object

org.eclipse.tracecompass.tmf.core.signal.TmfSignal

org.eclipse.tracecompass.tmf.ui.signal.TmfTimeViewAlignmentSignal

public class TmfTimeViewAlignmentSignal
extends TmfSignal

A signal to inform about the state of time alignment. Typically, the emitter will inform the receivers about the position of a sash that separates the time axis on right side and extra information on the left side.

Since:

1.0

See Also:

• TmfTimeViewAlignmentInfo

Constructor Summary

Constructors

Constructor	Description
TmfTimeViewAlignmentSignal(Object source, TmfTimeViewAlignmentInfo alignmentInfo)	Creates a new TmfTimeViewAlignmentSignal
TmfTimeViewAlignmentSignal(Object source, TmfTimeViewAlignmentInfo alignmentInfo, boolean synchronous)	Creates a new TmfTimeViewAlignmentSignal

Method Summary

Modifier and Type	Method	Description
TmfTimeViewAlignmentInfo	getTimeViewAlignmentInfo()	Get the time alignment information.
boolean	IsSynchronous()	Get whether or not the signal should be processed right away, without being throttled.
String	toString()

Methods inherited from class org.eclipse.tracecompass.tmf.core.signal.TmfSignal

getReference, getSource, setReference

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

TmfTimeViewAlignmentSignal

public TmfTimeViewAlignmentSignal(Object source,
 TmfTimeViewAlignmentInfo alignmentInfo)

Creates a new TmfTimeViewAlignmentSignal

Parameters:

source - the source of the signal

alignmentInfo - information about the time alignment

TmfTimeViewAlignmentSignal

public TmfTimeViewAlignmentSignal(Object source,
 TmfTimeViewAlignmentInfo alignmentInfo,
 boolean synchronous)

Creates a new TmfTimeViewAlignmentSignal

Parameters:

source - the source of the signal

alignmentInfo - information about the time alignment

synchronous - whether or not the signal should be processed right away. This is useful for signals that are sent not repetitively. For example, a sash being dragged would not be synchronous because the signal gets fired repeatedly. A view that has completed computing it's data could send a synchronous signal.

Method Details

getTimeViewAlignmentInfo

public TmfTimeViewAlignmentInfo getTimeViewAlignmentInfo()

Get the time alignment information.

Returns:

the time alignment information

toString

public String toString()

Overrides:

toString in class Object

IsSynchronous

public boolean IsSynchronous()

Get whether or not the signal should be processed right away, without being throttled.

Returns:

whether or not the signal should be processed right away