Package org.goplanit.service.routed

Interface RoutedTripFrequency

All Superinterfaces:

Cloneable, Comparable<IdAble>, ExternalIdAble, IdAble, Iterable<ServiceLegSegment>, ManagedId, RoutedTrip

All Known Implementing Classes:

RoutedTripFrequencyImpl

public interface RoutedTripFrequency
extends RoutedTrip, Iterable<ServiceLegSegment>

Interface for frequency based trips of a RoutedService. The route is defined based on legs on the parent ServiceNetwork the RoutedService - and therefore the trip - resides on. Legs are ordered such that the first leg represents the starting point and the last the end point. It is expected that the legs combined are contiguous and imply the direction of the route by their ordering.

Author:

markr

Field Summary

Fields inherited from interface org.goplanit.service.routed.RoutedTrip

ROUTED_TRIP_ID_CLASS

Method Summary

Modifier and Type	Method	Description
void	addLegSegment(ServiceLegSegment legSegment)	Add a new leg segment (directed leg) to the end of the already registered legs.
void	clearLegs()	Clear all legs from the trip
default ServiceLegSegment	getFirstLegSegment()	Get first leg segment of the routed trip
double	getFrequencyPerHour()	Collect frequency per hour for this trip
default ServiceLegSegment	getLastLegSegment()	Get last leg segment of the routed trip
ServiceLegSegment	getLegSegment(int index)	Get a leg segment in a particular position of the routed trip
int	getNumberOfLegSegments()	Collect the number of registered leg segments
default boolean	hasLegSegments()	Verify if there are leg segments registered
default boolean	hasValidFrequency()	Verify if a valid frequency is defined, must be positive to be valid
void	setFrequencyPerHour(double frequencyPerHour)	Set the frequency per hour

Methods inherited from interface org.goplanit.utils.id.ExternalIdAble

getExternalId, getXmlId, hasExternalId, hasXmlId, setExternalId, setXmlId

Methods inherited from interface org.goplanit.utils.id.IdAble

clone, compareTo, getId, idEquals, idHashCode

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.goplanit.utils.id.ManagedId

recreateManagedIds, resetChildManagedIdEntities

Methods inherited from interface org.goplanit.service.routed.RoutedTrip

getIdClass

Method Detail

clearLegs

void clearLegs()

Clear all legs from the trip

getNumberOfLegSegments

int getNumberOfLegSegments()

Collect the number of registered leg segments

Returns:

number of registered leg segments

addLegSegment

void addLegSegment(ServiceLegSegment legSegment)

Add a new leg segment (directed leg) to the end of the already registered legs.

Parameters:

legSegment - to add to the trip's route

getLegSegment

ServiceLegSegment getLegSegment(int index)

Get a leg segment in a particular position of the routed trip

Parameters:

index - to collect segment for

Returns:

the leg segment found

getFrequencyPerHour

double getFrequencyPerHour()

Collect frequency per hour for this trip

Returns:

frequencyPerHour

setFrequencyPerHour

void setFrequencyPerHour(double frequencyPerHour)

Set the frequency per hour

Parameters:

frequencyPerHour - to use

hasValidFrequency

default boolean hasValidFrequency()

Verify if a valid frequency is defined, must be positive to be valid

Returns:

true when a positive frequency is defined, false otherwise

hasLegSegments

default boolean hasLegSegments()

Verify if there are leg segments registered

Returns:

true when leg segments are registered, false otherwise

getFirstLegSegment

default ServiceLegSegment getFirstLegSegment()

Get first leg segment of the routed trip

Returns:

the leg segment with id 0

getLastLegSegment

default ServiceLegSegment getLastLegSegment()

Get last leg segment of the routed trip

Returns:

the last segment, i.e., the one with the highest id