Trajectory (OpenTrafficSim KPI Module 1.00.02 API)

java.lang.Object
- org.opentrafficsim.kpi.sampling.Trajectory<G>

Type Parameters:

G - gtu data type
```
public final class Trajectory<G extends GtuDataInterface>
extends Object
```
Contains position, speed, acceleration and time data of a GTU, over some section. Position is relative to the start of the lane in the direction of travel, also when trajectories have been truncated at a position x > 0. Note that this regards internal data and output. Input position always refers to the design line of the lane. This class internally flips input positions and boundaries.
Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.
$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Sep 21, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Constructor Summary

Constructors
Constructor and Description
`Trajectory(GtuDataInterface gtu, MetaData metaData, Set<ExtendedDataType<?,?,?,G>> extendedData, KpiLaneDirection kpiLaneDirection)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Length position, Speed speed, Acceleration acceleration, Time time)` Adds values of position, speed, acceleration and time.
`void`	`add(Length position, Speed speed, Acceleration acceleration, Time time, G gtu)` Adds values of position, speed, acceleration and time.
`boolean`	`contains(ExtendedDataType<?,?,?,?> extendedDataType)`
`boolean`	`contains(MetaDataType<?> metaDataType)`
`boolean`	`equals(Object obj)`
`float[]`	`getA()`
`float`	`getA(int index)` Returns `a` value of a single sample.
`FloatAccelerationVector`	`getAcceleration()`
`<O,S> O`	`getExtendedData(ExtendedDataType<?,O,S,?> extendedDataType)`
`<T,S> T`	`getExtendedData(ExtendedDataType<T,?,S,?> extendedDataType, int index)` Returns extended data type value of a single sample.
`Set<ExtendedDataType<?,?,?,G>>`	`getExtendedDataTypes()` Returns the included extended data types.
`String`	`getGtuId()`
`<T> T`	`getMetaData(MetaDataType<T> metaDataType)`
`Set<MetaDataType<?>>`	`getMetaDataTypes()` Returns the included meta data types.
`FloatLengthVector`	`getPosition()`
`FloatSpeedVector`	`getSpeed()`
`float[]`	`getT()`
`float`	`getT(int index)` Returns `t` value of a single sample.
`FloatTimeVector`	`getTime()`
`Duration`	`getTotalDuration()`
`Length`	`getTotalLength()`
`float[]`	`getV()`
`float`	`getV(int index)` Returns `v` value of a single sample.
`float[]`	`getX()`
`float`	`getX(int index)` Returns `x` value of a single sample.
`int`	`hashCode()`
`int`	`size()`
`Trajectory<G>`	`subSet(Length startPosition, Length endPosition)` Copies the trajectory but with a subset of the data.
`Trajectory<G>`	`subSet(Length startPosition, Length endPosition, Time startTime, Time endTime)` Copies the trajectory but with a subset of the data.
`Trajectory<G>`	`subSet(Time startTime, Time endTime)` Copies the trajectory but with a subset of the data.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Trajectory
```
public Trajectory(GtuDataInterface gtu,
                  MetaData metaData,
                  Set<ExtendedDataType<?,?,?,G>> extendedData,
                  KpiLaneDirection kpiLaneDirection)
```
    Parameters:
    
    gtu - GTU of this trajectory, only the id is stored.
    
    metaData - meta data
    
    extendedData - types of extended data
    
    kpiLaneDirection - direction of travel
- Method Detail
  - add
```
public void add(Length position,
                Speed speed,
                Acceleration acceleration,
                Time time)
```
    Adds values of position, speed, acceleration and time.
    
    Parameters:
    
    position - position is relative to the start of the lane in the direction of the design line, i.e. irrespective of the travel direction, also when trajectories have been truncated at a position x > 0
    
    speed - speed
    
    acceleration - acceleration
    
    time - time
  - add
```
public void add(Length position,
                Speed speed,
                Acceleration acceleration,
                Time time,
                G gtu)
```
    Adds values of position, speed, acceleration and time.
    
    Parameters:
    
    position - position is relative to the start of the lane in the direction of the design line, i.e. irrespective of the travel direction, also when trajectories have been truncated at a position x > 0
    
    speed - speed
    
    acceleration - acceleration
    
    time - time
    
    gtu - gtu to add extended data for
  - size
```
public int size()
```
    Returns:
    
    size of the underlying trajectory data
  - getGtuId
```
public String getGtuId()
```
    Returns:
    
    GTU id
  - getX
```
public float[] getX()
```
    Returns:
    
    si position values, position is relative to the start of the lane, also when trajectories have been truncated at a position x > 0
  - getV
```
public float[] getV()
```
    Returns:
    
    si speed values
  - getA
```
public float[] getA()
```
    Returns:
    
    si acceleration values
  - getT
```
public float[] getT()
```
    Returns:
    
    si time values
  - getX
```
public float getX(int index)
           throws SamplingException
```
    Returns x value of a single sample.
    
    Parameters:
    
    index - index
    
    Returns:
    
    x value of a single sample
    
    Throws:
    
    SamplingException - if the index is out of bounds
  - getV
```
public float getV(int index)
           throws SamplingException
```
    Returns v value of a single sample.
    
    Parameters:
    
    index - index
    
    Returns:
    
    v value of a single sample
    
    Throws:
    
    SamplingException - if the index is out of bounds
  - getA
