desmoj.extensions.space3D

Class Movement

java.lang.Object

desmoj.extensions.space3D.Movement

public class Movement
extends java.lang.Object

The Movement class stores the track, the duration informations of each phase of a movement and its associated speed. A movement will be divided into 3 phases, the acceleration phase, the maximum speed phase and the deceleration phase. It's allowed to set the initial speed greater than the maximum speed. Then the acceleration phase will be used to reduce the speed to the maximum speed.

Author:

Fred Sun

Constructor Summary

Constructors

Constructor and Description
Movement() Constructs a Movement object with empty values.
Movement(Track track, double accDuration, double maxSpeedDuration, double decDuration, double initialSpeed, double maxSpeed, double endSpeed) It constructs a Movement object with given speed and duration of each phases.
Movement(Track track, TimeSpan accDuration, TimeSpan maxSpeedDuration, TimeSpan decDuration, double initialSpeed, double maxSpeed, double endSpeed) It constructs a Movement object with given speed and duration of each phases.

Method Summary

Modifier and Type	Method and Description
TimeSpan	getAccDuration() Gets the duration of the acceleration phase.
Length	getCurrentMovedDistance(TimeInstant movingStartTime, TimeInstant now) Gets the moved distance based on the elapsed SimTime.
Vector3d	getCurrentMovingDirection(TimeInstant movingStartTime, TimeInstant now) Gets the current moving direction on this movement based on the elapsed SimTime.
double[]	getCurrentPosition(TimeInstant movingStartTime, TimeInstant now) Gets the current position on this movement based on elapsed SimTime.
TimeSpan	getDecDuration() Gets the duration of the deceleration phase.
double	getEndSpeed() Gets the end speed.
double	getInitialSpeed() Gets the initial speed.
double	getMaxSpeed() Gets the maximum speed.
TimeSpan	getMaxSpeedDuration() Gets the duration when the movement has the maximum speed.
TimeSpan	getTotalDuration() Gets the total duration which is the sum of all the 3 phases.
Track	getTrack() Gets the track object of this movement.
boolean	isValid() Tests if the movement is valid and fully specified.
void	setAccDuration(TimeSpan accDuration) Sets the acceleration duration
void	setDecDuration(TimeSpan decDuration) Sets the deceleration duration.
void	setEndSpeed(double endSpeed) Sets the end speed.
void	setInitialSpeed(double initialSpeed) Sets the initial speed.
void	setMaxSpeed(double maxSpeed) Sets the maximum speed.
void	setMaxSpeedDuration(TimeSpan maxSpeedDuration) Sets the duration of the maximum speed.
void	setTrack(Track track) Sets the track for the movement.

Methods inherited from class java.lang.Object

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

Constructor Detail

Movement

public Movement()

Constructs a Movement object with empty values.

Movement

public Movement(Track track,
                TimeSpan accDuration,
                TimeSpan maxSpeedDuration,
                TimeSpan decDuration,
                double initialSpeed,
                double maxSpeed,
                double endSpeed)

It constructs a Movement object with given speed and duration of each phases.

Parameters:

track - The track associated to this movement.

accDuration - The duration of the acceleration phase.

maxSpeedDuration - The duration of the phase when the movement has the maximum speed.

decDuration - The duration of the deceleration phase.

initialSpeed - The initial speed.

maxSpeed - The maximum speed.

endSpeed - The end speed.

Movement

public Movement(Track track,
                double accDuration,
                double maxSpeedDuration,
                double decDuration,
                double initialSpeed,
                double maxSpeed,
                double endSpeed)

It constructs a Movement object with given speed and duration of each phases. The durations are in double and measured in the unit of the reference time.

Parameters:

track - The track associated to this movement.

accDuration - The duration of the acceleration phase.

maxSpeedDuration - The duration of the phase when the movement has the maximum speed.

decDuration - The duration of the deceleration phase.

initialSpeed - The initial speed.

maxSpeed - The maximum speed.

endSpeed - The end speed.

Method Detail

getAccDuration

public TimeSpan getAccDuration()

Gets the duration of the acceleration phase.

Returns:

The duration of the acceleration phase.

getCurrentMovedDistance

public Length getCurrentMovedDistance(TimeInstant movingStartTime,
                                      TimeInstant now)

Gets the moved distance based on the elapsed SimTime.

Parameters:

movingStartTime - The SimTime, when the movement has started.

now - The current SimTime.

Returns:

The moved distance in ExtendedLength.

getCurrentMovingDirection

public Vector3d getCurrentMovingDirection(TimeInstant movingStartTime,
                                          TimeInstant now)

Gets the current moving direction on this movement based on the elapsed SimTime.

Parameters:

movingStartTime - The SimTime, when the movement has started.

now - The current SimTime.

Returns:

The current direction in double[3].

getCurrentPosition

public double[] getCurrentPosition(TimeInstant movingStartTime,
                                   TimeInstant now)

Gets the current position on this movement based on elapsed SimTime.

Parameters:

movingStartTime - The SimTime, when the movement has started.

now - The current SimTime.

Returns:

The current position in double[3].

getDecDuration

public TimeSpan getDecDuration()

Gets the duration of the deceleration phase.

Returns:

The duration of the deceleration phase.

getEndSpeed

public double getEndSpeed()

Gets the end speed.

Returns:

the end speed

getInitialSpeed

public double getInitialSpeed()

Gets the initial speed.

Returns:

the initial speed

getMaxSpeed

public double getMaxSpeed()

Gets the maximum speed.

Returns:

the maximum speed

getMaxSpeedDuration

public TimeSpan getMaxSpeedDuration()

Gets the duration when the movement has the maximum speed.

Returns:

The duration when the movement has the maximum speed.

getTotalDuration

public TimeSpan getTotalDuration()

Gets the total duration which is the sum of all the 3 phases.

Returns:

The total duration.

getTrack

public Track getTrack()

Gets the track object of this movement.

Returns:

the track object of this movement.

isValid

public boolean isValid()

Tests if the movement is valid and fully specified.

Returns:

true if: The Track object is instantiated and if neither the track length, the total duration and the sum of the speed in each phase is zero. If one of these condition is zero, then all of them should be zero. Otherwise false will be returned.

setAccDuration

public void setAccDuration(TimeSpan accDuration)

Sets the acceleration duration

Parameters:

accDuration - the acceleration duration to set

setDecDuration

public void setDecDuration(TimeSpan decDuration)

Sets the deceleration duration.

Parameters:

decDuration - the deceleration duration to set

setEndSpeed

public void setEndSpeed(double endSpeed)

Sets the end speed.

Parameters:

endSpeed - the end speed to set

setInitialSpeed

public void setInitialSpeed(double initialSpeed)

Sets the initial speed.

Parameters:

initialSpeed - the initial speed to set

setMaxSpeed

public void setMaxSpeed(double maxSpeed)

Sets the maximum speed.

Parameters:

maxSpeed - the maximum speed to set

setMaxSpeedDuration

public void setMaxSpeedDuration(TimeSpan maxSpeedDuration)

Sets the duration of the maximum speed.

Parameters:

maxSpeedDuration - the duration with the maximum speed to set

setTrack

public void setTrack(Track track)

Sets the track for the movement.

Parameters:

track - track to be set.