Complex type

EstimatedVehicleJourneyStructure

Defined in SIRI/xsd/siri_model/siri_estimatedVehicleJourney.xsd:306

Type for Real-time info about a VEHICLE JOURNEY.

Used by elements

EstimatedVehicleJourney

Content model

Type structure

16 top-level

RecordedAtTime 0..1 xsd:dateTime

Time at which data of individual journey was recorded if differet from that of frame. ((since SIRI 2.0).)
groupLineIdentityGroup 1..1

Elements for identifying a LINE and DIRECTION.
- LineRef 1..1 LineRefStructure
  
  Reference to a LINE.
- DirectionRef 1..1 DirectionRefStructure
  
  Reference to a LINE DIRECTION DIRECTION, typically outward or return.
groupEstimatedTimetableAlterationGroup 1..1

Gives the DATED VEHICLE JOURNEY which the vehicle is running and if the journey is an alteration to the timetable indicates the original journey and the nature of the difference.
- choice 1..1
  - choice 1..1
    - FramedVehicleJourneyRef 1..1 FramedVehicleJourneyRefStructure
      
      Identifer of a VEHICLE JOURNEY within data Horizon of a service.
    - DatedVehicleJourneyRef 1..1 DatedVehicleJourneyRefStructure
      
      Reference to a dated VEHICLE JOURNEY. This will be 'framed' i.e. be with the data context of the ESTIMATED Timetable.
  - DatedVehicleJourneyIndirectRef 0..1 DatedVehicleJourneyIndirectRefStructure
    
    Additionally, identify the VEHICLE JOURNEY by origin and destination and the scheduled times at these stops.
  - EstimatedVehicleJourneyCode 1..1 EstimatedVehicleJourneyCodeType
    
    If this is the first message for an unplanned 'extra' VEHICLE JOURNEY, a new and unique code must be given for it. ExtraJourney should be set to 'true'.
- choice 1..1
  - ExtraJourney 0..1 xsd:booleandefault false
    
    Whether this VEHICLE JOURNEY is an addition to the planning data already sent. Default is 'false': i.e. not an additional journey.
  - Cancellation 0..1 xsd:booleandefault false
    
    Whether this VEHICLE JOURNEY is a deletion of a previous scheduled journey. Default is 'false': this is not a VEHICLE JOURNEY that has been cancelled. An Extra Journey may be deleted.
groupJourneyPatternInfoGroup 0..1

Elements describing the LINE, ROUTE and DIRECTION of a VEHICLE JOURNEYwhich are derived from the JOURNEY PATTERN associated with the journey. Values for these elements can be specified on an annual schedule and will be inherited, unless overriden, onto the production timetable and then onto the individul dated VEHICLE JOURNEYs of the timetable. Each monitored journey takes its values from the dated VEHICLE JOURNEY that it follows. The absence of a value on an entity at a given level indicates that the value should be inherited (i) from any recent preceding update message for the same entity, or if there is no previous override, (ii) from its immediate parent entity.
- JourneyPatternRef 0..1 JourneyPatternRefStructure
  
  Identifier of JOURNEY PATTERN that journey follows.
- JourneyPatternName 0..1 NaturalLanguageStringStructure
  
  Name of Joruney Pattern
- VehicleMode 0..unbounded VehicleModesOfTransportEnumeration
  
  A means of transportation such as bus, rail, etc.
- RouteRef 0..1 RouteRefStructure
  
  Identifier of ROUTE that journey follows.
- PublishedLineName 0..unbounded NaturalLanguageStringStructure
  
  Name or Number by which the LINE is known to the public. (Unbounded since SIRI 2.0)
- GroupOfLinesRef 0..1 GroupOfLinesRefStructure
  
  Reference to a GROUP OF LINEs to which journey belongs. SIRI 2.0
- DirectionName 0..unbounded NaturalLanguageStringStructure
  
  Description of the DIRECTION. May correspond to a DESTINATION DISPLAY. (Unbounded since SIRI 2.0)
