org.metacsp.utility.timelinePlotting

Class TimelinePublisher

java.lang.Object

org.metacsp.utility.timelinePlotting.TimelinePublisher

public final class TimelinePublisher
extends java.lang.Object

A utility class that that extracts SymbolicTimelines from components and publishes them as images.

Author:

Jonas Ullberg, Federico Pecora

Constructor Summary

Constructors

Constructor and Description
TimelinePublisher(ActivityNetworkSolver ans, Bounds bounds, boolean slidingWindow, java.lang.String... components) Deprecated.
TimelinePublisher(ActivityNetworkSolver ans, Bounds bounds, java.lang.String... components) Deprecated.
TimelinePublisher(ActivityNetworkSolver ans, java.lang.String... components) Deprecated.
TimelinePublisher(ConstraintNetwork an, Bounds bounds, boolean slidingWindow, java.lang.String... components)
TimelinePublisher(ConstraintNetwork an, Bounds bounds, java.lang.String... components)
TimelinePublisher(ConstraintNetwork an, java.lang.String... components)

Method Summary

Modifier and Type	Method and Description
void	publish(boolean block, boolean skip) Publish the SymbolicTimelines.
void	registerTimelineVisualizer(TimelineVisualizer viz) Make a given TimelineVisualizer display the SymbolicTimelines published by this TimelinePublisher.
void	setComponents(java.lang.String... components) Set the list of components for which to publish SymbolicTimelines.
void	setMarkingsToExclude(java.lang.Object... markingsToExclude)
void	setShowLabels(boolean showlabels)
void	setTemporalResolution(long temporalResolution) Sets the temporal resolution of this publisher (default is milliseconds).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TimelinePublisher

public TimelinePublisher(ConstraintNetwork an,
                         Bounds bounds,
                         boolean slidingWindow,
                         java.lang.String... components)

Parameters:

an - The ConstraintNetwork used to calculate the SymbolicTimelines.

bounds - The range in which to plot SymbolicTimelines.

slidingWindow - If true, the bounds are interpreted as a sliding window.

components - List of components for which to publish SymbolicTimelines.

TimelinePublisher

@Deprecated
public TimelinePublisher(ActivityNetworkSolver ans,
                                     Bounds bounds,
                                     boolean slidingWindow,
                                     java.lang.String... components)

Deprecated.

Parameters:

ans - The ActivityNetworkSolver used to calculate the SymbolicTimelines.

bounds - The range in which to plot SymbolicTimelines.

slidingWindow - If true, the bounds are interpreted as a sliding window.

components - List of components for which to publish SymbolicTimelines.

TimelinePublisher

public TimelinePublisher(ConstraintNetwork an,
                         Bounds bounds,
                         java.lang.String... components)

Parameters:

an - The ConstraintNetwork used to calculate the SymbolicTimelines.

bounds - The range in which to plot SymbolicTimelines.

components - List of components for which to publish SymbolicTimelines.

TimelinePublisher

@Deprecated
public TimelinePublisher(ActivityNetworkSolver ans,
                                     Bounds bounds,
                                     java.lang.String... components)

Deprecated.

Parameters:

ans - The ActivityNetworkSolver used to calculate the SymbolicTimelines.

bounds - The range in which to plot SymbolicTimelines.

components - List of components for which to publish SymbolicTimelines.

TimelinePublisher

public TimelinePublisher(ConstraintNetwork an,
                         java.lang.String... components)

Parameters:

an - The ConstraintNetwork used to calculate the SymbolicTimelines.

components - List of components for which to publish SymbolicTimelines.

TimelinePublisher

@Deprecated
public TimelinePublisher(ActivityNetworkSolver ans,
                                     java.lang.String... components)

Deprecated.

Parameters:

ans - The ActivityNetworkSolver used to calculate the SymbolicTimelines.

components - List of components for which to publish SymbolicTimelines.

Method Detail

setShowLabels

public void setShowLabels(boolean showlabels)

setMarkingsToExclude

public void setMarkingsToExclude(java.lang.Object... markingsToExclude)

setTemporalResolution

public void setTemporalResolution(long temporalResolution)

Sets the temporal resolution of this publisher (default is milliseconds).

Parameters:

temporalResolution - The desired temporal resolution of this publisher (e.g., seconds if temporalResolution = 1000).

registerTimelineVisualizer

public void registerTimelineVisualizer(TimelineVisualizer viz)

Make a given TimelineVisualizer display the SymbolicTimelines published by this TimelinePublisher. Note that newly instantiated TimelineVisualizers are automatically registered to the TimelinePublisher given in the constructor, so there is usually no need to call this method.

Parameters:

viz - The TimelineVisualizer that should display the SymbolicTimelines published by this TimelinePublisher.

setComponents

public void setComponents(java.lang.String... components)

Set the list of components for which to publish SymbolicTimelines.

Parameters:

components - The list of components for which to publish SymbolicTimelines.

publish

public void publish(boolean block,
                    boolean skip)

Publish the SymbolicTimelines. This method renders in a background thread (unless blocking behavior is requested through parameter block).

Parameters:

block - Set to true if the call should block until SymbolicTimelines are rendered.

skip - Set to true if this call should be skipped in case previous rendering is still in progress.