com.pb.routing.gra.persistentupdate.update

Class PointUpdate

java.lang.Object

com.pb.routing.gra.persistentupdate.update.PointUpdate

All Implemented Interfaces:

Update, Serializable

public final class PointUpdate
extends Object
implements Update

Point updates are changes applied to a corresponding IPoint. for a particular point, you can: exclude the point, set the speed of the point or change (increase or decrease) the speed of the point by a value or percentage.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static PointUpdate	buildPointExclude(IPoint point, boolean exclude) This method can be used to create a point update which exclude the specified point from the route calculation.
static PointUpdate	buildPointSpeedAdjustment(IPoint point, Velocity speedAdjustment) This is a speed update where you define a change in the speed of the point by specifying the change in Velocity.
static PointUpdate	buildPointSpeedPercentageUpdate(IPoint point, int percentage) This method can be used to create a point speed update where you define an increase in the speed of the point by specifying a percentage to increase(positive value) or decrease(negative value) the speed.
static PointUpdate	buildPointSpeedUpdate(IPoint point, Velocity speed) This method can be used to create a point speed update where you can update speed of the point by specifying a Velocity
int	getPercentage() Return the speed percentage set for update.
IPoint	getPoint() Returns the point for which the update was created.
Velocity	getSpeed() Return the speed set for update.
Velocity	getSpeedAdjustment() Return the speed adjustment set for update.
boolean	isExclude() Check if the point is excluded.

Methods inherited from class java.lang.Object

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

Method Detail

buildPointExclude

public static PointUpdate buildPointExclude(IPoint point,
                                            boolean exclude)
                                     throws RoutingException

This method can be used to create a point update which exclude the specified point from the route calculation. To exclude a point you need to specify the point and set exclude to true in order to exclude the point.

Parameters:

point - IPoint

exclude - Boolean true or false

Returns:

Throws:

RoutingException

buildPointSpeedPercentageUpdate

public static PointUpdate buildPointSpeedPercentageUpdate(IPoint point,
                                                          int percentage)
                                                   throws RoutingException

This method can be used to create a point speed update where you define an increase in the speed of the point by specifying a percentage to increase(positive value) or decrease(negative value) the speed.

Parameters:

point - IPoint

percentage - integer value must be less than 100, greater than -100 and !=0

Returns:

Throws:

RoutingException

buildPointSpeedUpdate

public static PointUpdate buildPointSpeedUpdate(IPoint point,
                                                Velocity speed)
                                         throws RoutingException

This method can be used to create a point speed update where you can update speed of the point by specifying a Velocity

Parameters:

point - IPoint

speed - Velocity speed must be greater than 0

Returns:

Throws:

RoutingException

buildPointSpeedAdjustment

public static PointUpdate buildPointSpeedAdjustment(IPoint point,
                                                    Velocity speedAdjustment)
                                             throws RoutingException

This is a speed update where you define a change in the speed of the point by specifying the change in Velocity. Speed values can be increased(positive value) or decreases(negative value). The speed adjustment should not result in a negative speed value.

Parameters:

point - IPoint

speedAdjustment - Velocity speed should not be equal to 0

Returns:

Throws:

RoutingException

getPoint

public IPoint getPoint()

Returns the point for which the update was created.

Returns:

IPoint

isExclude

public boolean isExclude()

Check if the point is excluded.

Returns:

true or false

getSpeed

public Velocity getSpeed()

Return the speed set for update.

Returns:

Velocity

getSpeedAdjustment

public Velocity getSpeedAdjustment()

Return the speed adjustment set for update.

Returns:

Velocity

getPercentage

public int getPercentage()

Return the speed percentage set for update.

Returns:

integer percentage value.