- ExternalLineRef 0..1 LineRefStructure
  
  Alternative identifier of LINE that an external system may associate with journey.
- choice 1..1
  - BrandingRef 0..1 BrandingRefStructure
    
    Reference to a BRANDING. (since SIRI 2.1)
  - Branding 0..1 BrandingStructure
    
    An arbitrary marketing classification. (since SIRI 2.1)
groupJourneyEndNamesGroup 1..1

End names for journey.
- OriginRef 0..1 JourneyPlaceRefStructure
  
  Reference to the origin SCHEDULED STOP POINT of the journey.
- OriginName 0..unbounded NaturalLanguageStringStructure
  
  Name of the origin of the journey. (Unbounded since SIRI 2.0)
- OriginShortName 0..unbounded NaturalLanguageStringStructure
  
  Short name of the origin of the journey; used to help identify the VEHICLE JOURNEY on arrival boards. If absent, same as Origin Name.
- DestinationDisplayAtOrigin 0..unbounded NaturalLanguageStringStructure
  
  DIRECTION name shown for jurney at the origin. (since SIRI 2.0)
- Via 0..unbounded ViaNameStructure
  
  Names of VIA points, used to help identify the LINE, for example, Luton to Luton via Sutton. Currently 3 in VDV. Should only be included if the detail level was requested.
- DestinationRef 0..1 DestinationRefStructure
  
  Reference to a DESTINATION.
- DestinationName 0..unbounded NaturalLanguageStringStructure
  
  Description of the destination stop (vehicle signage), Can be overwritten for a journey, and then also section by section by the entry in an individual CALl. (Unbounded since SIRI 2.0)
- DestinationShortName 0..unbounded NaturalLanguageStringStructure
  
  Short name of the DESTINATION.of the journey; used to help identify the VEHICLE JOURNEY on arrival boards. If absent, same as DestinationName. (Unbounded since SIRI 2.0)
- OriginDisplayAtDestination 0..unbounded NaturalLanguageStringStructure
  
  Origin name shown for jourey at the destination (since SIRI 2.0)
groupServiceInfoGroup 0..1

Elements classifying the Service or journey. Values for these elements can be specified on a timetabled schedule and will be inherited, unless overriden, onto the production timetable and then onto the individul dated VEHICLE JOURNEYs of the timetable. Each monitored journey takes its values from the dated VEHICLE JOURNEY that it follows. The absence of a value on an entity at a given level indicates that the value should be inherited (i) from any recent preceding update message for the same entity, or if there is no previous override, (ii) from its immediate parent entity.
- groupBasicServiceInfoGroup 1..1
  
  Information that classifies journey.
  - OperatorRef 0..1 OperatorRefStructure
    
    OPERATOR of a VEHICLE JOURNEY. Note that the operator may change over the course of a journey. This shoudl show teh operator for the curent point in the journey. Use Journey Parts tp record all the operators in the whole journeyh.
  - ProductCategoryRef 0..1 ProductCategoryRefStructure
    
    Product Classification of VEHICLE JOURNEY- subdivides a transport mode. e.g. express, loacl.
  - ServiceFeatureRef 0..unbounded ServiceFeatureRefStructure
    
    Classification of service into arbitrary Service categories, e.g. school bus. Recommended SIRI values based on TPEG are given in SIRI documentation and enumerated in the siri_facilities package. Corresponds to NeTEX TYPE OF SERVICe.
- VehicleFeatureRef 0..unbounded VehicleFeatureRefStructure
  
  Features of VEHICLE providing journey. Recommended SIRI values based on TPEG are given in SIRI documentation and enumerated in the siri_facilities package.
groupJourneyInfoGroup 0..1

