de.vdv.ojp20.MultiPointTripParamStructure Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ojp-java-model Show documentation
Show all versions of ojp-java-model Show documentation
Generates Java model from OJP xsds using jaxb.
The newest version!
//
// This file was generated by the Eclipse Implementation of JAXB, v4.0.5
// See https://eclipse-ee4j.github.io/jaxb-ri
// Any modifications to this file will be lost upon recompilation of the source schema.
//
package de.vdv.ojp20;
import java.math.BigInteger;
import java.time.Duration;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlSchemaType;
import jakarta.xml.bind.annotation.XmlType;
import jakarta.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.opentripplanner.ojp.netex.OmitNullsToStringStyle;
import org.opentripplanner.ojp.util.DurationXmlAdapter;
/**
* Multi-point trip request parameter structure.
*
* Java class for MultiPointTripParamStructure complex type
.
*
* The following schema fragment specifies the expected content contained within this class.
*
* {@code
*
*
*
*
*
*
*
*
* }
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "MultiPointTripParamStructure", propOrder = {
"modeAndModeOfOperationFilter",
"lineFilter",
"operatorFilter",
"vehicleFilter",
"tariffzoneFilter",
"noSingleStep",
"noStairs",
"noEscalator",
"noElevator",
"noRamp",
"noSight",
"noTravelator",
"levelEntrance",
"levelEntranceOrBoardingAid",
"bikeTransport",
"walkSpeed",
"additionalTransferTime",
"hikingProfile",
"cyclingProfile",
"numberOfResults",
"numberOfResultsBefore",
"numberOfResultsAfter",
"timeWindow",
"useRealtimeData",
"immediateTripStart",
"transferLimit",
"optimisationMethod",
"considerElevationData",
"includeAllRestrictedLines",
"passengerCategory",
"multiPointType",
"includeTrackSections",
"includeLegProjection",
"includeTurnDescription",
"includeAccessFeatures",
"includeAccessFeaturesStatus",
"includeAccessibilityDetails",
"includePlacesContext",
"includeSituationsContext",
"includeIntermediateStops",
"includeFare",
"includeOperatingDays",
"tripSummaryOnly",
"fareParam",
"extension"
})
public class MultiPointTripParamStructure {
/**
* MODEs and MODEs OF OPERATION to be considered in trip calculation. If only MODE is used, then it is for all MODE OF OPERATION. If combinations of MODE and MODE OF OPERATION are used (multiples), then all combinations are to be considered.
*
*/
@XmlElement(name = "ModeAndModeOfOperationFilter")
protected List modeAndModeOfOperationFilter;
/**
* Lines/Directions to include/exclude.
*
*/
@XmlElement(name = "LineFilter")
protected LineDirectionFilterStructure lineFilter;
/**
* Transport operators to include/exclude.
*
*/
@XmlElement(name = "OperatorFilter")
protected OperatorFilterStructure operatorFilter;
/**
* Filter for VEHICLE and TRAIN NUMBERs.
*
*/
@XmlElement(name = "VehicleFilter")
protected VehicleFilterStructure vehicleFilter;
/**
* Filter for trips using only specific tariff zones.
*
*/
@XmlElement(name = "TariffzoneFilter")
protected TariffzoneFilterStructure tariffzoneFilter;
/**
* The user is not able to pass over (or wants to avoid) single steps. Stairs and non-level entrances are not excluded.
*
*/
@XmlElement(name = "NoSingleStep", defaultValue = "false")
protected Boolean noSingleStep;
/**
* The user is not able to walk up/downstairs.
*
*/
@XmlElement(name = "NoStairs", defaultValue = "false")
protected Boolean noStairs;
/**
* The user is not able to use an escalator.
*
*/
@XmlElement(name = "NoEscalator", defaultValue = "false")
protected Boolean noEscalator;
/**
* The user is not able to use an elevator.
*
*/
@XmlElement(name = "NoElevator", defaultValue = "false")
protected Boolean noElevator;
/**
* The user is not able to use a ramp.
*
*/
@XmlElement(name = "NoRamp", defaultValue = "false")
protected Boolean noRamp;
/**
* The user is not able to see.
*
*/
@XmlElement(name = "NoSight", defaultValue = "false")
protected Boolean noSight;
/**
* The user is not able to use a travelator.
*
*/
@XmlElement(name = "NoTravelator", defaultValue = "false")
protected Boolean noTravelator;
/**
* The user needs vehicles with level entrance between platform and vehicle.
*
*/
@XmlElement(name = "LevelEntrance", defaultValue = "false")
protected Boolean levelEntrance;
/**
* The user needs vehicles with level entrance between platform and vehicle, an appropriate ramp, or assistance for boarding or alighting (for assisted and unassisted wheelchairs, or similar constraints).
*
*/
@XmlElement(name = "LevelEntranceOrBoardingAid", defaultValue = "false")
protected Boolean levelEntranceOrBoardingAid;
/**
* The user wants to carry a bike on public transport (could be extended in future to transporting big luggage / animals / etc.).
*
*/
@XmlElement(name = "BikeTransport", defaultValue = "false")
protected Boolean bikeTransport;
/**
* Deviation from average walking speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster.
*
*/
@XmlElement(name = "WalkSpeed")
@XmlSchemaType(name = "nonNegativeInteger")
protected BigInteger walkSpeed;
/**
* Additional time added to all transfers (also to transfers between individual to public transport, not modelled in Transmodel).
*
*/
@XmlElement(name = "AdditionalTransferTime", type = String.class)
@XmlJavaTypeAdapter(DurationXmlAdapter.class)
@XmlSchemaType(name = "duration")
protected Duration additionalTransferTime;
/**
* Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen
*
*/
@XmlElement(name = "HikingProfile", defaultValue = "easy")
protected String hikingProfile;
/**
* Cycling profile of the user (especially for sportive activities).
*
*/
@XmlElement(name = "CyclingProfile", defaultValue = "fast")
protected String cyclingProfile;
/**
* The number of trip results that the user wants to see at least. Be aware that some implementations will deliver one of the TripResults before the indicated departure time. This means that you can't assume that you get the exact number of results that you asked for in the request from the server.
*
*/
@XmlElement(name = "NumberOfResults")
@XmlSchemaType(name = "positiveInteger")
protected BigInteger numberOfResults;
/**
* The desired number of trip results before the given time (at origin or destination).
*
*/
@XmlElement(name = "NumberOfResultsBefore", defaultValue = "0")
@XmlSchemaType(name = "nonNegativeInteger")
protected BigInteger numberOfResultsBefore;
/**
* The desired number of trip results after the given time (at origin or destination).
*
*/
@XmlElement(name = "NumberOfResultsAfter", defaultValue = "0")
@XmlSchemaType(name = "nonNegativeInteger")
protected BigInteger numberOfResultsAfter;
/**
* Time window in which the trips should be, starting from the time specified in PlaceContext. Implements TRIP REQUEST.FlexibilityWindow. All trips within the window should be provided by the implementation.
*
*/
@XmlElement(name = "TimeWindow", type = String.class)
@XmlJavaTypeAdapter(DurationXmlAdapter.class)
@XmlSchemaType(name = "duration")
protected Duration timeWindow;
/**
* The way real-time data should be used in the calculation of the trip.
*
*/
@XmlElement(name = "UseRealtimeData", defaultValue = "full")
@XmlSchemaType(name = "string")
protected UseRealtimeDataEnumeration useRealtimeData;
/**
* Whether the trip calculation should find a solution that starts immediately (e.g., because the user is already on the way) instead of finding the latest possible start opportunity. Default is FALSE.
*
*/
@XmlElement(name = "ImmediateTripStart", defaultValue = "false")
protected Boolean immediateTripStart;
/**
* The maximum number of interchanges the user will accept per trip.
*
*/
@XmlElement(name = "TransferLimit")
@XmlSchemaType(name = "nonNegativeInteger")
protected BigInteger transferLimit;
/**
* The type of algorithm to be used in the calculation of the trip (fastest, least walking, etc.).
*
*/
@XmlElement(name = "OptimisationMethod")
@XmlSchemaType(name = "string")
protected OptimisationMethodEnumeration optimisationMethod;
/**
* Whether the trip calculation should take elevation data into account (bike, foot). Default is FALSE.
*
*/
@XmlElement(name = "ConsiderElevationData", defaultValue = "false")
protected Boolean considerElevationData;
/**
* There might exist lines that have special restrictions and are not generally available to the public. E.g. school buses, company shuttles. dragLifts need to have an ACCESS MODE ski. Lines with ACCESS MODE bicycle will be included as well. If this flag is set, then existing restricted lines are considered by the router, irrespective of the selected passenger categories or the MotorisedMainTravelMode. The results are marked as restricted in the ServiceGroup. The usage could also be detailed with Attribute elements. Restricted trumps PassengerCategory, for example. If Restricted is set to true, all services are displayed.
*
*/
@XmlElement(name = "IncludeAllRestrictedLines", defaultValue = "false")
protected Boolean includeAllRestrictedLines;
/**
* Sequence of all passenger categories, for which this search shall be conducted. In rare cases additional offerings may be available (e.g., demand responsive service with certain areas being reserved for seniors). If multiple PassengerCategories are provided, then Services are shown when they are available for at least one PassengerCategory.
*
*/
@XmlElement(name = "PassengerCategory")
@XmlSchemaType(name = "string")
protected List passengerCategory;
/**
* Defines how the router should handle requests with multiple origins and destinations. As it is important for the strategy of the distributed trip planning the MultiPointType should be set. If the type is not supported a TRIP_MULTIPOINT_TYPE_NOT_SUPPORTED warning or error must be returned. Default is anyPoint.
*
*/
@XmlElement(name = "MultiPointType", defaultValue = "anyPoint")
@XmlSchemaType(name = "string")
protected MultiPointTypeEnumeration multiPointType;
/**
* Whether the result should include TrackSection elements to describe the geographic route of each journey leg.
*
*/
@XmlElement(name = "IncludeTrackSections", defaultValue = "false")
protected Boolean includeTrackSections;
/**
* Whether the result should include the geographic projection (coordinates) of each journey leg.
*
*/
@XmlElement(name = "IncludeLegProjection", defaultValue = "false")
protected Boolean includeLegProjection;
/**
* Whether the result should include turn-by-turn instructions for each journey leg.
*
*/
@XmlElement(name = "IncludeTurnDescription", defaultValue = "false")
protected Boolean includeTurnDescription;
/**
* Whether the result should include the access features (stairs, elevator, etc.) on each path link.
*
*/
@XmlElement(name = "IncludeAccessFeatures", defaultValue = "false")
protected Boolean includeAccessFeatures;
/**
* Whether the result should include real time status of access features to indicate broken equipment.
*
*/
@XmlElement(name = "IncludeAccessFeaturesStatus", defaultValue = "false")
protected Boolean includeAccessFeaturesStatus;
/**
* Which accessibility features and other accessibility-related information to retrieve (e.g., guidance text for the visually impaired).
*
*/
@XmlElement(name = "IncludeAccessibilityDetails")
@XmlSchemaType(name = "string")
protected List includeAccessibilityDetails;
/**
* Whether the place context is needed. If a requestor has that information already, the response can be made slimmer, when set to false. Default is true.
*
*/
@XmlElement(name = "IncludePlacesContext", defaultValue = "true")
protected Boolean includePlacesContext;
/**
* Whether the situation context is needed. If a requestor has that information by other means or can't process it, the response can be made slimmer, when set to false. Default is true.
*
*/
@XmlElement(name = "IncludeSituationsContext", defaultValue = "true")
protected Boolean includeSituationsContext;
/**
* Whether the result should include intermediate stops (between the passenger's board and alight stops).
*
*/
@XmlElement(name = "IncludeIntermediateStops", defaultValue = "false")
protected Boolean includeIntermediateStops;
/**
* Whether the result should include fare information.
*
*/
@XmlElement(name = "IncludeFare", defaultValue = "false")
protected Boolean includeFare;
/**
* Whether the result should include operating day information - as encoded bit string and in natural language.
*
*/
@XmlElement(name = "IncludeOperatingDays", defaultValue = "false")
protected Boolean includeOperatingDays;
/**
* If true, then the response will contain only summaries of the found trips. Default is false.
*
*/
@XmlElement(name = "TripSummaryOnly", defaultValue = "false")
protected Boolean tripSummaryOnly;
/**
* Parameters for fare calculation. Only used if IncludeFare is set (TripContentFilterGroup).
*
*/
@XmlElement(name = "FareParam")
protected FareParamStructure fareParam;
@XmlElement(name = "Extension")
protected Object extension;
/**
* MODEs and MODEs OF OPERATION to be considered in trip calculation. If only MODE is used, then it is for all MODE OF OPERATION. If combinations of MODE and MODE OF OPERATION are used (multiples), then all combinations are to be considered.
*
* Gets the value of the modeAndModeOfOperationFilter property.
*
* This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object.
* This is why there is not a set method for the modeAndModeOfOperationFilter property.
*
*
* For example, to add a new item, do as follows:
*
*
* getModeAndModeOfOperationFilter().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link ModeAndModeOfOperationFilterStructure }
*
*
*
* @return
* The value of the modeAndModeOfOperationFilter property.
*/
public List getModeAndModeOfOperationFilter() {
if (modeAndModeOfOperationFilter == null) {
modeAndModeOfOperationFilter = new ArrayList<>();
}
return this.modeAndModeOfOperationFilter;
}
/**
* Lines/Directions to include/exclude.
*
* @return
* possible object is
* {@link LineDirectionFilterStructure }
*
*/
public LineDirectionFilterStructure getLineFilter() {
return lineFilter;
}
/**
* Sets the value of the lineFilter property.
*
* @param value
* allowed object is
* {@link LineDirectionFilterStructure }
*
* @see #getLineFilter()
*/
public void setLineFilter(LineDirectionFilterStructure value) {
this.lineFilter = value;
}
/**
* Transport operators to include/exclude.
*
* @return
* possible object is
* {@link OperatorFilterStructure }
*
*/
public OperatorFilterStructure getOperatorFilter() {
return operatorFilter;
}
/**
* Sets the value of the operatorFilter property.
*
* @param value
* allowed object is
* {@link OperatorFilterStructure }
*
* @see #getOperatorFilter()
*/
public void setOperatorFilter(OperatorFilterStructure value) {
this.operatorFilter = value;
}
/**
* Filter for VEHICLE and TRAIN NUMBERs.
*
* @return
* possible object is
* {@link VehicleFilterStructure }
*
*/
public VehicleFilterStructure getVehicleFilter() {
return vehicleFilter;
}
/**
* Sets the value of the vehicleFilter property.
*
* @param value
* allowed object is
* {@link VehicleFilterStructure }
*
* @see #getVehicleFilter()
*/
public void setVehicleFilter(VehicleFilterStructure value) {
this.vehicleFilter = value;
}
/**
* Filter for trips using only specific tariff zones.
*
* @return
* possible object is
* {@link TariffzoneFilterStructure }
*
*/
public TariffzoneFilterStructure getTariffzoneFilter() {
return tariffzoneFilter;
}
/**
* Sets the value of the tariffzoneFilter property.
*
* @param value
* allowed object is
* {@link TariffzoneFilterStructure }
*
* @see #getTariffzoneFilter()
*/
public void setTariffzoneFilter(TariffzoneFilterStructure value) {
this.tariffzoneFilter = value;
}
/**
* The user is not able to pass over (or wants to avoid) single steps. Stairs and non-level entrances are not excluded.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isNoSingleStep() {
return noSingleStep;
}
/**
* Sets the value of the noSingleStep property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isNoSingleStep()
*/
public void setNoSingleStep(Boolean value) {
this.noSingleStep = value;
}
/**
* The user is not able to walk up/downstairs.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isNoStairs() {
return noStairs;
}
/**
* Sets the value of the noStairs property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isNoStairs()
*/
public void setNoStairs(Boolean value) {
this.noStairs = value;
}
/**
* The user is not able to use an escalator.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isNoEscalator() {
return noEscalator;
}
/**
* Sets the value of the noEscalator property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isNoEscalator()
*/
public void setNoEscalator(Boolean value) {
this.noEscalator = value;
}
/**
* The user is not able to use an elevator.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isNoElevator() {
return noElevator;
}
/**
* Sets the value of the noElevator property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isNoElevator()
*/
public void setNoElevator(Boolean value) {
this.noElevator = value;
}
/**
* The user is not able to use a ramp.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isNoRamp() {
return noRamp;
}
/**
* Sets the value of the noRamp property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isNoRamp()
*/
public void setNoRamp(Boolean value) {
this.noRamp = value;
}
/**
* The user is not able to see.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isNoSight() {
return noSight;
}
/**
* Sets the value of the noSight property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isNoSight()
*/
public void setNoSight(Boolean value) {
this.noSight = value;
}
/**
* The user is not able to use a travelator.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isNoTravelator() {
return noTravelator;
}
/**
* Sets the value of the noTravelator property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isNoTravelator()
*/
public void setNoTravelator(Boolean value) {
this.noTravelator = value;
}
/**
* The user needs vehicles with level entrance between platform and vehicle.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isLevelEntrance() {
return levelEntrance;
}
/**
* Sets the value of the levelEntrance property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isLevelEntrance()
*/
public void setLevelEntrance(Boolean value) {
this.levelEntrance = value;
}
/**
* The user needs vehicles with level entrance between platform and vehicle, an appropriate ramp, or assistance for boarding or alighting (for assisted and unassisted wheelchairs, or similar constraints).
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isLevelEntranceOrBoardingAid() {
return levelEntranceOrBoardingAid;
}
/**
* Sets the value of the levelEntranceOrBoardingAid property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isLevelEntranceOrBoardingAid()
*/
public void setLevelEntranceOrBoardingAid(Boolean value) {
this.levelEntranceOrBoardingAid = value;
}
/**
* The user wants to carry a bike on public transport (could be extended in future to transporting big luggage / animals / etc.).
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isBikeTransport() {
return bikeTransport;
}
/**
* Sets the value of the bikeTransport property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isBikeTransport()
*/
public void setBikeTransport(Boolean value) {
this.bikeTransport = value;
}
/**
* Deviation from average walking speed in percent. 100% percent is average speed. Less than 100 % slower, Greater than 150% faster.
*
* @return
* possible object is
* {@link BigInteger }
*
*/
public BigInteger getWalkSpeed() {
return walkSpeed;
}
/**
* Sets the value of the walkSpeed property.
*
* @param value
* allowed object is
* {@link BigInteger }
*
* @see #getWalkSpeed()
*/
public void setWalkSpeed(BigInteger value) {
this.walkSpeed = value;
}
/**
* Additional time added to all transfers (also to transfers between individual to public transport, not modelled in Transmodel).
*
* @return
* possible object is
* {@link String }
*
*/
public Duration getAdditionalTransferTime() {
return additionalTransferTime;
}
/**
* Sets the value of the additionalTransferTime property.
*
* @param value
* allowed object is
* {@link String }
*
* @see #getAdditionalTransferTime()
*/
public void setAdditionalTransferTime(Duration value) {
this.additionalTransferTime = value;
}
/**
* Users hiking profile. The main element to control general walking behaviour is WalkSpeed (together with accessibility constraints). Note: explanations in German can be found here: https://akademie.alpinewelten.com/bergwandern/klassifizierung-von-wanderwegen
*
* @return
* possible object is
* {@link String }
*
*/
public String getHikingProfile() {
return hikingProfile;
}
/**
* Sets the value of the hikingProfile property.
*
* @param value
* allowed object is
* {@link String }
*
* @see #getHikingProfile()
*/
public void setHikingProfile(String value) {
this.hikingProfile = value;
}
/**
* Cycling profile of the user (especially for sportive activities).
*
* @return
* possible object is
* {@link String }
*
*/
public String getCyclingProfile() {
return cyclingProfile;
}
/**
* Sets the value of the cyclingProfile property.
*
* @param value
* allowed object is
* {@link String }
*
* @see #getCyclingProfile()
*/
public void setCyclingProfile(String value) {
this.cyclingProfile = value;
}
/**
* The number of trip results that the user wants to see at least. Be aware that some implementations will deliver one of the TripResults before the indicated departure time. This means that you can't assume that you get the exact number of results that you asked for in the request from the server.
*
* @return
* possible object is
* {@link BigInteger }
*
*/
public BigInteger getNumberOfResults() {
return numberOfResults;
}
/**
* Sets the value of the numberOfResults property.
*
* @param value
* allowed object is
* {@link BigInteger }
*
* @see #getNumberOfResults()
*/
public void setNumberOfResults(BigInteger value) {
this.numberOfResults = value;
}
/**
* The desired number of trip results before the given time (at origin or destination).
*
* @return
* possible object is
* {@link BigInteger }
*
*/
public BigInteger getNumberOfResultsBefore() {
return numberOfResultsBefore;
}
/**
* Sets the value of the numberOfResultsBefore property.
*
* @param value
* allowed object is
* {@link BigInteger }
*
* @see #getNumberOfResultsBefore()
*/
public void setNumberOfResultsBefore(BigInteger value) {
this.numberOfResultsBefore = value;
}
/**
* The desired number of trip results after the given time (at origin or destination).
*
* @return
* possible object is
* {@link BigInteger }
*
*/
public BigInteger getNumberOfResultsAfter() {
return numberOfResultsAfter;
}
/**
* Sets the value of the numberOfResultsAfter property.
*
* @param value
* allowed object is
* {@link BigInteger }
*
* @see #getNumberOfResultsAfter()
*/
public void setNumberOfResultsAfter(BigInteger value) {
this.numberOfResultsAfter = value;
}
/**
* Time window in which the trips should be, starting from the time specified in PlaceContext. Implements TRIP REQUEST.FlexibilityWindow. All trips within the window should be provided by the implementation.
*
* @return
* possible object is
* {@link String }
*
*/
public Duration getTimeWindow() {
return timeWindow;
}
/**
* Sets the value of the timeWindow property.
*
* @param value
* allowed object is
* {@link String }
*
* @see #getTimeWindow()
*/
public void setTimeWindow(Duration value) {
this.timeWindow = value;
}
/**
* The way real-time data should be used in the calculation of the trip.
*
* @return
* possible object is
* {@link UseRealtimeDataEnumeration }
*
*/
public UseRealtimeDataEnumeration getUseRealtimeData() {
return useRealtimeData;
}
/**
* Sets the value of the useRealtimeData property.
*
* @param value
* allowed object is
* {@link UseRealtimeDataEnumeration }
*
* @see #getUseRealtimeData()
*/
public void setUseRealtimeData(UseRealtimeDataEnumeration value) {
this.useRealtimeData = value;
}
/**
* Whether the trip calculation should find a solution that starts immediately (e.g., because the user is already on the way) instead of finding the latest possible start opportunity. Default is FALSE.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isImmediateTripStart() {
return immediateTripStart;
}
/**
* Sets the value of the immediateTripStart property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isImmediateTripStart()
*/
public void setImmediateTripStart(Boolean value) {
this.immediateTripStart = value;
}
/**
* The maximum number of interchanges the user will accept per trip.
*
* @return
* possible object is
* {@link BigInteger }
*
*/
public BigInteger getTransferLimit() {
return transferLimit;
}
/**
* Sets the value of the transferLimit property.
*
* @param value
* allowed object is
* {@link BigInteger }
*
* @see #getTransferLimit()
*/
public void setTransferLimit(BigInteger value) {
this.transferLimit = value;
}
/**
* The type of algorithm to be used in the calculation of the trip (fastest, least walking, etc.).
*
* @return
* possible object is
* {@link OptimisationMethodEnumeration }
*
*/
public OptimisationMethodEnumeration getOptimisationMethod() {
return optimisationMethod;
}
/**
* Sets the value of the optimisationMethod property.
*
* @param value
* allowed object is
* {@link OptimisationMethodEnumeration }
*
* @see #getOptimisationMethod()
*/
public void setOptimisationMethod(OptimisationMethodEnumeration value) {
this.optimisationMethod = value;
}
/**
* Whether the trip calculation should take elevation data into account (bike, foot). Default is FALSE.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isConsiderElevationData() {
return considerElevationData;
}
/**
* Sets the value of the considerElevationData property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isConsiderElevationData()
*/
public void setConsiderElevationData(Boolean value) {
this.considerElevationData = value;
}
/**
* There might exist lines that have special restrictions and are not generally available to the public. E.g. school buses, company shuttles. dragLifts need to have an ACCESS MODE ski. Lines with ACCESS MODE bicycle will be included as well. If this flag is set, then existing restricted lines are considered by the router, irrespective of the selected passenger categories or the MotorisedMainTravelMode. The results are marked as restricted in the ServiceGroup. The usage could also be detailed with Attribute elements. Restricted trumps PassengerCategory, for example. If Restricted is set to true, all services are displayed.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isIncludeAllRestrictedLines() {
return includeAllRestrictedLines;
}
/**
* Sets the value of the includeAllRestrictedLines property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isIncludeAllRestrictedLines()
*/
public void setIncludeAllRestrictedLines(Boolean value) {
this.includeAllRestrictedLines = value;
}
/**
* Sequence of all passenger categories, for which this search shall be conducted. In rare cases additional offerings may be available (e.g., demand responsive service with certain areas being reserved for seniors). If multiple PassengerCategories are provided, then Services are shown when they are available for at least one PassengerCategory.
*
* Gets the value of the passengerCategory property.
*
* This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object.
* This is why there is not a set method for the passengerCategory property.
*
*
* For example, to add a new item, do as follows:
*
*
* getPassengerCategory().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link PassengerCategoryEnumeration }
*
*
*
* @return
* The value of the passengerCategory property.
*/
public List getPassengerCategory() {
if (passengerCategory == null) {
passengerCategory = new ArrayList<>();
}
return this.passengerCategory;
}
/**
* Defines how the router should handle requests with multiple origins and destinations. As it is important for the strategy of the distributed trip planning the MultiPointType should be set. If the type is not supported a TRIP_MULTIPOINT_TYPE_NOT_SUPPORTED warning or error must be returned. Default is anyPoint.
*
* @return
* possible object is
* {@link MultiPointTypeEnumeration }
*
*/
public MultiPointTypeEnumeration getMultiPointType() {
return multiPointType;
}
/**
* Sets the value of the multiPointType property.
*
* @param value
* allowed object is
* {@link MultiPointTypeEnumeration }
*
* @see #getMultiPointType()
*/
public void setMultiPointType(MultiPointTypeEnumeration value) {
this.multiPointType = value;
}
/**
* Whether the result should include TrackSection elements to describe the geographic route of each journey leg.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isIncludeTrackSections() {
return includeTrackSections;
}
/**
* Sets the value of the includeTrackSections property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isIncludeTrackSections()
*/
public void setIncludeTrackSections(Boolean value) {
this.includeTrackSections = value;
}
/**
* Whether the result should include the geographic projection (coordinates) of each journey leg.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isIncludeLegProjection() {
return includeLegProjection;
}
/**
* Sets the value of the includeLegProjection property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isIncludeLegProjection()
*/
public void setIncludeLegProjection(Boolean value) {
this.includeLegProjection = value;
}
/**
* Whether the result should include turn-by-turn instructions for each journey leg.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isIncludeTurnDescription() {
return includeTurnDescription;
}
/**
* Sets the value of the includeTurnDescription property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isIncludeTurnDescription()
*/
public void setIncludeTurnDescription(Boolean value) {
this.includeTurnDescription = value;
}
/**
* Whether the result should include the access features (stairs, elevator, etc.) on each path link.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isIncludeAccessFeatures() {
return includeAccessFeatures;
}
/**
* Sets the value of the includeAccessFeatures property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isIncludeAccessFeatures()
*/
public void setIncludeAccessFeatures(Boolean value) {
this.includeAccessFeatures = value;
}
/**
* Whether the result should include real time status of access features to indicate broken equipment.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isIncludeAccessFeaturesStatus() {
return includeAccessFeaturesStatus;
}
/**
* Sets the value of the includeAccessFeaturesStatus property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isIncludeAccessFeaturesStatus()
*/
public void setIncludeAccessFeaturesStatus(Boolean value) {
this.includeAccessFeaturesStatus = value;
}
/**
* Which accessibility features and other accessibility-related information to retrieve (e.g., guidance text for the visually impaired).
*
* Gets the value of the includeAccessibilityDetails property.
*
* This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object.
* This is why there is not a set method for the includeAccessibilityDetails property.
*
*
* For example, to add a new item, do as follows:
*
*
* getIncludeAccessibilityDetails().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link AccessibilityDetailsProfileEnumeration }
*
*
*
* @return
* The value of the includeAccessibilityDetails property.
*/
public List getIncludeAccessibilityDetails() {
if (includeAccessibilityDetails == null) {
includeAccessibilityDetails = new ArrayList<>();
}
return this.includeAccessibilityDetails;
}
/**
* Whether the place context is needed. If a requestor has that information already, the response can be made slimmer, when set to false. Default is true.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isIncludePlacesContext() {
return includePlacesContext;
}
/**
* Sets the value of the includePlacesContext property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isIncludePlacesContext()
*/
public void setIncludePlacesContext(Boolean value) {
this.includePlacesContext = value;
}
/**
* Whether the situation context is needed. If a requestor has that information by other means or can't process it, the response can be made slimmer, when set to false. Default is true.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isIncludeSituationsContext() {
return includeSituationsContext;
}
/**
* Sets the value of the includeSituationsContext property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isIncludeSituationsContext()
*/
public void setIncludeSituationsContext(Boolean value) {
this.includeSituationsContext = value;
}
/**
* Whether the result should include intermediate stops (between the passenger's board and alight stops).
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isIncludeIntermediateStops() {
return includeIntermediateStops;
}
/**
* Sets the value of the includeIntermediateStops property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isIncludeIntermediateStops()
*/
public void setIncludeIntermediateStops(Boolean value) {
this.includeIntermediateStops = value;
}
/**
* Whether the result should include fare information.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isIncludeFare() {
return includeFare;
}
/**
* Sets the value of the includeFare property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isIncludeFare()
*/
public void setIncludeFare(Boolean value) {
this.includeFare = value;
}
/**
* Whether the result should include operating day information - as encoded bit string and in natural language.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isIncludeOperatingDays() {
return includeOperatingDays;
}
/**
* Sets the value of the includeOperatingDays property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isIncludeOperatingDays()
*/
public void setIncludeOperatingDays(Boolean value) {
this.includeOperatingDays = value;
}
/**
* If true, then the response will contain only summaries of the found trips. Default is false.
*
* @return
* possible object is
* {@link Boolean }
*
*/
public Boolean isTripSummaryOnly() {
return tripSummaryOnly;
}
/**
* Sets the value of the tripSummaryOnly property.
*
* @param value
* allowed object is
* {@link Boolean }
*
* @see #isTripSummaryOnly()
*/
public void setTripSummaryOnly(Boolean value) {
this.tripSummaryOnly = value;
}
/**
* Parameters for fare calculation. Only used if IncludeFare is set (TripContentFilterGroup).
*
* @return
* possible object is
* {@link FareParamStructure }
*
*/
public FareParamStructure getFareParam() {
return fareParam;
}
/**
* Sets the value of the fareParam property.
*
* @param value
* allowed object is
* {@link FareParamStructure }
*
* @see #getFareParam()
*/
public void setFareParam(FareParamStructure value) {
this.fareParam = value;
}
/**
* Gets the value of the extension property.
*
* @return
* possible object is
* {@link Object }
*
*/
public Object getExtension() {
return extension;
}
/**
* Sets the value of the extension property.
*
* @param value
* allowed object is
* {@link Object }
*
*/
public void setExtension(Object value) {
this.extension = value;
}
public MultiPointTripParamStructure withModeAndModeOfOperationFilter(ModeAndModeOfOperationFilterStructure... values) {
if (values!= null) {
for (ModeAndModeOfOperationFilterStructure value: values) {
getModeAndModeOfOperationFilter().add(value);
}
}
return this;
}
public MultiPointTripParamStructure withModeAndModeOfOperationFilter(Collection values) {
if (values!= null) {
getModeAndModeOfOperationFilter().addAll(values);
}
return this;
}
public MultiPointTripParamStructure withLineFilter(LineDirectionFilterStructure value) {
setLineFilter(value);
return this;
}
public MultiPointTripParamStructure withOperatorFilter(OperatorFilterStructure value) {
setOperatorFilter(value);
return this;
}
public MultiPointTripParamStructure withVehicleFilter(VehicleFilterStructure value) {
setVehicleFilter(value);
return this;
}
public MultiPointTripParamStructure withTariffzoneFilter(TariffzoneFilterStructure value) {
setTariffzoneFilter(value);
return this;
}
public MultiPointTripParamStructure withNoSingleStep(Boolean value) {
setNoSingleStep(value);
return this;
}
public MultiPointTripParamStructure withNoStairs(Boolean value) {
setNoStairs(value);
return this;
}
public MultiPointTripParamStructure withNoEscalator(Boolean value) {
setNoEscalator(value);
return this;
}
public MultiPointTripParamStructure withNoElevator(Boolean value) {
setNoElevator(value);
return this;
}
public MultiPointTripParamStructure withNoRamp(Boolean value) {
setNoRamp(value);
return this;
}
public MultiPointTripParamStructure withNoSight(Boolean value) {
setNoSight(value);
return this;
}
public MultiPointTripParamStructure withNoTravelator(Boolean value) {
setNoTravelator(value);
return this;
}
public MultiPointTripParamStructure withLevelEntrance(Boolean value) {
setLevelEntrance(value);
return this;
}
public MultiPointTripParamStructure withLevelEntranceOrBoardingAid(Boolean value) {
setLevelEntranceOrBoardingAid(value);
return this;
}
public MultiPointTripParamStructure withBikeTransport(Boolean value) {
setBikeTransport(value);
return this;
}
public MultiPointTripParamStructure withWalkSpeed(BigInteger value) {
setWalkSpeed(value);
return this;
}
public MultiPointTripParamStructure withAdditionalTransferTime(Duration value) {
setAdditionalTransferTime(value);
return this;
}
public MultiPointTripParamStructure withHikingProfile(String value) {
setHikingProfile(value);
return this;
}
public MultiPointTripParamStructure withCyclingProfile(String value) {
setCyclingProfile(value);
return this;
}
public MultiPointTripParamStructure withNumberOfResults(BigInteger value) {
setNumberOfResults(value);
return this;
}
public MultiPointTripParamStructure withNumberOfResultsBefore(BigInteger value) {
setNumberOfResultsBefore(value);
return this;
}
public MultiPointTripParamStructure withNumberOfResultsAfter(BigInteger value) {
setNumberOfResultsAfter(value);
return this;
}
public MultiPointTripParamStructure withTimeWindow(Duration value) {
setTimeWindow(value);
return this;
}
public MultiPointTripParamStructure withUseRealtimeData(UseRealtimeDataEnumeration value) {
setUseRealtimeData(value);
return this;
}
public MultiPointTripParamStructure withImmediateTripStart(Boolean value) {
setImmediateTripStart(value);
return this;
}
public MultiPointTripParamStructure withTransferLimit(BigInteger value) {
setTransferLimit(value);
return this;
}
public MultiPointTripParamStructure withOptimisationMethod(OptimisationMethodEnumeration value) {
setOptimisationMethod(value);
return this;
}
public MultiPointTripParamStructure withConsiderElevationData(Boolean value) {
setConsiderElevationData(value);
return this;
}
public MultiPointTripParamStructure withIncludeAllRestrictedLines(Boolean value) {
setIncludeAllRestrictedLines(value);
return this;
}
public MultiPointTripParamStructure withPassengerCategory(PassengerCategoryEnumeration... values) {
if (values!= null) {
for (PassengerCategoryEnumeration value: values) {
getPassengerCategory().add(value);
}
}
return this;
}
public MultiPointTripParamStructure withPassengerCategory(Collection values) {
if (values!= null) {
getPassengerCategory().addAll(values);
}
return this;
}
public MultiPointTripParamStructure withMultiPointType(MultiPointTypeEnumeration value) {
setMultiPointType(value);
return this;
}
public MultiPointTripParamStructure withIncludeTrackSections(Boolean value) {
setIncludeTrackSections(value);
return this;
}
public MultiPointTripParamStructure withIncludeLegProjection(Boolean value) {
setIncludeLegProjection(value);
return this;
}
public MultiPointTripParamStructure withIncludeTurnDescription(Boolean value) {
setIncludeTurnDescription(value);
return this;
}
public MultiPointTripParamStructure withIncludeAccessFeatures(Boolean value) {
setIncludeAccessFeatures(value);
return this;
}
public MultiPointTripParamStructure withIncludeAccessFeaturesStatus(Boolean value) {
setIncludeAccessFeaturesStatus(value);
return this;
}
public MultiPointTripParamStructure withIncludeAccessibilityDetails(AccessibilityDetailsProfileEnumeration... values) {
if (values!= null) {
for (AccessibilityDetailsProfileEnumeration value: values) {
getIncludeAccessibilityDetails().add(value);
}
}
return this;
}
public MultiPointTripParamStructure withIncludeAccessibilityDetails(Collection values) {
if (values!= null) {
getIncludeAccessibilityDetails().addAll(values);
}
return this;
}
public MultiPointTripParamStructure withIncludePlacesContext(Boolean value) {
setIncludePlacesContext(value);
return this;
}
public MultiPointTripParamStructure withIncludeSituationsContext(Boolean value) {
setIncludeSituationsContext(value);
return this;
}
public MultiPointTripParamStructure withIncludeIntermediateStops(Boolean value) {
setIncludeIntermediateStops(value);
return this;
}
public MultiPointTripParamStructure withIncludeFare(Boolean value) {
setIncludeFare(value);
return this;
}
public MultiPointTripParamStructure withIncludeOperatingDays(Boolean value) {
setIncludeOperatingDays(value);
return this;
}
public MultiPointTripParamStructure withTripSummaryOnly(Boolean value) {
setTripSummaryOnly(value);
return this;
}
public MultiPointTripParamStructure withFareParam(FareParamStructure value) {
setFareParam(value);
return this;
}
public MultiPointTripParamStructure withExtension(Object value) {
setExtension(value);
return this;
}
/**
* Generates a String representation of the contents of this type.
* This is an extension method, produced by the 'ts' xjc plugin
*
*/
@Override
public String toString() {
return ToStringBuilder.reflectionToString(this, OmitNullsToStringStyle.INSTANCE);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy