com.pb.routing.gra.persistentupdate.update

Class RoadTypeUpdate

java.lang.Object

com.pb.routing.gra.persistentupdate.update.RoadTypeUpdate

All Implemented Interfaces:

Update, Serializable

public final class RoadTypeUpdate
extends Object
implements Update

Roadtype updates are changes applied to a corresponding RoadType. for a particular roadtype, you can: set the speed of the roadtype or change (increase or decrease) the speed of the roadtype by a value or percentage.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static RoadTypeUpdate	buildRoadTypeSpeedAdjustment(RoadType roadType, Velocity speedAdjustment) This is a speed update where you define a change in the speed of the RoadType by specifying the change in Velocity.
static RoadTypeUpdate	buildRoadTypeSpeedPercentageUpdate(RoadType roadType, int percentage) This method can be used to create a RoadType speed update where you define an increase or decrease in the speed of the roadtype by specifying a percentage, to increase(positive value) or decrease(negative value) the speed.
static RoadTypeUpdate	buildRoadTypeSpeedUpdate(RoadType roadType, Velocity speed) This method can be used to create a RoadType speed update where you can update speed of the roadType by specifying a Velocity
int	getPercentage() Return the speed percentage set for update.
RoadType	getRoadType() Returns the roadType for which the update was created.
Velocity	getSpeed() Return the speed set for update.
Velocity	getSpeedAdjustment() Return the speed adjustment set for update.

Methods inherited from class java.lang.Object

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

Method Detail

buildRoadTypeSpeedPercentageUpdate

public static RoadTypeUpdate buildRoadTypeSpeedPercentageUpdate(RoadType roadType,
                                                                int percentage)
                                                         throws RoutingException

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

Parameters:

roadType - RoadType

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

Returns:

Throws:

RoutingException

buildRoadTypeSpeedUpdate

public static RoadTypeUpdate buildRoadTypeSpeedUpdate(RoadType roadType,
                                                      Velocity speed)
                                               throws RoutingException

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

Parameters:

roadType - RoadType

speed - Velocity speed must be greater than 0

Returns:

Throws:

RoutingException

buildRoadTypeSpeedAdjustment

public static RoadTypeUpdate buildRoadTypeSpeedAdjustment(RoadType roadType,
                                                          Velocity speedAdjustment)
                                                   throws RoutingException

This is a speed update where you define a change in the speed of the RoadType 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:

roadType - RoadType

speedAdjustment - Velocity speed should not be equal to 0

Returns:

Throws:

RoutingException

getRoadType

public RoadType getRoadType()

Returns the roadType for which the update was created.

Returns:

RoadType

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.