Elements describing a VEHICLE JOURNEY. Values for these elements can be specified on an annual schedule and will be inherited, unless overriden, onto the production timetable and then onto the individul DATED VEHICLE JOURNEYs of the timetable. Each real-time journey (e.g. ESTIMATED VEHICLE JOURNEY or MONITORED VEHICLE JORUNEY) takes its values from the DATED VEHICLE JOURNEY that it follows. The absence of a value on an entity at a given level indicates that the value should be inherited (i) from any recent preceding update message for the same entity, or if there is no previous override, (ii) from its immediate parent entity.
- VehicleJourneyName 0..unbounded NaturalLanguageStringStructure
  
  For train services with named journeys. Train name, e.g. “West Coast Express”. If omitted: No train name. Inherited property. (Unbounded since SIRI 2.0)
- JourneyNote 0..unbounded NaturalLanguageStringStructure
  
  Additional descriptive text associated with journey. Inherited property.
- PublicContact 0..1 SimpleContactStructure
  
  Contact details for use by members of public. (since SIRI 2.0)
- OperationsContact 0..1 SimpleContactStructure
  
  Contact details for use by operational staff. (since SIRI 2.0)
- IsDeadRun 0..1 xsd:boolean
  
  Allows to flag if the VehicleJourney is a dead run. It helps notify to passenger information systems, especially if they do not leverage dead runs and/or have a different process for them. +v2.3
groupJourneyEndTimesGroup 0..1

Call times for journey.
- HeadwayService 0..1 xsd:booleandefault false
  
  Whether this is a Headway Service, that is shown as operating at a prescribed interval rather than to a fixed timetable. Default is 'false'.
- OriginAimedDepartureTime 0..1 xsd:dateTime
  
  Timetabled departure time from Origin.
- DestinationAimedArrivalTime 0..1 xsd:dateTime
  
  Timetabled arrival time at Destination.
- FirstOrLastJourney 0..1 FirstOrLastJourneyEnumerationdefault unspecified
  
  Whether journey is first or last journey of day. (since SIRI 2.0)
groupDisruptionGroup 1..1

Elements describing nature of disruption.
- FormationCondition 0..unbounded FormationConditionStructure
  
  Information about a change of the formation (e.g. TRAIN composition) or changes of vehicles within the formation. (since SIRI 2.1)
- FacilityConditionElement 0..unbounded FacilityConditionStructure
  
  Information about a change of Equipment availability at stop or on vehicle that may affect access or use.
- sequence 1..1
  
  This sequence is here only for compatibility reasons between Siri 1.0 and Siri 1.1
  - FacilityChangeElement 0..1 FacilityChangeStructure
    
    A change to the availaibility of EQUIPMENT. Basic structure defined in the first 1.0 SIRI XSd.
  - SituationRef 0..unbounded SituationRefStructure
    
    Reference to a SITUATION associated with the element.
- ControlActionRef 0..1 ControlActionRefStructure
  
  Reference to a ControlAction having possible consequences on the EstimatedVehicleJourney. Note that if the ControlAction is the master ControlAction of a GroupOfControlActions it is assumed that the refence is valid for all the ControlActions of the group.
groupJourneyProgressGroup 0..1

Elements describing the real-time progress of a monitored VEHICLE JOURNEY.
- Monitored 0..1 xsd:booleandefault true
  
  Whether there is real-time information available for journey. Default is 'true'. It is recommended to specify a MonitoringError if Monitored is set to 'false'.
- MonitoringError 0..1 xsd:NMTOKENS
  
  If Monitored is 'false', a (list of) reason(s) for non-availability of real-time data. Examples are "GPS", "GPRS", "Radio" etc. MonitoringError must not be used if Monitored is omitted or set to 'true'.
