org.opentrafficsim.graphs

Class TrajectoryPlot.FixedSampleRateTrajectory

java.lang.Object

org.opentrafficsim.graphs.TrajectoryPlot.FixedSampleRateTrajectory

All Implemented Interfaces:

Serializable, TrajectoryPlot.Trajectory

Enclosing class:

TrajectoryPlot

class TrajectoryPlot.FixedSampleRateTrajectory
extends Object
implements TrajectoryPlot.Trajectory, Serializable

Store trajectory data for use with a fixed sample rate.

Author:

Peter Knoppers

Constructor Summary

Constructors

Constructor and Description
FixedSampleRateTrajectory(String id) Construct a FixedSampleRateTrajectory.

Method Summary

Modifier and Type	Method and Description
void	addSample(LaneBasedGTU gtu, Lane lane, double position) Add a trajectory segment sample and update the currentEndTime and currentEndPosition.
org.djunits.value.vdouble.scalar.Time	getCurrentEndTime() Retrieve the time of the last stored event.
double	getDistance(int item) Return the distance of the Nth stored sample.
String	getId() Retrieve the id of this Trajectory.
Double	getLastPosition() Retrieve the last recorded non-null position, or null if no non-null positions have been recorded yet.
double	getTime(int item) Return the time of the Nth stored sample.
int	size() Retrieve the number of stored samples in this Trajectory.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FixedSampleRateTrajectory

FixedSampleRateTrajectory(String id)

Construct a FixedSampleRateTrajectory.

Parameters:

id - String; id of the new Trajectory (id of the GTU)

Method Detail

getCurrentEndTime

public final org.djunits.value.vdouble.scalar.Time getCurrentEndTime()

Retrieve the time of the last stored event.

Specified by:

getCurrentEndTime in interface TrajectoryPlot.Trajectory

Returns:

Time; the time of the last stored event

getLastPosition

public final Double getLastPosition()

Retrieve the last recorded non-null position, or null if no non-null positions have been recorded yet.

Specified by:

getLastPosition in interface TrajectoryPlot.Trajectory

Returns:

Double; the last recorded position of this Trajectory in meters

getId

public final String getId()

Retrieve the id of this Trajectory.

Specified by:

getId in interface TrajectoryPlot.Trajectory

Returns:

Object; the id of this Trajectory

addSample

public final void addSample(LaneBasedGTU gtu,
                            Lane lane,
                            double position)
                     throws org.opentrafficsim.core.network.NetworkException,
                            org.opentrafficsim.core.gtu.GTUException

Add a trajectory segment sample and update the currentEndTime and currentEndPosition.

Specified by:

addSample in interface TrajectoryPlot.Trajectory

Parameters:

gtu - AbstractLaneBasedGTU; the GTU whose currently committed trajectory segment must be added

lane - Lane; the Lane that the positionOffset is valid for

position - Double; distance in meters from the start of the trajectory

Throws:

org.opentrafficsim.core.network.NetworkException - when car is not on lane anymore

org.opentrafficsim.core.gtu.GTUException - on problems obtaining data from the GTU

size

public int size()

Retrieve the number of stored samples in this Trajectory.

Specified by:

size in interface TrajectoryPlot.Trajectory

Returns:

int; number of stored samples

getTime

public double getTime(int item)

Return the time of the Nth stored sample.

Specified by:

getTime in interface TrajectoryPlot.Trajectory

Parameters:

item - int; the index of the sample

Returns:

double; the time of the sample

getDistance

public double getDistance(int item)

Description copied from interface: TrajectoryPlot.Trajectory

Return the distance of the Nth stored sample.

Specified by:

getDistance in interface TrajectoryPlot.Trajectory

Parameters:

item - Integer; the sample number

Returns:

Double; the position indexed by item

toString

public final String toString()

Overrides:

toString in class Object