```
public float getA(int index)
           throws SamplingException
```
    Returns a value of a single sample.
    
    Parameters:
    
    index - index
    
    Returns:
    
    a value of a single sample
    
    Throws:
    
    SamplingException - if the index is out of bounds
  - getT
```
public float getT(int index)
           throws SamplingException
```
    Returns t value of a single sample.
    
    Parameters:
    
    index - index
    
    Returns:
    
    t value of a single sample
    
    Throws:
    
    SamplingException - if the index is out of bounds
  - getExtendedData
```
public <T,S> T getExtendedData(ExtendedDataType<T,?,S,?> extendedDataType,
                               int index)
                        throws SamplingException
```
    Returns extended data type value of a single sample.
    
    Type Parameters:
    
    T - scalar type of extended data type
    
    S - storage type of extended data type
    
    Parameters:
    
    extendedDataType - data type from which to retrieve the data
    
    index - index for which to retrieve the data
    
    Returns:
    
    extended data type value of a single sample
    
    Throws:
    
    SamplingException - if the index is out of bounds
  - getPosition
```
public FloatLengthVector getPosition()
```
    Returns:
    
    strongly typed copy of position, position is relative to the start of the lane, also when trajectories have been truncated at a position x > 0
  - getSpeed
```
public FloatSpeedVector getSpeed()
```
    Returns:
    
    strongly typed copy of speed
  - getAcceleration
```
public FloatAccelerationVector getAcceleration()
```
    Returns:
    
    strongly typed copy of acceleration
  - getTime
```
public FloatTimeVector getTime()
```
    Returns:
    
    strongly typed copy of time
  - getTotalLength
```
public Length getTotalLength()
```
    Returns:
    
    total length of this trajectory
    
    Throws:
    
    IllegalStateException - if trajectory is empty
  - getTotalDuration
```
public Duration getTotalDuration()
```
    Returns:
    
    total duration of this trajectory
    
    Throws:
    
    IllegalStateException - if trajectory is empty
  - contains
```
public boolean contains(MetaDataType<?> metaDataType)
```
    Parameters:
    
    metaDataType - meta data type
    
    Returns:
    
    whether the trajectory contains the meta data of give type
  - getMetaData
```
public <T> T getMetaData(MetaDataType<T> metaDataType)
```
    Type Parameters:
    
    T - class of meta data
    
    Parameters:
    
    metaDataType - meta data type
    
    Returns:
    
    value of meta data
  - getMetaDataTypes
```
public Set<MetaDataType<?>> getMetaDataTypes()
```
    Returns the included meta data types.
    
    Returns:
    
    included meta data types
  - contains
```
public boolean contains(ExtendedDataType<?,?,?,?> extendedDataType)
```
    Parameters:
    
    extendedDataType - extended data type
    
    Returns:
    
    whether the trajectory contains the extended data of give type
  - getExtendedData
```
public <O,S> O getExtendedData(ExtendedDataType<?,O,S,?> extendedDataType)
                        throws SamplingException
```
    Type Parameters:
    
    O - output type
    
    S - storage type
    
    Parameters:
    
    extendedDataType - extended data type to return
    
    Returns:
    
    values of extended data type
    
    Throws:
    
    SamplingException - if the extended data type is not in the trajectory
  - getExtendedDataTypes
```
public Set<ExtendedDataType<?,?,?,G>> getExtendedDataTypes()
```
    Returns the included extended data types.
    
    Returns:
    
    included extended data types
  - subSet
```
public Trajectory<G> subSet(Length startPosition,
                            Length endPosition)
```
    Copies the trajectory but with a subset of the data. Longitudinal entry is only true if the original trajectory has true, and the subset is from the start.
    
    Parameters:
    
    startPosition - start position
    
    endPosition - end position
    
    Returns:
    
    subset of the trajectory
    
    Throws:
    
    NullPointerException - if an input is null
    
    IllegalArgumentException - of minLength is smaller than maxLength
  - subSet
```
public Trajectory<G> subSet(Time startTime,
                            Time endTime)
```
    Copies the trajectory but with a subset of the data. Longitudinal entry is only true if the original trajectory has true, and the subset is from the start.
    
    Parameters:
    
    startTime - start time
    
    endTime - end time
    
    Returns:
    
    subset of the trajectory
    
    Throws:
    
    NullPointerException - if an input is null
    
    IllegalArgumentException - of minTime is smaller than maxTime
  - subSet
```
public Trajectory<G> subSet(Length startPosition,
                            Length endPosition,
                            Time startTime,
                            Time endTime)
```
    Copies the trajectory but with a subset of the data. Longitudinal entry is only true if the original trajectory has true, and the subset is from the start.
    
    Parameters:
    
    startPosition - start position
    
    endPosition - end position
    
    startTime - start time
    
    endTime - end time
    
    Returns:
    
    subset of the trajectory
    
    Throws:
    
    NullPointerException - if an input is null
    
    IllegalArgumentException - of minLength/Time is smaller than maxLength/Time
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Trajectory<G extends GtuDataInterface>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Trajectory

Method Detail

add

add

size

getGtuId

getX

getV

getA

getT

getX

getV

getA

getT

getExtendedData

getPosition

getSpeed

getAcceleration

getTime

getTotalLength

getTotalDuration

contains

getMetaData

getMetaDataTypes

contains

getExtendedData

getExtendedDataTypes

subSet

subSet

subSet

hashCode

equals

toString