- groupProgressDataQualityGroup 1..1
  
  Elements describing the qua;ity of real-time progress data of a journey.
  - InCongestion 0..1 xsd:boolean
    
    Whether the VEHICLE iis in traffic congestion. If not, present, not known.
  - InPanic 0..1 xsd:booleandefault false
    
    Whether the panic alarm on the VEHICLE is activated. This may lead to indeterminate predictions. If absent, default is 'false'.
  - PredictionInaccurate 0..1 xsd:booleandefault false
    
    Whether the prediction for a specific stop or the whole journey is considered to be of a useful accuracy or not. Default is 'false', i.e. prediction is considered to be accurate. If prediction is degraded, e.g. because of a situation, PredictionInaccurate is used to indicate a lowered quality of data. Inherited property. PredictionInaccurate can be used in combination with InCongestion, but is more general.
  - PredictionInaccurateReason 0..1 PredictionInaccurateReasonEnumeration
    
    Can be used to inform the passenger about the reason for a change of the prediction (in)accuracy in case PredictionInaccurate is set to 'true'. (since SIRI 2.1)
  - DataSource 0..1 xsd:string
    
    System originating real-time data. Can be used to make judgements of relative quality and accuracy compared to other feeds.
  - ConfidenceLevel 0..1 QualityIndexEnumerationdefault reliable
    
    Confidence QUALITY LEVEL of data. Default is 'reliable'.
- groupProgressDataGroup 1..1
  
  Elements describing the real-time progress of a journey.
  - VehicleLocation 0..1 LocationStructure
    
    Current geospatial location of VEHICLE. Measured to front of vehicle.
  - LocationRecordedAtTime 0..1 xsd:dateTime
    
    Time at which location was recorded. If not present assume that the recorded at time on the containing delivery.
  - Bearing 0..1 AbsoluteBearingType
    
    Bearing in compass degrees in which VEHICLE is heading.
  - ProgressRate 0..1 ProgressRateEnumeration
    
    Rate of progress of VEHICLE. Default is 'normal'
  - Velocity 0..1 VelocityType
    
    Velocity of VEHICLE. Either actual speed or average speed may be used. (since SIRI 2.0)
  - EngineOn 0..1 xsd:booleandefault true
    
    Whether the engine of the vehicle is on. Default is 'true' (since SIRI 2.0)
  - Occupancy 0..1 OccupancyEnumeration
    
    An approximate figure of how occupied the journey is after departing from a given stop, e.g. 'manySeatsAvailable' or 'standingRoomOnly'. If omitted: Passenger load is unknown. Occupancies and capacities for individual VEHICLEs, e.g. parts of a COMPOUND TRAIN, can also be specified in more detail for the departure on CALL level.
  - Delay 0..1 DurationType
    
    Delay of VEHICLE against schedule, to a precision in seconds. Early times are shown as negative values.
  - ProgressStatus 0..unbounded NaturalLanguageStringStructure
    
    An arbitrary textual status description of the running of this VEHICLE JOURNEY. (Unbounded 0:* since SIRI 2.0)
  - VehicleStatus 0..1 VehicleStatusEnumeration
    
    An classification of the progress state of running of this VEHICLE JOURNEY. (since SIRI 2.0)
groupTrainOperationalInfoGroup 1..1

Operational information about the monitored VEHICLE JOURNEY.
- TrainBlockPart 0..unbounded TrainBlockPartStructure
  
  If a VEHICLE JOURNEY is a coupled journey, i.e. comprises several coupled BLOCKparts, there will be a separate delivery for each BLOCKp art and this element will indicate the vehicles that the journey part uses.
- groupOperationalInfoGroup 1..1
  
  Operational information about the monitored VEHICLE JOURNEY.
  - groupOperationalBlockGroup 1..1
    
    Operational information about the monitored VEHICLE JOURNEY.
    - BlockRef 0..1 BlockRefStructure
      
      BLOCK that VEHICLE is running.
    - CourseOfJourneyRef 0..1 CourseOfJourneyRefStructure
      
      COURSE OF JOURNEY ('Run') that VEHICLE is running.
  - VehicleJourneyRef 0..1 VehicleJourneyRefStructure
    
    Reference to a VEHICLE JOURNEY.
  - VehicleRef 0..1 VehicleRefStructure
    
    Reference to a VEHICLE.
  - AdditionalVehicleJourneyRef 0..unbounded FramedVehicleJourneyRefStructure
    
    Refercence to other VEHICLE Journeys ((since SIRI 2.0))
  - DriverRef 0..1 xsd:normalizedString
    
    A reference to the DRIVER or Crew currently logged in to operate a monitored VEHICLE. May be omitted if real-time data is not available - i.e. it is timetabled data. (since SIRI 2.0)
  - DriverName 0..1 xsd:normalizedString
    
    The name oo the Driver or Crew (since SIRI 2.0)
- TrainNumbers 0..1
  
  TRAIN NUMBERs for journey. (since SIRI 2.0)
  - TrainNumberRef 1..unbounded TrainNumberRefStructure
    
    TRAIN NUMBER assigned to VEHICLE JOURNEY. +SIRI 2.0
- JourneyParts 0..1
  
  JOURNEY PARTs making up JOURNEY +SIRIv2.0 e.
  - JourneyPartInfo 1..unbounded JourneyPartInfoStructure
    
    Information about Parts of JOURNEY (since SIRI 2.0)
- groupJourneyFormationGroup 1..1
  
  Groups relevant elements of the formation model that are used on JOURNEY level. The TRAIN conceptual model represents VEHICLE TYPE properties that are peculiar to TRAINs. A TRAIN may comprise not just a single VEHICLE but a chain of carriages, TRAIN ELEMENTS, assembled as TRAIN COMPONENTs. Groups of carriages may be managed as sections by composing TRAINs into a COMPOUND TRAIN made up of multiple TRAIN IN COMPOUND TRAIN, for example in a train that joins or splits. (since SIRI 2.1)
  - TrainElements 0..1
    - choice 1..unbounded
      - TrainElementRef 1..1 TrainElementRefStructure
        
        Reference to a TRAIN ELEMENT. (since SIRI 2.1)
      - TrainElement 1..1 TrainElementStructure
        
        An elementary component of a TRAIN, e.g. wagon or locomotive. (since SIRI 2.1)
  - Trains 0..1
    - choice 1..unbounded
      - TrainRef 1..1
      - Train 1..1 TrainStructure
        
        A vehicle composed of TRAIN ELEMENTs assembled in a certain order (so called TRAIN COMPONENTs), i.e. wagons assembled together and propelled by a locomotive or one of the wagons. (since SIRI 2.1)
  - CompoundTrains 0..1
    - choice 1..unbounded
      - CompoundTrainRef 1..1
      - CompoundTrain 1..1 CompoundTrainStructure
        
        Groups of carriages may be managed as sections by composing TRAINs into a COMPOUND TRAIN, for example if a TRAIN joins (or splits from) another TRAIN. (since SIRI 2.1) TRAINs within a COMPOUND TRAIN may have different origins and destinations due to joining/splitting. A COMPOUND TRAIN may be stable for one or multiple JOURNEY PARTs and change at a certain STOP POINT due to planned joining/splitting, despatching alterations or a situation.
RecordedCalls 0..1

Complete sequence of stops already visited along the route path, in calling order. Only used if observed stop data is being recorded. (SIRI 2.0)
- RecordedCall 1..unbounded RecordedCallStructure
  
  Ordered sequence of SCHEDULED STOP POINTs called at by the VEHICLE JOURNEY. Only used if observed stop data is being recorded. (SIRI 2.0)
EstimatedCalls 0..1

Complete sequence of stops along the route path, in calling order. Normally this is only the onwards stops from the vehicle's current position.
- EstimatedCall 1..unbounded EstimatedCallStructure
  
  Ordered sequence of SCHEDULED STOP POINTs called at by the VEHICLE JOURNEY. If IsCompleteStopSequence is false, may be just those stops that are altered.
IsCompleteStopSequence 0..1 xsd:booleandefault false

Whether the above call sequence is complete, i.e. represents every CALL of the SERVICE PATTERN and so can be used to replace a previous call sequence. Default is 'false'.
JourneyRelations 0..1 JourneyRelationsStructure

Relations of the journey with other journeys, e.g., in case a joining/splitting takes place or the journey substitutes for another one etc.
Extensions 0..1 ExtensionsStructure

Extensions to schema. (Wrapper tag used to avoid problems with handling of optional 'any' by some validators).