SIRI Functional Services - UML Diagrams . Kizoom Limited, 109-123 Clifton Street, London EC2A 4LD. Tel: +44 207 749 2670 SIRI Functional Service Diagrams Version 0.6 2007/05/22 Njsk Kizoom PRELIMANRY DRAFT © Kizoom 2006- 2007 Page 1 SIRI Functional Services - UML Diagrams Control sheet Version control Date Author Version Description of changes 2006/03/02 Nick Knowles, V.01 Previous Draft 2007/04/15 Nick Knowles, V.02 Word Draft Document automation & Copyright notice Kizoom Ltd 107-109 Clifton Street, London EC2A 4LD Telephone: 207 749 2670 ©2007 Kizoom Limited: . Company Registration Number : 3745127 Company VAT Number : 735 9033 27 EU VAT Number : GB 735 9033 27 Author: Nicholas Knowles 1 1.1 2 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 2.9 3 3.1 3.2 3.3 4 4.1 Introduction ............................................................................................................ 5 Acknowledgements .......................................................................................... 5 Notation.................................................................................................................. 6 Relationships .................................................................................................... 6 Composition ...................................................................................................... 6 Serialisation: Containment & Reference ....................................................... 6 Use of Colour .................................................................................................... 7 Order of Attributes .......................................................................................... 7 Direction of Reading ........................................................................................ 7 Simple Data Types ........................................................................................... 7 Reusable Complex Data Types ....................................................................... 7 Enumerations ................................................................................................... 7 Use of SIRI Services .............................................................................................. 8 Request/Response ............................................................................................. 8 Publish/Subscribe............................................................................................. 8 Publish/Subscribe with Fetched Delivery ...................................................... 9 SIRI ProductionTimetable (PT)........................................................................... 10 Subscription & Request................................................................................. 10 4.1.1 ProductionTimetableRequest Summary .............................................. 10 4.1.2 ProductionTimetableRequest Detail .................................................... 11 4.2 Delivery ........................................................................................................... 12 4.2.1 ProductionTimetableDelivery Summary ............................................. 12 4.2.2 ProductionTimetableDelivery Detail ................................................... 13 5 SIRI EstimatedTimetable (ET) ............................................................................. 14 5.1 Subscription & Request................................................................................. 14 5.1.1 EstimatedTimetableRequest Summary ................................................ 14 © Kizoom 2006- 2007 Page 2 SIRI Functional Services - UML Diagrams 5.1.2 EstimatedTimetableRequest Detail ...................................................... 15 5.2 Delivery ........................................................................................................... 16 5.2.1 EstimatedTimetableDelivery Summary ............................................... 16 5.2.2 EstimatedTimetableDelivery Detail ..................................................... 17 6 SIRI StopTimetable (ST) ...................................................................................... 18 6.1 Subscription & Request................................................................................. 18 6.1.1 StopTimetableRequest Summary ......................................................... 18 6.1.2 StopTimetableRequest Detail ............................................................... 19 6.2 Delivery ........................................................................................................... 20 6.2.1 StopTimetableDelivery Summary ........................................................ 20 6.2.2 StopTimetableDelivery Detail .............................................................. 21 7 SIRI StopMonitoring (SM) .................................................................................. 22 7.1 Subscription & Request................................................................................. 22 7.1.1 StopMonitoringRequest Summary ....................................................... 22 7.1.2 StopMonitoringRequesty Detail ........................................................... 23 7.2 Delivery ........................................................................................................... 24 7.2.1 StopMonitoringDelivery Summary ...................................................... 24 7.2.2 StopMonitoringDelivery Detail ............................................................ 25 7.2.3 MonitoredVehicleJourney.................................................................... 26 8 SIRI VehicleMonitoring (VM) ............................................................................ 28 8.1 Subscription & Request................................................................................. 28 8.1.1 VehicleMonitoringRequest Summary .................................................. 28 8.1.2 VehicleMonitoringRequest Detail ........................................................ 29 8.2 Delivery ........................................................................................................... 30 8.2.1 VehicleMonitoringDelivery Summary ................................................. 30 8.2.2 VehicleMonitoringDelivery Detail ....................................................... 31 9 SIRI ConnectionTimetable (CT) .......................................................................... 32 9.1 Subscription & Request................................................................................. 32 9.1.1 ConnectionTimetableRequest Summary .............................................. 32 9.1.2 ConnectionTimetableRequest Detail .................................................... 33 9.2 Delivery ........................................................................................................... 34 9.2.1 ConnectionTimetableDelivery Summary ............................................. 34 9.2.2 ConnectionTimetableDelivery Detail................................................... 35 10 SIRI ConnectionMonitoring (CM) ................................................................... 36 10.1 Subscription & Request................................................................................. 36 10.1.1 ConnectionMonitoringRequest Summary............................................ 36 10.1.2 ConnectionMonitoringRequest Detail ................................................. 37 10.2 Delivery ........................................................................................................... 38 10.2.1 ConnectionMonitoringDelivery Summary........................................... 38 10.2.2 ConnectionMonitoringDelivery Detail ................................................ 39 11 SIRI GeneralMessage (GM) ............................................................................ 40 11.1 Subscription & Request................................................................................. 40 11.1.1 GeneralMessageRequest Summary ..................................................... 40 11.1.2 GeneralMessageRequest Detail ........................................................... 41 11.2 Delivery ........................................................................................................... 42 11.2.1 GeneralMessageDelivery Summary .................................................... 42 11.2.2 GeneralMessageDelivery Detail .......................................................... 43 12 SIRI FacilityMonitoring (FM) ......................................................................... 44 12.1 Subscription & Request................................................................................. 44 12.1.1 FacilityMonitoringRequest Summary.................................................. 44 © Kizoom 2006- 2007 Page 3 SIRI Functional Services - UML Diagrams 12.1.2 FacilityMonitoringRequest Detail ....................................................... 44 12.2 Delivery ........................................................................................................... 44 12.2.1 FacilityMonitoringDelviery Summary................................................. 44 12.2.2 FacilityMonitoringDelviery Detail ...................................................... 44 13 SIRI SituationExchange (SX) ........................................................................... 45 13.1 Subscription & Request................................................................................. 45 13.1.1 SituationExchangeRequest Summary .................................................. 45 13.1.2 SituationExchangeRequest Detail ........................................................ 46 13.2 Delivery ........................................................................................................... 47 13.2.1 SituationExchangeDelviery Summary ................................................. 47 13.2.2 SituationExchangeDelviery Detail ....................................................... 47 13.2.3 Situation Model.................................................................................... 48 14 SIRI Common Data Types ............................................................................... 53 14.1 Common SIRI Data Types – Codes & Identifiers....................................... 54 14.2 Common SIRI Data Types ............................................................................ 55 14.3 Common General SIRI Enumerations ........................................................ 56 14.4 SIRI-SX Enumerations .................................................................................. 56 14.5 IFOPT Enumerations .................................................................................... 57 14.6 TPEG Miscellaneous Enumerations ............................................................ 58 14.7 TPEG Mode Enumerations ........................................................................... 59 © Kizoom 2006- 2007 Page 4 SIRI Functional Services - UML Diagrams 1 Introduction This paper lists the Subscription, Request & delivery elements of the SIRI Functional Services as UML Class diagrams. It is intended to provide a concise overview of the SIRI Functional Services. For each SIRI Functional service we show: 1. A simplified summary of the Subscription & Request elements (Both are shown on the same diagram, since a Subscription embeds a request). 2. A more detailed view of the Subscription & Request elements, including data types and abstract supertypes. 3. A simplified summary of the Delivery elements. 4. A more detailed view of the Delivery elements, including data types and abstract supertypes. For certain Services (SIRI-SM, SIRI-VM and SIRI-SX) we provide additional summary diagrams of the model elements contained within the delivery. Note that to allow for compatibility with VDV for some services the XML schema supports two representations – a nested one and a “flattened” one the diagrams show only the nested representation. 1.1 Acknowledgements The diagrams have been prepared & provided by Kizoom. © Kizoom 2006- 2007 Page 5 SIRI Functional Services - UML Diagrams 2 Notation 2.1 Relationships The standard UML relationships are used, in line with standard UML notation. 1. Inheritance: white arrow. 2. Association: other lines. o Aggregation is indicated by a black diamond: this typically corresponds to direct containment in an XML document o Cardinalities are marked using UML conventions for multiplicities and optionality, i.e. min:max, fro example [ 0:1]. [1] by itself means [1:1]. [*] by itself means [0:*]. The multiplicities indicate if there are one or many. The optionality indicates whether the end must be populated if the relationship is present. o Direction of Navigability is indicated by an line arrow head. 3. Dependency: Dotted Line 2.2 Composition SIRI makes greater use of composition than of inheritance, assembling standard data structures (encoded as groups in XML) into concrete classes. Use of composition is indicated by: o An aggregation association to the composite child with a multiplicity of [0:1]. Or [1]. o A named attribute of the class with the name and type of the composite child. o Concrete model classes are shaded dark yellow Composites are shaded light yellow For example. ‘ServiceInfo[0:1]. ServiceInfo’, Many SIRI Composite names end in ‘Info’. Showing an explicit attribute in the parent for a child component is not strictly needed to depict a pure object model (it could be represented just by an association to the contained element), but helps to make clear the order in which attributes appear in the XML. 2.3 Serialisation: Containment & Reference The primary expression of SIRI is as an XML schema, for which object references must be serialised either through containment (i.e. embedding a child relationship within a parent element’s tags) or reference (i.e. serialising an association by including a reference to the identifier of the associated entity. It is therefore useful to adopt conventions that indicate whether a particular relationship is expressed in the SIRI XML schema by containment or by reference. Containment is indicated by: o A named attribute of the class with the type of the composite child, and an appropriate multiplicity: normally [0:*], or [1:*] but sometimes [0:1]. Or [1:1] o An aggregation association to the composite child with a multiplicity of [0:*]. Or [1:*]. © Kizoom 2006- 2007 Page 6 SIRI Functional Services - UML Diagrams o An association name that is a plural noun, for example requests Reference is indicated by:an attribute name that ends in ‘Ref’. And a data type name that ends in ‘Code’ or ‘Id’. For example LineRef, VehicleJourneyRef Showing an explicit attribute in the parent for a contained child is not strictly needed to depict a pure object model (it could be represented just by an association to the contained element)l, but helps to make clear the order in which attributes appear in the XML. 2.4 Use of Colour To facilitate reading, Classes are coloured to indicate their nature. This is purely a local convention (not part of UML) used as follows Purple: Common Abstract Transport Framework elements, Typically these are request & response headers. E.g. ServiceDelivery Salmon: Common Abstract Transport Framework elements, Typically these are supertypes. E.g. AbstractItem Orange: Functional Service Elements. E.g. StopMonitoringDelivery Yellow: Domain model elements that correspond to the main payload contnet of deliveries: typically these are views of TransModel entities. Dark yellow indicates the concrete container class, e.g. MonitoredVehicleJourney. Light Yellow indicates an embedded element that make up part of a concrete composite (And may correspond to a TransModel Entity). White: References to the identifiers domain model entities, corresponding to the TransModel concepts. 2.5 Order of Attributes Attributes appear within classes within the same order as in the XML. 2.6 Direction of Reading Where possible a convention is followed to places parent elements above and child elements below, or to the right. 2.7 Simple Data Types Simple types are shown.in an separate chapter at the end . Most ‘Code’ types are of type string or NMTOKEN. 2.8 Reusable Complex Data Types A small number of basic complex type: Location, FacilityChange, HalfOpenDate FramedVehicleJourneyRef are used extensively and are not repeated on individual pages. They are shown on a separate page 2.9 Enumerations Enumerations are generally shown in context if space permits, using a dependency relationship (dotted line). They are also summarised on separate diagrams at the end © Kizoom 2006- 2007 Page 7 SIRI Functional Services - UML Diagrams 3 Use of SIRI Services All the SIRI Functional services follow a common design pattern. Payload content is separated from message management content. Content may be obtained either by an immediate direct request /response interaction, or by a publish / subscribe interaction. In both cases the same set of request parameters are supported; for a subscription the request is wrapped in an additional subscription element. The server which provides the data is the Producer. The server which obtains the data is the Consumer. Both Participants have a unique identifier and . 3.1 Request/Response For the Request / Response interaction, the Consumer makes a Request to the Producer, and receives a Delivery message in response. The Request may state the filtering criteria as Topics (the desired domain element references) and Policies (how the results are to be filtered. The Topics and Policies depend on the specific functional service. Requestor Responder Request Response Request / Response Figure 3-1 Sequence Diagram of Request Response Interaction 3.2 Publish/Subscribe For the Publish / Subscribe interaction the Consumer makes a Subscription Request to the Producer, which creates a subscription for the Consumer for a specified Request and Subscription Policy and lease period. The Producer will subsequently send one or more asynchronous Delivery messages if the Request criteria are met and continue doing so in accordance with the Subscription Policy, up to the end f the lease. © Kizoom 2006- 2007 Page 8 SIRI Functional Services - UML Diagrams Subscriber NotificationProducer NotificationConsumer SubscriptionRequest (ServiceType, Subscription) SubscriptionResponse Subscription Manager register Notify / Deliver 1 TerminationRequest Notify / Deliver 2 TerminationResponse Notify / Deliver etc terminate Publish / Subscribe Figure 3-2 Sequence Diagram of Publish Subscribe Interaction 3.3 Publish/Subscribe with Fetched Delivery To provide compatibility with legacy systems, SIRI supports an additional variant of delivery in which data is returned in two steps: first a notification message from Producer to Consumer that data is available, then a request/ Response interaction to from Consumer to Producer to fetch the data. Subscriber NotificationProducer NotificationConsumer SubscriptionRequest(XxxSubscription) SubscriptionResponse DataReadyNotification DataReadyResponse DataSupplyRequest Subscription Manager DataSupplyDelivery TerminationRequest terminate TerminationResponse Publish / Subscribe With Fetched Delivery Figure 3-3 Sequence Diagram of Publish Subscribe Interaction with Fetched Delivery © Kizoom 2006- 2007 Page 9 SIRI Functional Services - UML Diagrams 4 SIRI ProductionTimetable (PT) The SIRI Production Timetable Service transmits daily timetables that include any planned updates that are known about at the time of transmission. The service is used typically to communicate between Scheduling systems and AVMS systems, and also between AVMS systems and intelligent clients of the AVMS system. The timetables exchanged should cover all lines covered by the AVMS system. The SIRI Production Timetable Service is also used to transmit the planned interchanges between journeys, including information about the linking of vehicle parts through the interchange, such as whether passengers are able to remain seated in the vehicle. The Request Topics allow a Consumer system to specify that only timetables for a specific timetable version. Operator, line, or direction are to be returned. 4.1 Subscription & Request 4.1.1 ProductionTimetableRequest Summary Participant 1 participant subscriptions 1 SubscriptionRequest 1 1 SIRI-PT Summary ProductionTimetableSubscription & ProductionTimetableRequest © 2007 SIRI * policies ProductionTimetableSubscriptionRequest ProductionTimetableRequest[1] ProductionTimetableSubscriptionPolicies[0..1] Extensions[0..1] participant 1 0..1 1 request requests ServiceRequest 1 1 0..* ProductionTimetableSubscriptionPolicies 1 ProductionTimetableRequest ProductionTimetableTopics[0..1] ProductionTimetablePolicies[0..1] Extensions[0..1] topics policies ProductionTimetablePolicies 1 0..1 TimetableVersion version 1 operator 1 ValidityPeriod[0..1] TimetableVersionRef[0..1] OperatorRef[0..1] LineRef[0..1] DirectionRef[0..1] 1 Operator 0..1 Line Language[1] IncrementalUpdates[1] ProductionTimetableTopics 0..1 0..1 0..1 1 line 1 direction period 1 0..1 ValidityPeriod StartTime[1] EndTime[1] 0..1 Direction Figure 4-1 ProductionTimeTableRequest - Summary © Kizoom 2006- 2007 Page 10 SIRI Functional Services - UML Diagrams 4.1.2 ProductionTimetableRequest Detail Participant SIRI-PT ProductionTimetableSubscription & ProductionTimetableRequest 1 1 1 SubscriptionRequest RequestTimestamp[1] : dateTime Address[0..1] : anyURI RequestorRef[1] : ParticipantCode MessageIdentifer[0..1] : string ConsumerAddress[0..1] : anyURI SubscriptionFilterIdentifier[1] : NMTOKEN SubscriptionContext[0..1] participant © 2007 SIRI AbstractSubscriptionRequest subscriptions SubscriberRef[1] : ParticipantCode SubscriptionIdentifier[1] InitialTerminationTime[1] 1 * 1 0..1 ProductionTimetableSubscriptionRequest SubscriptionContext ProductionTimetableRequest[1] : ProductionTimetableRequest ProductionTimetableSubscriptionPolicies[0..1] : ProductionTimetableSubscriptionPolicies Extensions[0..1] : any HeartbeatInterval[0..1] : duration 1 1 1 ServiceRequest RequestContext[1] : RequestContext RequestTimestamp[1] : dateTime Address[1] : anyURI RequestorRef[1] : ParticipantCode MessageIdentifer[1] : string policies ProductionTimetableSubscriptionPolicies 0..1 request requests 1 AbstractRequest context RequestTimestamp[1] : dateTime MessageIdentifier[0..1] : string 1 0..* 1 0..1 ProductionTimetableRequest RequestContext ProductionTimetableTopics[0..1] : ProductionTimetableTopics ProductionTimetablePolicies[0..1] : ProductionTimetablePolicies Extensions[0..1] : any topics 1 1 policies TimetableVersion 0..1 0..1 version operator Operator 0..1 line 1 1 1 ProductionTimetableTopics ProductionTimetablePolicies ValidityPeriod[0..1] 0..1 : ValidityPeriod TimetableVersionRef[0..1] : TimetableVersionCode OperatorRef[0..1] : OperatorCode LineRef[0..1] : LineCode DirectionRef[0..1] : DirectionCode Language : lang IncrementalUpdates : boolean Line 1 1 directions 0..1 direction 1 period ValidityPeriod Direction 0..* 0..1 0..1 -StartTime : dateTime -EndTime : dateTime Figure 4-2 ProductionTimetableRequest - Detail © Kizoom 2006- 2007 Page 11 SIRI Functional Services - UML Diagrams 4.2 Delivery 4.2.1 ProductionTimetableDelivery Summary 1 1 ProducerResponse Participant errors ServiceDelivery deliveries 0..* 1 SIRI-PT Summary ProductionTimetableDelivery ErrorCondition 1 0..1 © 2007 SIRI ProductionTimetableDelivery 0..1 version[1] Extensions[0..1] VehicleJourney 1 VersionRef[0..1] LineRef[1] DirectionRef[1] JourneyPatternInfo[0..1] ServiceInfo[0..1] DatedVehicleJourneyInfo[0..1] Extensions[0..1] 1 Line 1 1 Direction 1 journeys 1 1 Route default 1 2..* 0..1 1 0..1 1 1 VehicleFeature DatedVehicleJourney distrinbutor journey DatedVehicleJourneyCode[0..1] VehicleJourneyRef[0..1] ExtraJourney[0..1] Cancellation[0..1] JourneyPatternInfo[0..1] ServiceInfo[0..1] VehicleJourneyNote[0..1] JourneyNote[0..1] BlockRef[1] CourseOfJourneyRef[1] Extensions[0..1] 1 JourneyPatternRef[0..1] VehicleMode[0..1] RouteRef[0..1] PublishedLineName[0..1] DirectionName[0..1] ExternalLineRef[0..1] 1 0..* 1 journey info 0..1 ServiceFeature 1 0..1 ServiceInfo service feature OperatorRef[0..1] ProductCategoryRef[0..1] ServiceFeatureRef[0..*] 1 VehicleFeatureRef[0..*] vehicle feature 0..1 service0..1 1 0..1 JourneyPatternInfo stops journey default DestinationDisplay[0..1] LineNote[0..1] HeadwayService[0..1] Monitored[0..1] 0..1 0..1 pattern Operator 0..1 DatedVehicleJourneyInfo JourneyPattern 1 0..1 DatedTimetableVersionFrame 0..* 1 0..1 TimetableVersion 1 timetables pattern calls Mode block Block 1 0..1 run CourseOfJourney 1 0..1 1 0..1 2..* StopPointInSequence StopPointRef[1] VisitNumber[0..1] Order[0..1] StopPointName[0..1] 1 0..1 stop point DatedCall 1 1 call arrival 0..1 0..1 1 1 call AimedArrivalInfo stop connection StopPointInSequence[1] CallInfo[0..1] CallNote[0..1] FacilityChange[0..1] AimedArrivalInfo[0..1] AimedDepartureInfo[0..1] AimedHeadwayInterval[0..1] Extensions[0..1] AimedArrivalTime[0..1] ArrivalPlatformName[0..1] ArrivalBoardingActivity[0..1] 1 AimedDepartureInfo AimedDepartureTime[0..1] DeparturePlatformName[0..1] DepartureBoardingActivity[0..1] CallInfo TimingPoint[0..1] BoardingStretch[0..1] RequestStop[0..1] DestinationDisplay[0..1] TargetedInterchange call departure 0..1 0..1 «enumeration» ArrivalActivityEnum alighting noAlighting passThru 1 0..* 1 InterchangeCode[0..1] DistributorVehicleJourneyRef[1] DistributorConnectionLinkRef[0..1] DistributorConnectionLink[0..1] DistributorVisitNumber[0..1] DistributorOrder[0..1] StaySeated[0..1] Guaranteed[0..1] Advertised[0..1] MaximumWaitTime[0..1] Extensions[0..1] 1 «enumeration» DepartureActivityEnum boarding noBoarding passThru connection link to stop 4.2.1.1 1 1 ConnectionLinkCode[0..1] StopPointRef[0..1] StopPointName[0..1] DefaultDuration[0..1] FrequentTravellerDuration[0..1] OccasionalTravellerDuration[0..1] ImpairedAccessDuration[0..1] 0..1 Figure 4-3 ProductionTimetableDelivery - Summary © Kizoom 2006- 2007 0..1 ConnectionLink 0..1 distributor stop StopPoint 1 ref Page 12 SIRI Functional Services - UML Diagrams 4.2.2 ProductionTimetableDelivery Detail 1 Participant ProducerResponse 1 AbstractServiceDelivery 1 ResponseTimeStamp[1] : dateTime RequestMesageRef[0..1] : MessageQualifier SubscriberRef[0..1] : ParticipantCode SubscriptionFilterRef[0..1] : SubscriptionFilterCode SubscriptionRef[0..1] : SubscriptionCode Address[0..1] : EndPointAddress ResponseMessageIdentifier[0..1] : MessageQualifier Status[0..1] : boolean ErrorCondition[0..1] : ErrorCondition ValidUntil[0..1] : dateTime ShortestPossibleCycle[0..1] : positiveDuration 1 ResponseTimeStamp[1] : dateTime ProducerRef[0..1] : ParticipantCode Address[0..1] : EndPointAddress ResponseMessageIdentifier[0..1] : MessageQualifier RequestMessageRef[0..1] : MessageQualifier SIRI -PT ProductionTimetableDelivery 0..1 © 2006 SIRI ServiceDelivery 1 1 ErrorCondition Error[1] : AbstractError Description[1] : ErrorDescription 0..1Status[0..1] : boolean ErrorCondition[1] : ErrorCondition MoreData[1] : boolean 1 0..* JourneyPattern Mode 1 AbstractItem TimetableVersion 0..1 0..1 DatedTimetableVersionFrame default 1 1 0..1 ServiceInfo OperatorRef[0..1] : OperatorCode ProductCategoryRef[0..1] : ProductCategoryCode ServiceFeatureRef[0..*] : ServiceFeatureCode VehicleFeatureRef[0..*] : VehicleFeatureCode 0..1 VehicleJourney journeys 1 0..1 DestinationDisplay[0..1] : populatedString DatedVehicleJourneyCode[0..1] : DatedVehicleJourneyCode 0..1 journey info LineNote[0..1] : populatedString VehicleJourneyRef[0..1] : VehicleJourneyCode HeadwayService[0..1] : boolean ExtraJourney[0..1] : boolean 1 Monitored[0..1] : boolean Cancellation[0..1] : boolean 0..1 JourneyPatternInfo[0..1] : JourneyPatternInfo ServiceInfo[0..1] : ServiceInfo pattern 1 VehicleJourneyNote[0..1] : populatedString JourneyNote[0..1] : populatedString BlockRef[1] : BlockCode StopPointInSequence 1 stop point CourseOfJourneyRef[1] : CourseOfJourneyCode StopPointRef[1] : StopPointCode Extensions[0..1] : any VisitNumber[0..1] : VisitNumber 1 Order[0..1] : positiveInteger 0..1 1 1 StopPointName[0..1] : populatedString calls run 1 block 0..1 Block DatedCall 0..1 CourseOfJourney 0..1 call 2..*1 CallInfo TimingPoint[0..1] : boolean BoardingStretch[0..1] : boolean RequestStop[0..1] : boolean DestinationDisplay[0..1] : populatedString 0..1stops DatedVehicleJourneyInfo DatedVehicleJourney 0..* 1 JourneyPatternRef[0..1] : JourneyPatternCode VehicleMode[0..1] : VehicleModesEnum RouteRef[0..1] : RouteCode PublishedLineName[0..1] : populatedString DirectionName[0..1] : populatedString ExternalLineRef[0..1] : LineCode default 1 1 0..1 JourneyPatternInfo default 0..* VersionRef[0..1] : TimetableVersionCode LineRef[1] : LineCode DirectionRef[1] : DirectionCode JourneyPatternInfo[0..1] : JourneyPatternInfo ServiceInfo[0..1] : ServiceInfo DatedVehicleJourneyInfo[0..1] : DatedVehicleJourneyInfo Extensions[0..1] : any 1 1 1 0..1 Route 0..1 version[1] : VersionString Extensions[0..1] : any timetables -RecordedAtTime[1] : dateTime 1 ProductionTimetableDelivery TargetedInterchange StopPoint 1 1 0..1 0..1 AimedArrivalInfo StopPointInSequence[1] : StopPointInSequence CallInfo[0..1] : CallInfo CallNote[0..1] : populatedString FacilityChange[0..1] : FacilityChange AimedArrivalInfo[0..1] : AimedArrivalInfo AimedDepartureInfo[0..1] : AimedDepartureInfo AimedHeadwayInterval[0..1] : positiveDuration Extensions[0..1] : any InterchangeCode[0..1] : InterchangeCode DistributorVehicleJourneyRef[1] : DatedVehicleJourneyCode DistributorConnectionLinkRef[0..1] : ConnectionLinkCode DistributorConnectionLink[0..1] : ConnectionLink DistributorVisitNumber[0..1] : VisitNumber DistributorOrder[0..1] : positiveInteger StaySeated[0..1] : boolean Guaranteed[0..1] : boolean Advertised[0..1] : boolean MaximumWaitTime[0..1] : positiveDuration Extensions[0..1] : any 2..* AimedArrivalTime[0..1] : dateTime ArrivalPlatformName[0..1] : populatedString ArrivalBoardingActivity[0..1] : ArrivalActivityEnum 1 to stop 1 0..1 1 AimedDepartureInfo AimedDepartureTime[0..1] : dateTime DeparturePlatformName[0..1] : populatedString DepartureBoardingActivity[0..1] : DepartureActivityEnum connection 0..* ConnectionLink ref 1{OR} 0..1 0..1 ConnectionLinkCode[0..1] : ConnectionLinkCode StopPointRef[0..1] : StopPointCode StopPointName[0..1] : populatedString DefaultDuration[0..1] : positiveDuration FrequentTravellerDuration[0..1] : positiveDuration OccasionalTravellerDuration[0..1] : positiveDuration ImpairedAccessDuration[0..1] : positiveDuration 1 1 Figure 4-4 ProductionTimetableDelivery - Detail © Kizoom 2006- 2007 Page 13 SIRI Functional Services - UML Diagrams 5 SIRI EstimatedTimetable (ET) The Estimated Timetable service is used by the AVMS to inform interested schedule information systems of the current status of all known vehicle journeys. This enables the schedule information system to provide up-to-the-minute information for shortterm journey planning. It can also be used to support intelligent displays that calculate the deviation from timetable themselves using a timetable and a real time difference delay by the SIRI Stop Monitoring Service. The Request Topics allow a Consumer system to specify that only timetables for a specific timetable version. Operator, line, or direction are to be returned. 5.1 Subscription & Request 5.1.1 EstimatedTimetableRequest Summary participant Participant 1 1 1 subscriptions participant SubscriptionRequest * 1 SIRI-ET Summary EstimatedTimeTableSubscription & EstimatedTimeTableRequest © 2006 SIRI EstimatedTimetableSubscriptionRequest policies EstimatedTimetableRequest[1] EstimatedTimetableSubscriptionPolicies[0..1] Extensions[0..1] 1 request requests EstimatedTimetableSubscriptionPolicies 1 ServiceRequest 1 0..* 1 policies EstimatedTimetableRequest EstimatedTimetableTopics[0..1] EstimatedTimetablePolicies[0..1] Extensions[0..1] 1 0..1 1 EstimatedTimetablePolicies Language[1] topics 0..1 TimetableVersion 0..1 0..1 1 version EstimatedTimetableTopics 1 operator Operator 0..1 1 PreviewInterval[0..1] TimetableVersionRef[0..1] OperatorRef[0..1] LineRef[0..1] DirectionRef[0..1] 1 0..1 line Line directions 1 1 direction 0..1 0..* Direction Figure 5-1 EstimatedTimetableRequest - Summary © Kizoom 2006- 2007 Page 14 SIRI Functional Services - UML Diagrams 5.1.2 EstimatedTimetableRequest Detail SubscriptionRequest participant Participant 1 RequestTimestamp[1] : dateTime Address[0..1] : anyURI RequestorRef[1] : ParticipantCode MessageIdentifer[0..1] : string ConsumerAddress[0..1] : anyURI SubscriptionFilterIdentifier[1] : NMTOKEN SubscriptionContext[0..1] 1 1 1subscriptions AbstractSubscriptionRequest SubscriberRef[1] : ParticipantCode SubscriptionIdentifier[1] InitialTerminationTime[1] participant * context 1 0..1 EstimatedTimetableSubscriptionRequest EstimatedTimetableRequest[1] : EstimatedTimetableRequest EstimatedTimetableSubscriptionPolicies[0..1] : EstimatedTimetableSubscriptionPolicies Extensions[0..1] : any SubscriptionContext HeartbeatInterval[0..1] : duration 1 1 policies 1 ServiceRequest EstimatedTimetableSubscriptionPolicies RequestContext[1] : RequestContext RequestTimestamp[1] : dateTime Address[1] : anyURI RequestorRef[1] : ParticipantCode MessageIdentifer[1] : string requests 0..1 request 1 AbstractRequest RequestTimestamp[1] : dateTime MessageIdentifier[0..1] : string context 1 0..* 0..1 1 EstimatedTimetableRequest RequestContext EstimatedTimetableTopics[0..1] : EstimatedTimetableTopics EstimatedTimetablePolicies[0..1] : ProductionTimetablePolicies Extensions[0..1] : any version 1 TimetableVersion 1 0..1 Operator 1 operator 0..1 1 0..1 1 1 topics 0..1 EstimatedTimetableTopics line Line PreviewInterval[0..1] : duration TimetableVersionRef[0..1] : TimetableVersionCode OperatorRef[0..1] : OperatorCode LineRef[0..1] : LineCode DirectionRef[0..1] : DirectionCode 1 directions direction Direction 0..* policies 0..1 EstimatedTimetablePolicies Language : lang SIRI-ET EstimatedTimeTableSubscription & EstimatedTimeTableRequest © 2006 SIRI 0..1 Figure 5-2 EstimatedTimetableRequest - Detail © Kizoom 2006- 2007 Page 15 SIRI Functional Services - UML Diagrams 5.2 Delivery 5.2.1 EstimatedTimetableDelivery Summary 1 1 ProducerResponse Participant ServiceDelivery SIRI-PT Summary EstimatedTimeTableDelivery ErrorCondition 1 © 2006 SIRI 0..1 0..* 1 operator EstimatedTimetableDelivery version[1] Extensions[0..1] ServiceFeature ServiceInfo 1 0..1 DatedVehicleJourney EstimatedJourneyVersionFrame * Operator 1 0..1 VersionRef[0..1] Extensions[0..1] journeys 1 0..1 0..* service 1 1 1 1 Direction 1 JourneyPattern 1 Line 1 0..1 0..1 1 1 1 JourneyPatternInfo JourneyPatternRef[0..1] VehicleMode[0..1] RouteRef[0..1] PublishedLineName[0..1] DirectionName[0..1] ExternalLineRef[0..1] 1 0..1 pattern info 1 Mode 0..1 VehicleFeature ProductCategory EstimatedVehicleJourney 0..1 1 0..1 OperatorRef[0..1] ProductCategoryRef[0..1] 1 ServiceFeatureRef[0..*] VehicleFeatureRef[0..*] 1 0..1 1 0..1 LineRef[1] DirectionRef[1] DatedVehicleJourneyRef[0..1] DatedVehicleJourneyIndirectRef[0..1] EstimatedVehicleJourneyCode[0..1] ExtraJourney[0..1] Cancellation[0..1] JourneyPatternInfo[0..1] ServiceInfo[0..1] VehicleJourneyName[0..1] JourneyNote[0..1] HeadwayService[0..1] DisruptionInfo[0..1] Monitored[0..1] PredictionInaccurate[0..1] Occupancy[0..1] OperationalInfo[0..1] EstimatedCalls[2..*] IsCompleteStopSequence[0..1] Extensions[0..1] block OperationalInfo 1 Block BlockRef[0..1] 1 run CourseOfJourneyRef[0..1] 0..1 VehicleRef[0..1] 0..1 1 0..1 operational info 1 CourseOfJourney vehicle 1 Vehicle 0..1 «enumeration» OccupancyEnum full seatsAvailable standingAvailable stops 1 1 2..* 0..1 SituationRef[0..1] FacilityChange[0..1] 0..1 0..1 CallInfo to 1 1 1 Situation stop 0..* arrival info 1 0..1 ArrivalInfo ArrivalStatus[0..1] ArrivalPlatformName[0..1] ArrivalBoardingActivity[0..1] 0..1 call info StopPointInSequence[0..1] ExtraCall[0..1] Cancellation[0..1] CallInfo[0..1] DestinationDisplay[0..1] CallNote[0..1] FacilityChange[0..1] AimedArrivalTimes[0..1] ArrivalInfo[0..1] AimedDepartureTimes[0..1] DepartureInfo[0..1] HeadwayInterval[0..1] Extensions[0..1] arrival times 1 «enumeration» TimeStatusEnum early onTime delayed arrived cancelled noReport DisruptionInfo between EstimatedCall 1 StopPointInSequence «enumeration» ArrivalActivityEnum alighting noAlighting passThru disruption 0..* 1 StopPointRef[1] VisitNumber[0..1] Order[0..1] StopPointName[0..1] 1 calls OriginRef[1] from AimedDepartureTime[1] DestinationRef[1] AimedArrivalTime[1] StopPoint stop 1 1 1 DatedVehicleJourneyIndirectRef 1 1 headway 0..1 0..1 TimingPoint[0..1] BoardingStretch[0..1] RequestStop[0..1] DestinationDisplay[0..1] 1 «enumeration» DepartureActivityEnum boarding noBoarding passThru departure info 1 0..1 DepartureInfo DepartureStatus[0..1] DeparturePlatformName[0..1] DepartureBoardingActivity[0..1] departure times 0..1 AimedArrivalTimes HeadwayInfo AimedDepartureTimes AimedArrivalTime[0..1] ExpectedArrivalTime[0..1] AimedHeadWayInterval[0..1] ExpectedHeadwayInterval[0..1] AimedDepartureTime[0..1] ExpectedDepartureTime[0..1] Figure 5-3 EstimatedTimetableDelivery - Summary © Kizoom 2006- 2007 Page 16 SIRI Functional Services - UML Diagrams 5.2.2 EstimatedTimetableDelivery Detail ProducerResponse SIRI-PT EstimatedTimeTableDelivery ResponseTimeStamp[1] : dateTime ProducerRef[0..1] : ParticipantCode Address[0..1] : EndPointAddress ResponseMessageIdentifier[0..1] : MessageQualifier RequestMessageRef[0..1] : MessageQualifier © 2006 SIRI AbstractServiceDelivery ResponseTimeStamp[1] : dateTime RequestMesageRef[0..1] : MessageQualifier SubscriberRef[0..1] : ParticipantCode SubscriptionFilterRef[0..1] : SubscriptionFilterCode SubscriptionRef[0..1] : SubscriptionCode Address[0..1] : EndPointAddress ResponseMessageIdentifier[0..1] : MessageQualifier Status[0..1] : boolean ErrorCondition[0..1] : ErrorCondition ValidUntil[0..1] : dateTime ShortestPossibleCycle[0..1] : positiveDuration Participant Mode 1 0..1 ServiceDelivery ErrorCondition Error[1] : AbstractError Description[1] : ErrorDescription deliveries 0..* 0..1 0..1 Status[0..1] : boolean ErrorCondition[1] : ErrorCondition MoreData[1] : boolean 0..1 Route 1 1 JourneyPatternInfo EstimatedTimetableDelivery Version 1 participant 1 version[1] : VersionString Extensions[0..1] : any AbstractItem RecordedAtTime[1] : dateTime 0..1 1 1 0..1 0..* JourneyPatternRef[0..1] : JourneyPatternCode VehicleMode[0..1] : VehicleModesEnum RouteRef[0..1] : RouteCode PublishedLineName[0..1] : populatedString DirectionName[0..1] : populatedString ExternalLineRef[0..1] : LineCode delivery VersionRef[0..1] : TimetableVersionCode Extensions[0..1] : any 1 1 1 1 Line ServiceInfo pattern info OperatorRef[0..1] : OperatorCode ProductCategoryRef[0..1] : ProductCategoryCode ServiceFeatureRef[0..*] : ServiceFeatureCode VehicleFeatureRef[0..*] : VehicleFeatureCode 0..1 1 Direction 0..1 1 1 EstimatedVehicleJourney 1 pattern 1 0..1 EstimatedJourneyVersionFrame 1 1 JourneyPattern 0..1 1 1 Operator 1 service 0..1 block 1 OperationalInfo BlockRef[0..1] : BlockCode CourseOfJourneyRef[0..1] : CourseOfJourneyCode VehicleRef[0..1] : VehicleCode LineRef[1] : LineCode Block DirectionRef[1] : DirectionCode operational info DatedVehicleJourneyRef[0..1] : DatedVehicleJourneyCode 1 run 1 0..1 stops DatedVehicleJourneyIndirectRef[0..1] : DatedVehicleJourneyIndirectRef 0..1 EstimatedVehicleJourneyCode[0..1] : EstimatedVehicleJourneyCode CourseOfJourney 0..* 1 ExtraJourney[0..1] : boolean Vehicle 0..1 Cancellation[0..1] : boolean DatedVehicleJourneyIndirectRef JourneyPatternInfo[0..1] : JourneyPatternInfo ServiceInfo[0..1] : ServiceInfo OriginRef[1] : StopPointCode 1 VehicleJourneyName[0..1] : populatedString AimedDepartureTime[1] : dateTime JourneyNote[0..1] : populatedString DestinationRef[1] : StopPointCode 1 0..1 HeadwayService[0..1] : boolean AimedArrivalTime[1] : dateTime DisruptionInfo[0..1] : DisruptionInfo 1 Monitored[0..1] : boolean 2..* 1 1 1 StopPointInSequence PredictionInaccurate[0..1] : boolean 1 Occupancy[0..1] : OccupancyEnum StopPointRef[1] : StopPointCode StopPoint 1 OperationalInfo[0..1] : OperationalInfo VisitNumber[0..1] : VisitNumber EstimatedCalls[2..*] : EstimatedCall Order[0..1] : positiveInteger stop IsCompleteStopSequence[0..1] : boolean StopPointName[0..1] : populatedString 0..* 1 Extensions[0..1] : any 0..1 CallInfo calls 1 1 EstimatedCall TimingPoint[0..1] : boolean StopPointInSequence[0..1] : StopPointInSequence DisruptionInfo BoardingStretch[0..1] : boolean ExtraCall[0..1] : boolean RequestStop[0..1] : boolean SituationRef[0..1] : SituationCode 0..1 Cancellation[0..1] : boolean DestinationDisplay[0..1] : populatedString FacilityChange[0..1] : FacilityChange CallInfo[0..1] : CallInfo 0..* 1 1 DestinationDisplay[0..1] : populatedString 0..1 1 CallNote[0..1] : populatedString HeadwayInfo Situation 0..1FacilityChange[0..1] : FacilityChange AimedHeadWayInterval[0..1] : positiveDuration 1 AimedArrivalTimes[0..1] : AimedArrivalTimes AimedArrivalTimes 1 ExpectedHeadwayInterval[0..1] : positiveDuration 0..1 ArrivalInfo[0..1] : ArrivalInfo AimedArrivalTime[0..1] : dateTime AimedDepartureTimes[0..1] : AimedDepartureTimes ExpectedArrivalTime[0..1] : dateTime DepartureInfo[0..1] : DepartureInfo AimedDepartureTimes 1 HeadwayInterval[0..1] : HeadwayInfo AimedDepartureTime[0..1] : dateTime «enumeration» 0..1Extensions[0..1] : any ExpectedDepartureTime[0..1] : dateTime TimeStatusEnum 0..1 early 1 ArrivalInfo DepartureInfo onTime departure info ArrivalStatus[0..1] : TimeStatusEnum delayed DepartureStatus[0..1] : TimeStatusEnum ArrivalPlatformName[0..1] : populatedString arrived DeparturePlatformName[0..1] : populatedString 0..1 ArrivalBoardingActivity[0..1] : ArrivalActivityEnum cancelled DepartureBoardingActivity[0..1] : DepartureActivityEnum noReport Figure 5-4 EstimatedTimetableDelivery - Detail © Kizoom 2006- 2007 Page 17 SIRI Functional Services - UML Diagrams 6 SIRI StopTimetable (ST) The SIRI Stop Timetable Service provides a stop-centric view of timetabled vehicle arrivals and departures at a designated stop. It can be used to reduce the amount of information that needs to be transmitted in real-time to stops and displays, as reference data for a Stop Monitoring Service; and provides a data feed of the static timetables. The Request Topics allow a Consumer system to specify that only stop timetables for a specific monitoring point, line, or direction are to be returned. 6.1 Subscription & Request 6.1.1 StopTimetableRequest Summary participant 1 Participant SIRI-ST Summary StopTimetableSubscription & StopTimetableRequest 1 1 SubscriptionRequest requests 0..* © 2007 SIRI 1 participant StopTimetableSubscriptionRequest StopTimetableRequest[1] StopTimetableSubscriptionPolicies[0..1] Extensions[0..1] 1 policies 0..1 1 ServiceRequest 1 StopTimetableSubscriptionPolicies request1 requests 0..* 1 StopTimetableRequest policies StopTimetableTopics[0..1] StopTimetablePolicies[0..1] Extensions[0..1] topics 0..1 1 StopTimetablePolicies Language[0..1] 1 0..1 Monitor 0..1 monitor 1 line StopTimetableTopics MonitoringWindow[0..1] MonitoringRef[0..1] LineRef[0..1] DirectionRef[0..1] Line 1 0..1 direction Direction 1 0..1 Figure 6-1 StopTimetableRequest - Summary © Kizoom 2006- 2007 Page 18 SIRI Functional Services - UML Diagrams 6.1.2 StopTimetableRequest Detail SubscriptionRequest RequestTimestamp[1] : dateTime Address[0..1] : anyURI RequestorRef[1] : ParticipantCode MessageIdentifer[0..1] : string participant 1 ConsumerAddress[0..1] : anyURI SubscriptionFilterIdentifier[1] : NMTOKEN SubscriptionContext[0..1] 1 © 2007 SIRI requests 1 0..* StopTimetableSubscriptionRequest 0..1 -StopTimetableRequest[1] : StopTimetableRequest -StopTimetableSubscriptionPolicies[0..1] : StopTimetableSubscriptionPolicies -Extensions[0..1] : any participant SubscriptionContext 1 AbstractSubscriptionRequest SubscriberRef[1] : ParticipantCode SubscriptionIdentifier[1] InitialTerminationTime[1] context 1 Participant SIRI-ST StopTimetableSubscription & StopTimetableRequest HeartbeatInterval[0..1] : duration policies 1 0..1 1 1 request StopTimetableSubscriptionPolicies ServiceRequest RequestContext[1] : RequestContext RequestTimestamp[1] : dateTime Address[1] : anyURI RequestorRef[1] : ParticipantCode MessageIdentifer[1] : string AbstractRequest requests 1 RequestTimestamp[1] : dateTime MessageIdentifier[0..1] : string 1 0..* context 1 StopTimetableRequest StopTimetableTopics[0..1] : StopTimetableTopics StopTimetablePolicies[0..1] : StopTimetablePolicies Extensions[0..1] : any 0..1 policies 1 RequestContext 1topics 0..1 0..1 StopTimetableTopics 1 monitor MonitoringWindow[0..1] : HalfOpenTimestampRange MonitoringRef[0..1] : MonitoringCode LineRef[0..1] : LineCode DirectionRef[0..1] : DirectionCode 0..1 1 line Monitor Line StopTimetablePolicies direction Language[0..1] : lang 1 0..1 Direction 0..1 Figure 6-2 StopTimetableRequest - Detail © Kizoom 2006- 2007 Page 19 SIRI Functional Services - UML Diagrams 6.2 Delivery 6.2.1 StopTimetableDelivery Summary ProducerResponse SIRI-ST Summary StopTimetableDelivery ErrorCondition ServiceDelivery * -Error -Description * 1 deliveries 0..* © 2007 SIRI cancellations StopTimetableDelivery -version[1] -Extensions[0..1] * 1 visits 1 cancels TimetabledStopVisitCancellation 1 1 * TimetabledStopVisit DataFrame MonitoringRef[1] TargetedVehicleJourney[1] Extensions[1] 0..1 DatedVehicleJourney frame0..1 1 AbstractVehicleJourney 1 MonitoringRef[1] VisitNumber[0..1] VehicleJourneyIdentity[1] JourneyPatternInfo[0..1] Extensions[0..1] identity journey 1 1 1 FramedVehicleJourneyRef journeys JourneyPattern 1 1 0..1 route stops 1 0..1 journey pattern JourneyPatternRef[0..1] VehicleMode[0..1] RouteRef[0..1] PublishedLineName[0..1] DirectionName[0..1] ExternalLineRef[0..1] 1 -LineRef[1] -DirectionRef[1] -FramedVehicleJourneyRef[0..1] line 0..11 1 1 1 JourneyPatternInfo TargetedVehicleJourney VehicleJourneyIdentity[1] JourneyPatternInfo[0..*] VehicleJourneyInfo[0..1] MonitoringRef[0..1] Extensions[0..1] Mode 2..* 0..1 1 origin destination 0..1 1 stop StopPoint 1 0..* 0..1 stop 1 0..1 VehicleJourneyInfo 1 1 0..1 Monitor 1 vehicle journey Info 1 0..1 -StopPointRef[1] -VisitNumber[0..1] -Order[0..1] -StopPointName[0..1] Direction monitor calls StopPointInSequence 1 Line 1 mode 0..1 monitoring point direction 1 VehicleJourneyIdentity Route identity 0..1 pattern 1 0..1 vehicle jounery 1 info ServiceInfo[0..1] OriginRef[0..1] DestinationName[0..1] OriginShortName[0..1] Via[0..*] DestinationRef[0..1] DestinationName[0..1] DestinationShortName[0..1] VehicleJourneyNote[0..1] JourneyNote[0..1] HeadwayService[0..1] OriginAimedDepartureTime[0..1] DestinationAimedDepartureTime[0..1] 1 TargetedCall «enumeration» ArrivalActivityEnum alighting noAlighting passThru StopPointRef[0..1] VisitNumber[1] Order[0..1] TimingPoint[0..1] ServiceInfo[0..1] AimedArrivalInfo[0..1] AimedDepartureInfo[0..1] AimedHeadwayInterval[0..1] Extensions[0..1] arrival info 0..1 AimedArrivalInfo AimedArrivalTime[0..1] ArrivalPlatformName[0..1] ArrivalBoardingActivity[0..1] 1 1 «enumeration» DepartureActivityEnum boarding noBoarding passThru 0..1 operator 1 service info ServiceInfo 0..1 OperatorRef[0..1] ProductCategoryRef[0..1] ServiceFeatureRef[0..*] VehicleFeatureRef[0..*] departure info 0..1 1 1 Operator 0..1 service feature 0..1 1 ServiceFeature vehicle feature VehicleFeature AimedDepartureInfo 0..1 AimedDepartureTime[0..1] DeparturePlatformName[0..1] DepartureBoardingActivity[0..1] Figure 6-3 StopTimetableDelivery - Summary © Kizoom 2006- 2007 Page 20 SIRI Functional Services - UML Diagrams 6.2.2 StopTimetableDelivery Detail ProducerResponse ResponseTimeStamp[1] : dateTime ProducerRef[0..1] : ParticipantCode Address[0..1] : EndPointAddress ResponseMessageIdentifier[0..1] : MessageQualifier RequestMessageRef[0..1] : MessageQualifier SIRI-ST StopTimetableDelivery © 2006 SIRI AbstractServiceDelivery 0..1 ResponseTimeStamp[1] : dateTime RequestMesageRef[0..1] : MessageQualifier SubscriberRef[0..1] : ParticipantCode SubscriptionFilterRef[0..1] : SubscriptionFilterCode SubscriptionRef[0..1] : SubscriptionCode Address[0..1] : EndPointAddress ResponseMessageIdentifier[0..1] : MessageQualifier Status[0..1] : boolean ErrorCondition[0..1] : ErrorCondition ValidUntil[0..1] : dateTime ShortestPossibleCycle[0..1] : positiveDuration ServiceDelivery 1 errors Status[0..1] : boolean ErrorCondition[1] : ErrorCondition MoreData[1] : boolean ErrorCondition Error[1] : AbstractError Description[1] : ErrorDescription 1 1 0..1 deliveries 0..* StopTimetableDelivery cancellations -version[1] : VersionString -Extensions[0..1] AbstractItem 1 -RecordedAtTime[1] : dateTime 1 AbstractReferencedItem AbstractIdentifiedItem -IdentifiedItemRef[0..1] : IdentifiedItemCode -IdentifiedItemCode[0..1] : IdentifiedItemCode cancels 0..1 MonitoringRef[1] : MonitoringCode TargetedVehicleJourney[1] : TargetedVehicleJourney Extensions[1] : any 1 Monitor VehicleJourneyIdentity[1] : VehicleJourneyIdentity JourneyPatternInfo[0..*] : JourneyPatternInfo VehicleJourneyInfo[0..1] : JourneyPatternInfo MonitoringRef[0..1] : MonitoringCode Extensions[0..1] : any 1vehicle journey Info 0..1 1 0..1 1 FramedVehicleJourneyRef 1 pattern 1 VehicleJourneyIdentity identity 1 1 0..1 1line LineRef[1] : LineCode DirectionRef[1] : DirectionCode FramedVehicleJourneyRef[0..1] : FramedVehicleJourneyRef 0..1 Line 1 ServiceInfo[0..1] : ServiceInfo OriginRef[0..1] : JourneyPlaceCode DestinationName[0..1] : populatedString OriginShortName[0..1] : populatedString Via[0..*] : populatedString DestinationRef[0..1] : DestinationCode DestinationName[0..1] : populatedString DestinationShortName[0..1] : populatedString VehicleJourneyNote[0..1] : populatedString JourneyNote[0..1] : populatedString HeadwayService[0..1] : boolean OriginAimedDepartureTime[0..1] : dateTime DestinationAimedDepartureTime[0..1] : dateTime TargetedCall StopPointRef[0..1] : StopPointCode VisitNumber[1] : VisitNumber Order[0..1] : positiveInteger 0..* TimingPoint[0..1] : boolean ServiceInfo[0..1] : ServiceInfo AimedArrivalInfo[0..1] : AimedArrivalInfo AimedDepartureInfo[0..1] : AimedDepartureInfo AimedHeadwayInterval[0..1] : positiveDuration Extensions[0..1] : any 0..1 stop StopPoint 1 JourneyPatternInfo journey pattern VehicleJourneyInfo calls MonitoringRef[1] : MonitoringCode VisitNumber[0..1] : VisitNumber VehicleJourneyIdentity[1] : VehicleJourneyIdentity JourneyPatternInfo[0..1] : JourneyPatternInfo Extensions[0..1] : any 0..1 monitor TargetedVehicleJourney 1 TimetabledStopVisitCancellation monitoring point 1 1 1 TimetabledStopVisit 1 * visits * 1 «enumeration» VehicleModesEnum air bus coach ferry metro rail tram underground JourneyPattern 1 0..1 pattern 0..1 1 0..1 1 info route Route JourneyPatternRef[0..1] : JourneyPatternCode VehicleMode[0..1] : VehicleModesEnum RouteRef[0..1] : RouteCode PublishedLineName[0..1] : populatedString DirectionName[0..1] : populatedString ExternalLineRef[0..1] : LineCode operator ServiceInfo Operator service feature 0..1 1 OperatorRef[0..1] : OperatorCode 0..1 ProductCategoryRef[0..1] : ProductCategoryCode ServiceFeature ServiceFeatureRef[0..*] : ServiceFeatureCode 1 0..1 VehicleFeatureRef[0..*] : VehicleFeatureCode vehicle feature 0..1 1 categories VehicleFeature 1 ProductCategory 0..1 service info 0..1 «enumeration» ArrivalActivityEnum AimedArrivalInfo alighting AimedArrivalTime[0..1] : dateTime 1arrival info noAlighting ArrivalPlatformName[0..1] : populatedString passThru ArrivalBoardingActivity[0..1] : ArrivalActivityEnum 0..1 1 «enumeration» departure info AimedDepartureInfo DepartureActivityEnum 1 AimedDepartureTime[0..1] : dateTime boarding 0..1 DeparturePlatformName[0..1] : populatedString noBoarding DepartureBoardingActivity[0..1] : DepartureActivityEnum passThru Figure 6-4 StopTimetableDelivery - Detail © Kizoom 2006- 2007 Page 21 SIRI Functional Services - UML Diagrams 7 SIRI StopMonitoring (SM) The SIRI Stop Monitoring Service provides a stop-centric view of vehicle arrivals and departures at a designated stop. It can be used by displays and other presentation services to provide departure board and other presentations of timetable and real-time journey information both at stops and at a distance. The choice of data to display and the presentation is up to the client system. The service can be used in conjunction with the SIRI Stop Timetable service. For at stop use, the service can support cleardown identifiers to drive direct wireless cleardown of the displays signalled by the vehicle in proximity. The Topics allow a Consumer system to specify that only stop timetables for a specific Monitoring point, Operator, Line, or Direction are to be returned. The Request Policies allow a Consumer system to control the amount of data returned The Subscription Policies allow a Consumer system to control the change threshold for update. 7.1 Subscription & Request 7.1.1 StopMonitoringRequest Summary participant Participant 1 SIRI-SM Summary StopMonitoringSubscription & StopMonitoringRequest 1 1 requests participant SubscriptionRequest 1 0..* © 2007 SIRI StopMonitoringSubscriptionRequest 1 requests ServiceRequest StopMonitoringRequest[1] StopMonitoringSubscriptionPolicies[0..1] Extensions[0..1] 1 request policies 0..1 1 StopMonitoringSubscriptionPolicies IncrementalUpdates[1] ChanegBeforeUpdate[1] 1 1 0..* StopMonitoringRequest StopMonitoringTopics[0..1] StopMonitoringPolicies[0..1] Extensions[0..1] policies 1 StopMonitoringPolicies Language[0..1] MaximumStopVisits[0..1] MinimumStopVisitsPerLine[0..1] MaximumTextLength[0..1] StopMonitoringDetailLevel[0..1] MaximumNumberOfPreviousCalls[0..1] MaximumNumberOfOnwardCalls[0..1] 1 topics 0..1 StopMonitoringTopics monitor Monitor 0..1 Operator 1 operator 0..1 1 PreviewInterval[0..1] StartTime[0..1] MonitoringRef[0..1] OperatorRef[0..1] LineRef[0..1] DirectionRef[0..1] DestinationRef[0..1] StopVisitTypes[1] 0..1 0..1 1 line 1 Line direction 1 directions 0..* 0..1 Direction Figure 7-1 StopMonitoringRequest - Summary © Kizoom 2006- 2007 Page 22 SIRI Functional Services - UML Diagrams 7.1.2 StopMonitoringRequesty Detail SIRI-SM StopMonitoringSubscription & StopMonitoringRequest SubscriptionRequest RequestTimestamp[1] : dateTime Address[0..1] : anyURI RequestorRef[1] : ParticipantCode MessageIdentifer[0..1] : string ConsumerAddress[0..1] : anyURI SubscriptionFilterIdentifier[1] : NMTOKEN SubscriptionContext[0..1] context participant 1 1 1 requests © 2007 SIRI 1 AbstractSubscriptionRequest SubscriberRef[1] : ParticipantCode SubscriptionIdentifier[1] InitialTerminationTime[1] 0..1 0..* Participant SubscriptionContext 1 StopMonitoringSubscriptionRequest HeartbeatInterval[0..1] : duration participant StopMonitoringRequest[1] : StopMonitoringRequest StopMonitoringSubscriptionPolicies[0..1] : StopMonitoringSubscriptionPolicies Extensions[0..1] : any 1 1 policies ServiceRequest RequestContext[1] : RequestContext RequestTimestamp[1] : dateTime Address[1] : anyURI RequestorRef[1] : ParticipantCode MessageIdentifer[1] : string 1 request requests AbstractRequest RequestTimestamp[1] : dateTime MessageIdentifier[0..1] : string 1 0..1 0..* 1 StopMonitoringSubscriptionPolicies context 1 StopMonitoringRequest 0..1 IncrementalUpdates[1] : boolean ChanegBeforeUpdate[1] : duration StopMonitoringTopics[0..1] : StopMonitoringTopics StopMonitoringPolicies[0..1] : StopMonitoringPolicies Extensions[0..1] : any RequestContext policies topics1 1 0..1 StopMonitoringTopics StopMonitoringPolicies PreviewInterval[0..1] : duration StartTime[0..1] : dateTime MonitoringRef[0..1] : MonitoringCode OperatorRef[0..1] : OperatorCode LineRef[0..1] : LineCode DirectionRef[0..1] : DirectionCode DestinationRef[0..1] : DestinationCode StopVisitTypes[1] : StopVisitTypesEnum Language[0..1] : lang MaximumStopVisits[0..1] : positiveInteger MinimumStopVisitsPerLine[0..1] : positiveInteger MaximumTextLength[0..1] : positiveInteger StopMonitoringDetailLevel[0..1] : SmDetailLevelEnum MaximumNumberOfPreviousCalls[0..1] : positiveInteger MaximumNumberOfOnwardCalls[0..1] : positiveInteger monitor Monitor 1 0..1 operator Operator 1 0..1 line Line 1 1 direction 0..1 1 directions Direction 0..* 0..1 0..1 «enumeration» StopVisitTypesEnum +all +arrivals +departures «enumeration» SmDetailLevelEnum +minimum +basic +normal +calls +full Figure 7-2 StopMonitoringRequest - Detail © Kizoom 2006- 2007 Page 23 SIRI Functional Services - UML Diagrams 7.2 Delivery 7.2.1 StopMonitoringDelivery Summary 1 1 ProducerResponse Participant errors 1 deliveries 1 SIRI-SM Summary StopMonitoringDelivery ErrorCondition ServiceDelivery Error Description 0..1 © 2006 SIRI 0..* notice cancellations StopMonitoringDelivery version[1] Note[0..1] Extensions[0..1] 1 1 cancelations 1 1 visits cancels cancels 0..1 1 Direction 0..1 0..* 1 0..1 1 line notices 0..* 0..* MonitoredStopVisitCancellation StopLineNotice montor MonitoredStopVisit 0..* 0..1 MonitoringRef[1] CleardownRef[0..1] MonitoredVehicleJourney[1] StopVisitNote[0..1] Extensions[0..1] 1 Monitor montor 0..1 0..1 1 StopLineNoticeCancellation MonitoringRef[1] VisitNumber[1] LineRef[1] DirectionRef[1] VehicleJourneyRef[0..1] ClearDownRef[0..1] JourneyPatternInfo[0..1] Reason[0..1] Extensions[0..1] MonitoringRef[1] LineRef[1] DirectionRef[1] LineNote[0..1] SituationRef[0..1] Extensions[0..1] MonitoringRef[1] LineRef[1] DirectionRef[1] Extensions[0..1] 1 Route route journey pattern 0..1 line 1 1 line 1 1 JourneyPatternInfo 1 Line 0..1 pattern info 1 VehicleJourneyInfo 1 0..1 journey info 1 StopPoint AbstractMonitoredCall 0..1 stop 1 StopPointRef[0..1] VisitNumber[0..1] Order[0..1] StopPointName[0..1] 0..* 1 previous journey 1 0..1 MonitoredVehicleJourney 0..1 DataFrameRef[1] DatedVehicleJourneyRef[1] 1 0..1 1 ServiceInfo FramedVehicleJourneyRef DatedVehicleJourney JourneyPattern 0..1 pattern journey 1 MonitoredVehicleJourneyIdentity[1] JourneyPatternInfo[1] VehicleJourneyInfo[1] DisruptionInfo[0..1] JourneyProgress[0..1] TrainBlockPart[0..1] OperationalInfo[0..1] PreviousCalls[0..*] MonitoredCall[0..1] OnwardCalls[0..*] IsCompleteCallSequence[0..1] Extensions[0..1] current 0..1 MonitoredJourneyIdentity identity 1 1 LineRef[0..1] DirectionRef[0..1] FramedVehicleJourneyRef[1..1] 1..1 disruption 1 onward 1 0..* 1 0..1 OnwardCall PreviousCall VehicleAtStop[0..1] ArrivalTimes[0..1] DepartureTimes[0..1] Extensions[0..1] MonitoredCall VehicleAtStop[0..1] VehicleLocationAtStop[0..1] ReversesAtStop[0..1] PlatformTraversal[0..1] SignalStatus[0..1] CallNote[0..1] Disruption[0..1] ArrivalTimes[0..1] ArrivalInfo[0..1] DepartureTimes[0..1] DepartureInfo[0..1] HeadwayInfo[0..1] Extensions[0..1] VehicleAtStop[0..1] TimingPoint[0..1] AimedArrivalTimes[0..1] ArrivalInfo[0..1] AimedDepartureTimes[0..1] DepartureInfo[0..1] HeadwayInfo[0..1] Extensions[0..1] DisruptionInfo SituationRef[0..1] FacilityChange[0..1] 1 situation 0..1 0..1 disruption Situation 1 Figure 7-3 StopMonitoringDelivery - Summary © Kizoom 2006- 2007 Page 24 SIRI Functional Services - UML Diagrams 7.2.2 StopMonitoringDelivery Detail 1 ProducerResponse 1 participant ResponseTimeStamp[1] : dateTime ProducerRef[0..1] : ParticipantCode Address[0..1] : EndPointAddress ResponseMessageIdentifier[0..1] : MessageQualifier RequestMessageRef[0..1] : MessageQualifier Participant SIRI-SM StopMonitoringDelivery © 2006 SIRI AbstractServiceDelivery 1 0..1 ResponseTimeStamp[1] : dateTime RequestMesageRef[0..1] : MessageQualifier SubscriberRef[0..1] : ParticipantCode SubscriptionFilterRef[0..1] : SubscriptionFilterCode SubscriptionRef[0..1] : SubscriptionCode Address[0..1] : EndPointAddress ResponseMessageIdentifier[0..1] : MessageQualifier 0..11 Status[0..1] : boolean ErrorCondition[0..1] : ErrorCondition ValidUntil[0..1] : dateTime ShortestPossibleCycle[0..1] : positiveDuration ServiceDelivery Status[0..1] : boolean ErrorCondition[1] : ErrorCondition MoreData[1] : boolean ErrorCondition Error[1] : AbstractError Description[1] : ErrorDescription deliveries 1 0..* 1 StopMonitoringDelivery 1 AbstractItem version[1] : VersionString Note[0..1] : populatedString Extensions[0..1] : any 1 1 RecordedAtTime[1] : dateTime cancelations visits notice cancellations AbstractIdentifiedItem AbstractReferencedItem IdentifiedItemCode[0..1] : IdentifiedItemCode IdentifiedItemRef[0..1] : IdentifiedItemCode 0..* line notices 0..* MonitoredStopVisitCancellation cancels MonitoredStopVisit MonitoringRef[1] : MonitoringCode CleardownRef[0..1] : CleardownCode MonitoredVehicleJourney[1] : MonitoredVehicleJourney StopVisitNote[0..1] : populatedString Extensions[0..1] : any 1 1 1 0..1 1 Monitor 0..* 0..1 MonitoringRef[1] : MonitoringCode VisitNumber[1] : VisitNumber LineRef[1] : LineCode DirectionRef[1] : DirectionCode VehicleJourneyRef[0..1] : FramedVehicleJourneyRef ClearDownRef[0..1] : CleardownCode JourneyPatternInfo[0..1] : JourneyPatternInfo Reason[0..1] : populatedString Extensions[0..1] : any 0..* 0..1 journey StopLineNotice 1 1 Situation MonitoringRef[1] : MonitoringCode LineRef[1] : LineCode DirectionRef[1] : DirectionCode LineNote[0..1] : populatedString SituationRef[0..1] : SituationCode Extensions[0..1] : any MonitoredVehicleJourney MonitoredVehicleJourneyIdentity[1] : MonitoredJourneyIdentity JourneyPatternInfo[1] : JourneyPatternInfo VehicleJourneyInfo[1] : VehicleJourneyInfo DisruptionInfo[0..1] : DisruptionInfo JourneyProgress[0..1] : ProgressInfo TrainBlockPart[0..1] : TrainBlockPart OperationalInfo[0..1] : OperationalInfo PreviousCalls[0..*] : PreviousCall MonitoredCall[0..1] : MonitoredCall OnwardCalls[0..*] : OnwardCall IsCompleteCallSequence[0..1] : boolean Extensions[0..1] : any 1 0..* PreviousCall 1 0..1 MonitoredCall 1 cancels 0..1 1 MonitoringRef[1] : MonitoringCode LineRef[1] : LineCode DirectionRef[1] : DirectionCode Extensions[0..1] : any Direction 1 0..1 1 StopLineNoticeCancellation 1 0..1 Line See separate MonitoredvehicleJourney Diagram for details 0..* OnwardCall Figure 7-4 StopMonitoringDelivery – Detail © Kizoom 2006- 2007 Page 25 SIRI Functional Services - UML Diagrams 7.2.3 MonitoredVehicleJourney 7.2.3.1 MonitoredVehicleJourney Summary run 1 0..1 pattern JourneyPattern block 1 1 DatedVehicleJourney route 1 0..1 Route JourneyPatternInfo pattern JourneyPatternRef[0..1] VehicleMode[0..1] RouteRef[0..1] PublishedLineName[0..1] DirectionName[0..1] ExternalLineRef[0..1] 0..1 LineRef[0..1] DirectionRef[0..1] FramedVehicleJourneyRef[1..1] identity VehicleJourneyInfo pattern info 1 1 origin ServiceInfo 0..1 0..1journey info 1 1 0..1 0..1 ServiceFeature 0..* 0..1 1 times 0..1 0..1 1 ProgressInfo progress 1 0..1 «enumeration» OccupancyEnum +full +seatsAvailable +standingAvailable 0..* VehicleAtStop[0..1] TimingPoint[0..1] AimedArrivalTimes[0..1] ArrivalInfo[0..1] AimedDepartureTimes[0..1] DepartureInfo[0..1] HeadwayInfo[0..1] Extensions[0..1] * 1 1 0..1 0..1 arrival MonitoredCall Monitored[0..1] MonitoringError[0..1] InCongestion[0..1] InPanic[0..1] PredictionInaccurate[0..1] disruption DataSource[0..1] ConfidenceLevel[0..1] VehicleLocation[0..1] Bearing[0..1] ProgressRate[0..1] Occupancy[0..1] Delay[0..1] ProgressStatus[0..1] 1 0..1 1 departure Situation AimedArrivalTime[0..1] 0..1 ExpectedArrivalTime[0..1] 0..1 situation AimedDepartureTimes 1 -AimedDepartureTime[0..1] -ExpectedDepartureTime[0..1] disruption 0..1 1 departure 0..1 1 DisruptionInfo 0..1 SituationRef[0..1] FacilityChange[0..1] DepartureInfo call 0..1 DepartureStatus[0..1] DeparturePlatformName[0..1] DepartureBoardingActivity[0..1] 0..1 HeadwayInfo CallInfo AimedHeadWayInterval[0..1] ExpectedHeadwayInterval[0..1] TimingPoint[0..1] BoardingStretch[0..1] RequestStop[0..1] DestinationDisplay[0..1] SIRI Summary MonitoredVehicleJourney 1 «enumeration» ProgressRateEnum noProgress slowProgress normalProgress fastProgress unknown AimedArrivalTimes VehicleAtStop[0..1] VehicleLocationAtStop[0..1] «enumeration» ReversesAtStop[0..1] ArrivalActivityEnum PlatformTraversal[0..1] 1 SignalStatus[0..1] departure times +alighting CallNote[0..1] +noAlighting Disruption[0..1] +passThru 0..1 ArrivalTimes[0..1] ArrivalInfo[0..1] DepartureTimes DepartureTimes[0..1] DepartureInfo[0..1] AimedDepartureTime[0..1] HeadwayInfo[0..1] ActualDepartureTimes[0..1] Extensions[0..1] ExpectedDepartureTime[0..1] arrival times headway 0..1 1 1 1 AimedArrivalTime[0..1] ActualArrivalTimes[0..1] ExpectedArrivalTime[0..1] TrainBlockPart NumberOfBlockParts[0..1] TrainPartRef[0..1] PositionOfTrainBlockPart[0..1] OnwardCall ArrivalTimes 0..1 TrainPart current -VehicleAtStop[0..1] -ArrivalTimes[0..1] -DepartureTimes[0..1] -Extensions[0..1] 0..1 ArrivalInfo ArrivalStatus[0..1] ArrivalPlatformName[0..1] ArrivalBoardingActivity[0..1] train onward PreviousCall 1 0..1 0..1 1 1 0..1 Operator Vehicle 1 train block MonitoredVehicleJourneyIdentity[1] JourneyPatternInfo[1] VehicleJourneyInfo[1] DisruptionInfo[0..1] JourneyProgress[0..1] TrainBlockPart[0..1] OperationalInfo[0..1] PreviousCalls[0..*] MonitoredCall[0..1] OnwardCalls[0..*] IsCompleteCallSequence[0..1] Extensions[0..1] -StopPointRef[0..1] -VisitNumber[0..1] -Order[0..1] -StopPointName[0..1] VehicleFeature 1 1 1 0..11 StopPoint CourseOfJourney 0..1 vehicle 0..1 1 1 AbstractMonitoredCall 0..1 0..1 1 operational previous -OperatorRef[0..1] -ProductCategoryRef[0..1] -ServiceFeatureRef[0..*] -VehicleFeatureRef[0..*] run 1 1 MonitoredVehicleJourney 1 destination 1 Block 0..1 OperationalInfo 1 journey BlockRef[0..1] CourseOfJourneyRef[0..1] VehicleRef[0..1] 1 1 1..1 1 block 0..1 DataFrameRef[1] DatedVehicleJourneyRef[1] 1 Line MonitoredJourneyIdentity 0..1 ServiceInfo[0..1] OriginRef[0..1] DestinationName[0..1] OriginShortName[0..1] Via[0..*] DestinationRef[0..1] DestinationName[0..1] DestinationShortName[0..1] VehicleJourneyNote[0..1] JourneyNote[0..1] HeadwayService[0..1] OriginAimedDepartureTime[0..1] DestinationAimedDepartureTime[0..1] FramedVehicleJourneyRef 0..1 1 DataFrame 1 1journey 0..1 «enumeration» DepartureActivityEnum +boarding +noBoarding +passThru «enumeration» TimeStatusEnum +early +onTime +delayed +arrived +cancelled +noReport © 2006 SIRI © Kizoom 2006- 2007 Page 26 SIRI Functional Services - UML Diagrams 7.2.3.2 MonitoredVehicleJourney Detail journey MonitoredJourneyIdentity FramedVehicleJourneyRef LineRef[0..1] : LineCode DirectionRef[0..1] : DirectionCode FramedVehicleJourneyRef[1..1] : FramedVehicleJourneyRef 1 DatedVehicleJourney journey 1 DataFrameRef[1] : DataFrameCode DatedVehicleJourneyRef[1] : DatedVehicleJourneyCode 1 1 ProgressInfo TrainBlockPart 1 JourneyPattern Monitored[0..1] : boolean NumberOfBlockParts[0..1] : positiveInteger 1..1 0..1 Route MonitoringError[0..1] : NMTOKEN TrainPartRef[0..1] : TrainPartCode 0..1 InCongestion[0..1] : boolean PositionOfTrainBlockPart[0..1] : populatedString 1 0..1 0..1 1 1 0..1 InPanic[0..1] : boolean Line 0..1 PredictionInaccurate[0..1] : boolean Block DataSource[0..1] : string JourneyPatternInfo TrainPart 1 ConfidenceLevel[0..1] : boolean identity JourneyPatternRef[0..1] : JourneyPatternCode VehicleLocation[0..1] : Location train block VehicleMode[0..1] : VehicleModesEnum Bearing[0..1] : Bearing OperationalInfo RouteRef[0..1] : RouteCode 0..1 ProgressRate[0..1] : ProgressRateEnum BlockRef[0..1] : BlockCode PublishedLineName[0..1] : populatedString Occupancy[0..1] : OccupancyEnum CourseOfJourneyRef[0..1] : CourseOfJourneyCode DirectionName[0..1] : populatedString Delay[0..1] : DurationType VehicleRef[0..1] : VehicleCode ExternalLineRef[0..1] : LineCode ProgressStatus[0..1] : populatedString vehicle 1 0..1 1 1 1 VehicleJourneyInfo 0..1 1 run ServiceInfo[0..1] : ServiceInfo pattern info OriginRef[0..1] : JourneyPlaceCode MonitoredVehicleJourney DestinationName[0..1] : populatedString 0..1 1 MonitoredVehicleJourneyIdentity[1] : MonitoredJourneyIdentity OriginShortName[0..1] : populatedString JourneyPatternInfo[1] : JourneyPatternInfo Via[0..*] : populatedString Vehicle 0..1 VehicleJourneyInfo[1] : VehicleJourneyInfo DestinationRef[0..1] : DestinationCode 1 DestinationName[0..1] : populatedString 1 DisruptionInfo[0..1] : DisruptionInfo JourneyProgress[0..1] : ProgressInfo DestinationShortName[0..1] : populatedString 0..1 CourseOfJourney TrainBlockPart[0..1] : TrainBlockPart VehicleJourneyNote[0..1] : populatedString JourneyNote[0..1] : populatedString HeadwayService[0..1] : boolean OriginAimedDepartureTime[0..1] : dateTime DestinationAimedDepartureTime[0..1] : dateTime 0..1 1 0..10..1 1 ServiceInfo 1 StopPoint 0..11 1 0..1 Operator OperationalInfo[0..1] : OperationalInfo PreviousCalls[0..*] : PreviousCall MonitoredCall[0..1] : MonitoredCall OnwardCalls[0..*] : OnwardCall IsCompleteCallSequence[0..1] : boolean Extensions[0..1] : any 1 0..* disruption 1 0..1 TimingPoint[0..1] : boolean BoardingStretch[0..1] : boolean RequestStop[0..1] : boolean DestinationDisplay[0..1] : populatedString arrival 0..1 1 0..1 0..* 0..1 OnwardCall MonitoredCall CallInfo VehicleAtStop[0..1] : boolean VehicleLocationAtStop[0..1] : Location ReversesAtStop[0..1] : boolean PlatformTraversal[0..1] : boolean 1 1 SignalStatus[0..1] : NMTOKEN CallNote[0..1] : populatedString Disruption[0..1] : DisruptionInfo ArrivalTimes[0..1] : ArrivalTimes ArrivalInfo[0..1] : ArrivalInfo DepartureTimes[0..1] : DepartureTimes DepartureInfo[0..1] : DepartureInfo 1 HeadwayInfo[0..1] : HeadwayInfo headway Extensions[0..1] : any VehicleAtStop[0..1] : boolean TimingPoint[0..1] : boolean AimedArrivalTimes[0..1] : AimedArrivalTimes ArrivalInfo[0..1] : ArrivalInfo AimedDepartureTimes[0..1] : AimedDepartureTimes DepartureInfo[0..1] : DepartureInfo HeadwayInfo[0..1] : HeadwayInfo Extensions[0..1] : any departure departure 1 1 1 0..1 1 0..1 1 1 0..1 ArrivalInfo 0..11 ArrivalStatus[0..1] : TimeStatusEnum ArrivalPlatformName[0..1] : populatedString ArrivalBoardingActivity[0..1] : ArrivalActivityEnum 0..1 arrival times onward 1 SituationRef[0..1] : SituationCode FacilityChange[0..1] : FacilityChange 1 1 0..1 DisruptionInfo StopPointRef[0..1] : StopPointCode VisitNumber[0..1] : VisitNumber Order[0..1] : positiveInteger StopPointName[0..1] : populatedString 0..1 PreviousCall Situation 1 1 AbstractMonitoredCall VehicleAtStop[0..1] : boolean ArrivalTimes[0..1] : ArrivalTimes DepartureTimes[0..1] : DepartureTimes Extensions[0..1] : any 1 DepartureInfo departure DepartureStatus[0..1] : TimeStatusEnum DeparturePlatformName[0..1] : populatedString DepartureBoardingActivity[0..1] : DepartureActivityEnum 0..1 ArrivalTimes 0..1 AimedArrivalTime[0..1] : dateTime ActualArrivalTimes[0..1] : dateTime ExpectedArrivalTime[0..1] : dateTime times HeadwayInfo DepartureTimes AimedHeadWayInterval[0..1] : positiveDuration ExpectedHeadwayInterval[0..1] : positiveDuration 0..1 AimedDepartureTime[0..1] : dateTime ActualDepartureTimes[0..1] : dateTime ExpectedDepartureTime[0..1] : dateTime 0..1 SIRI MonitoredVehicleJourney © 2006 SIRI © Kizoom 2006- 2007 0..1 AimedDepartureTimes AimedArrivalTimes AimedArrivalTime[0..1] : dateTime ExpectedArrivalTime[0..1] : dateTime AimedDepartureTime[0..1] : dateTime * ExpectedDepartureTime[0..1] : dateTime arrival Page 27 SIRI Functional Services - UML Diagrams 8 SIRI VehicleMonitoring (VM) The Vehicle Monitoring Service reports the position of a vehicle or group of vehicles making monitored journeys in real-time. It can be used to monitor the progress of vehicles, to provide information for systems which present visualisations of the movement of vehicles, for example on maps, lists or line diagrams, and to exchange information about roaming vehicles with other control centres. The Topics allow a Consumer system to specify that only vehicle movements for a specific Vehicle Monitoring group, Line, or Line Direction or Vehicle are to be returned. The Request Policies allow a Consumer system to control the amount of data returned The Subscription Policies allow a Consumer system to control the change threshold for update. 8.1 Subscription & Request 8.1.1 VehicleMonitoringRequest Summary participant 1 Participant SIRI-VM Summary VehicleMonitoringSubscription & VehicleMonitoringRequest 1 SubscriptionRequest 1 requests 0..* © 2007 SIRI 1 participant VehicleMonitoringSubscriptionRequest 1 VehicleMonitoringRequest[1] VehicleMonitoringSubscriptionPolicies[0..1] Extensions[0..1] request ServiceRequest 1 policies 1 VehicleMonitoringSubscriptionPolicies 1 0..1 IncrementalUpdates[1] ChanegBeforeUpdate[1] VehicleMonitoringRequest VehicleMonitoringTopics[0..1] VehicleMonitoringPolicies[0..1] Extensions[0..1] policies 1 topics 1 VehicleMonitoringPolicies Language[0..1] MaximumVehicles[0..1] VehicleMonitoringDetailLevel[0..1] 0..1 monitor VehicleMonitoringTopics VehicleMonitor 0..1 0..1 1 vehicle Vehicle 0..1 VehicleMonitoringRef[0..1] VehicleRef[0..1] LineRef[0..1] DirectionRef[0..1] Line directions 1 1 0..* Direction Figure 8-1 StopMonitoringRequest - Summary © Kizoom 2006- 2007 Page 28 SIRI Functional Services - UML Diagrams 8.1.2 VehicleMonitoringRequest Detail SIRI-VM VehicleMonitoringSubscription & VehicleMonitoringRequest SubscriptionRequest RequestTimestamp[1] : dateTime Address[0..1] : anyURI RequestorRef[1] : ParticipantCode MessageIdentifer[0..1] : string ConsumerAddress[0..1] : anyURI SubscriptionFilterIdentifier[1] : NMTOKEN SubscriptionContext[0..1] participant 1 requests © 2007 SIRI 1 AbstractSubscriptionRequest SubscriberRef[1] : ParticipantCode SubscriptionIdentifier[1] InitialTerminationTime[1] 1 context 1 Participant 0..* 0..1 1 SubscriptionContext HeartbeatInterval[0..1] : duration participant 1 VehicleMonitoringSubscriptionRequest VehicleMonitoringRequest[1] : VehicleMonitoringRequest VehicleMonitoringSubscriptionPolicies[0..1] : VehicleMonitoringSubscriptionPolicies Extensions[0..1] : any ServiceRequest 1 1 RequestContext[1] : RequestContext RequestTimestamp[1] : dateTime Address[1] : anyURI RequestorRef[1] : ParticipantCode MessageIdentifer[1] : string context 1 policies VehicleMonitoringSubscriptionPolicies requests request 0..1 IncrementalUpdates[1] : boolean ChanegBeforeUpdate[1] : duration 1 AbstractRequest RequestTimestamp[1] : dateTime MessageIdentifier[0..1] : string 0..1 0..* 1 RequestContext VehicleMonitoringRequest 1 VehicleMonitoringTopics[0..1] : VehicleMonitoringTopics VehicleMonitoringPolicies[0..1] : StopMonitoringPolicies Extensions[0..1] : VehicleMonitoringPolicies topics VehicleMonitor 1 monitor 0..1 Vehicle vehicle 1 0..1 1 policies 0..1 0..1 VehicleMonitoringTopics VehicleMonitoringPolicies VehicleMonitoringRef[0..1] : MonitoringCode VehicleRef[0..1] : VehicleCode LineRef[0..1] : LineCode DirectionRef[0..1] : DirectionCode Language[0..1] : lang MaximumVehicles[0..1] : positiveInteger VehicleMonitoringDetailLevel[0..1] : VmDetailLevelEnum line 1 Line 1 1 direction 0..1 directions0..1 Direction 0..* «enumeration» VmDetailLevelEnum minimum basic normal calls Figure 8-2 StopMonitoringRequest - Detail © Kizoom 2006- 2007 Page 29 SIRI Functional Services - UML Diagrams 8.2 Delivery 8.2.1 VehicleMonitoringDelivery Summary ProducerResponse errors ServiceDelivery deliveries ErrorCondition 0..1 1 SIRI-VM Summary VehicleMonitoringDelivery © 2006 SIRI 1 0..* VehicleMonitoringDelivery version[1] : VersionString Extensions[1] : any 1 activity cancellation 1 0..* 0..* monitor VehicleActivity ValidUntilTime[1] VehicleMonitoringRef[1] ProgressBetweenStops[0..1] MonitoredVehicleJourney[1] VehicleActivityNote[0..*] Extensions[0..1] 0..1 monitor VehicleMonitor 0..1 1 1 VehicleActivityCancellation VehicleMonitoringRef[1] VehicleJourneyRef[1] LineRef[1] DirectionRef[1] JourneyPatternInfo[0..1] Reason[0..1] Extensions[0..1] cancels 1 1 0..1 0..1 journey 1 VehicleJourney 1 line 0..1 journey 1 vehicle journeys 0..1 DatedVehicleJourney Route MonitoredVehicleJourney route 1 0..11 pattern 1 1 1 FramedVehicleJourneyRef journey 0..1 JourneyPattern journey JourneyPatternInfo MonitoredVehicleJourneyIdentity[1] JourneyPatternInfo[1] VehicleJourneyInfo[1] identity 1 DisruptionInfo[0..1] JourneyProgress[0..1] 0..1 pattern info TrainBlockPart[0..1] 1..1 OperationalInfo[0..1] 1 1 PreviousCalls[0..*] MonitoredCall[0..1] OnwardCalls[0..*] progress 1 IsCompleteCallSequence[0..1] Extensions[0..1] 1 MonitoredJourneyIdentity 1 1 line 0..1 LineRef DirectionRef FramedVehicleJourneyRef Line 1 current 0..* direction Direction 0..1 0..1 1 directions 1 journey info 0..1 0..1 VehicleJourneyInfo ProgressInfo «enumeration» OccupancyEnum full seatsAvailable standingAvailable «enumeration» ProgressRateEnum noProgress slowProgress normalProgress fastProgress unknown Monitored[0..1] MonitoringError[0..1] InCongestion[0..1] InPanic[0..1] PredictionInaccurate[0..1] DataSource[0..1] ConfidenceLevel[0..1] VehicleLocation[0..1] Bearing[0..1] ProgressRate[0..1] Occupancy[0..1] Delay[0..1] ProgressStatus[0..1] «enumeration» TimeStatusEnum early onTime delayed arrived cancelled noReport MonitoredCall VehicleAtStop[0..1] VehicleLocationAtStop[0..1] ReversesAtStop[0..1] PlatformTraversal[0..1] SignalStatus[0..1] CallNote[0..1] Disruption[0..1] ArrivalTimes[0..1] ArrivalInfo[0..1] DepartureTimes[0..1] DepartureInfo[0..1] HeadwayInfo[0..1] Extensions[0..1] departure 0..1 1 ServiceInfo[0..1] OriginRef[0..1] DestinationName[0..1] OriginShortName[0..1] Via[0..*] DestinationRef[0..1] DestinationName[0..1] DestinationShortName[0..1] VehicleJourneyNote[0..1] JourneyNote[0..1] HeadwayService[0..1] OriginAimedDepartureTime[0..1] DestinationAimedDepartureTime[0..1] info 0..1 1 ServiceFeature service feature ServiceInfo DepartureInfo DepartureStatus[0..1] DeparturePlatformName[0..1] DepartureBoardingActivity[0..1] Operator OperatorRef[0..1] ProductCategoryRef[0..1] ServiceFeatureRef[0..*] VehicleFeatureRef[0..*] 0..1 operator 1 1 1 0..1 vehicle feature 0..1 VehicleFeature Figure 8-3 StopMonitoringDelivery - Summary © Kizoom 2006- 2007 Page 30 SIRI Functional Services - UML Diagrams 8.2.2 VehicleMonitoringDelivery Detail ProducerResponse ResponseTimeStamp[1] : dateTime ProducerRef[0..1] : ParticipantCode Address[0..1] : EndPointAddress ResponseMessageIdentifier[0..1] : MessageQualifier RequestMessageRef[0..1] : MessageQualifier SIRI-VM VehicleMonitoringDelivery © 2006 SIRI 11 ServiceDelivery Participant 1 Status[0..1] : boolean ErrorCondition[1] : ErrorCondition MoreData[1] : boolean 1 AbstractServiceDelivery ResponseTimeStamp[1] : dateTime RequestMesageRef[0..1] : MessageQualifier SubscriberRef[0..1] : ParticipantCode SubscriptionFilterRef[0..1] : SubscriptionFilterCode SubscriptionRef[0..1] : SubscriptionCode Address[0..1] : EndPointAddress ResponseMessageIdentifier[0..1] : MessageQualifier Status[0..1] : boolean ErrorCondition[0..1] : ErrorCondition ValidUntil[0..1] : dateTime ShortestPossibleCycle[0..1] : positiveDuration 1 ErrorCondition 1 0..1 Error[1] : AbstractError Description[1] : ErrorDescription 0..1 1 0..* VehicleMonitoringDelivery 1 version[1] : VersionString Extensions[1] : any AbstractItem RecordedAtTime[1] : dateTime 1 AbstractIdentifiedItem AbstractReferencedItem IdentifiedItemCode[0..1] : IdentifiedItemCode IdentifiedItemRef[0..1] : IdentifiedItemCode 0..* 0..* 0..1 VehicleMonitor VehicleActivity 0..1 ValidUntilTime[1] : dateTime VehicleMonitoringRef[1] : MonitoringCode ProgressBetweenStops[0..1] : ProgressBetweenStops MonitoredVehicleJourney[1] : MonitoredVehicleJourney VehicleActivityNote[0..*] : populatedString Extensions[0..1] : any 1 0..1 1 1 VehicleActivityCancellation VehicleMonitoringRef[1] : VehicleMonitoringCode VehicleJourneyRef[1] : FramedVehicleJourneyRef LineRef[1] : LineCode 1 DirectionRef[1] : DirectionCode 0..1 JourneyPatternInfo[0..1] : JourneyPatternInfo Reason[0..1] : populatedString 0..1 Extensions[0..1] : any cancels 1 1 VehicleJourney 1 1 ProgressBetweenStops Line -LinkDistance[0..1] : decimal -Percentage[0..1] : decimal pattern info 1 0..1 MonitoredVehicleJourney MonitoredVehicleJourneyIdentity[1] : MonitoredJourneyIdentity JourneyPatternInfo[1] : JourneyPatternInfo VehicleJourneyInfo[1] : VehicleJourneyInfo DisruptionInfo[0..1] : DisruptionInfo JourneyProgress[0..1] : ProgressInfo TrainBlockPart[0..1] : TrainBlockPart OperationalInfo[0..1] : OperationalInfo PreviousCalls[0..*] : PreviousCall MonitoredCall[0..1] : MonitoredCall OnwardCalls[0..*] : OnwardCall IsCompleteCallSequence[0..1] : boolean Extensions[0..1] : any 1 1 0..* PreviousCall 0..1 MonitoredCall JourneyPatternInfo 0..1 journey info VehicleJourneyInfo 0..1 1 disruption DisruptionInfo 0..1 1 operational OperationalInfo 0..1 1 See separate MonitoredvehicleJourney Diagram for details 1 0..* «datatype» VehicleMonitoringCode OnwardCall Figure 8-4 StopMonitoringDelivery - Detail © Kizoom 2006- 2007 Page 31 SIRI Functional Services - UML Diagrams 9 SIRI ConnectionTimetable (CT) The SIRI Connection Timetable Service is used for the exchange of schedule data for potential feeder vehicle journeys to a connection zone. It is used in conjunction with the SIRI Connection Monitoring Service. The service is location-related, i.e. all requests and replies relate to specific connection links, as identified by connection link identifiers. The Topics allow a Consumer system to specify that only Connection Timetables for a specific Connection Link, Line, or Line Direction or Vehicle are to be returned. 9.1 Subscription & Request 9.1.1 ConnectionTimetableRequest Summary participant 1 Participant SIRI-CT Summary ConnectionTimetableSubscription & ConnectionTimetableRequest 1 SubscriptionRequest 1 deliveries © 2006 SIRI 1 participant 0..* 1 policies ConnectionTimetableSubscriptionRequest ConnectionTimetableRequest[1] ConnectionTimetableSubscriptionPolicies[0..1] Extensions[0..1] ServiceRequest request 0..1 1 ConnectionTimetableSubscriptionPolicies 1 1 ConnectionTimetableRequest policies ConnectionTimetableTopics[0..1] ConnectionTimetablePolicies[0..1] Extensions[0..1] 1 0..1 ConnectionTimetablePolicies Language[1] 1 topics 0..1 line Line ConnectionTimetableTopics link ConnectionLink 0..1 1 PreviewInterval[0..1] ConnectionLinkRef[0..1] LineRef[0..1] DirectionRef[0..1] 0..1 1 directions 1 0..* 1 direction Direction 0..1 Figure 9-1 ConnectionTimetableRequest - Summary © Kizoom 2006- 2007 Page 32 SIRI Functional Services - UML Diagrams 9.1.2 ConnectionTimetableRequest Detail SIRI-CT ConnectionTimetableSubscription & ConnectionTimetableRequest SubscriptionRequest RequestTimestamp[1] : dateTime Address[0..1] : anyURI RequestorRef[1] : ParticipantCode MessageIdentifer[0..1] : string ConsumerAddress[0..1] : anyURI SubscriptionFilterIdentifier[1] : NMTOKEN SubscriptionContext[0..1] © 2006 SIRI 1 deliveries AbstractSubscriptionRequest SubscriberRef[1] : ParticipantCode SubscriptionIdentifier[1] InitialTerminationTime[1] participant 1 1 0..* Participant participant 1 1 ConnectionTimetableSubscriptionRequest ServiceRequest RequestContext[1] : RequestContext RequestTimestamp[1] : dateTime Address[1] : anyURI RequestorRef[1] : ParticipantCode MessageIdentifer[1] : string ConnectionTimetableRequest[1] : ConnectionTimetableRequest ConnectionTimetableSubscriptionPolicies[0..1] : ConnectionTimetableSubscriptionPolicies Extensions[0..1] : any 1 request AbstractRequest RequestTimestamp[1] : dateTime MessageIdentifier[0..1] : string ConnectionTimetableRequest policies ConnectionTimetableTopics[0..1] : ConnectionTimetableTopics ConnectionTimetablePolicies[0..1] : ConnectionTimetablePolicies Extensions[0..1] : any 0..1 1 ConnectionTimetablePolicies 1topics ConnectionLink 0..1 1 ConnectionTimetableTopics 0..1 -PreviewInterval[0..1] : HalfOpenTimestampRange -ConnectionLinkRef[0..1] : ConnectionLinkCode -LineRef[0..1] : LineCode -DirectionRef[0..1] : DirectionCode 0..1 ConnectionTimetableSubscriptionPolicies 1 link 1 policies Language[1] : lang line Line directions 0..1 1 1 0..* 1 direction Direction 0..1 Figure 9-2 ConnectionTimetableRequest - Detail © Kizoom 2006- 2007 Page 33 SIRI Functional Services - UML Diagrams 9.2 Delivery 9.2.1 ConnectionTimetableDelivery Summary 1 1 participant ProducerResponse SIRI-CT Summary ConnectionTimetableDelivery Participant © 2006 SIRI errors ServiceDelivery ErrorCondition deliveries 1 0..1 1 0..* ConnectionTimetableDelivery 1 arrivals cancellations version[1] Extensions[1] 1 stops StopPointInSequence 0..* 2..* visit TimetabledFeederArrival 0..1 InterchangeRef[0..1] ConnectionLinkRef[1] interchange 1 StopPointInSequence[0..1] 1 FeederJourney[1] 1 0..1 AimedArrivalTime[1] Extensions[0..1] TimetabledFeederArrivalCancellation 1 InterchangeRef[0..1] ConnectionLinkRef[1] StopPointInSequence[0..1] LineRef[1] DirectionRef[1] VehicleJourneyRef[1] JourneyPatternInfo[0..1] Reason[0..1] Extensions[0..1] stop 1 Interchange link 0..1 visit StopPointRef[1] VisitNumber[0..1] Order[0..1] StopPointName[0..1] at 1 0..* 0..* 0..1 ConnectionLink 1 feeder 1 1 DataFrame frame 1 0..1 1 DataFrameRef[1] DatedVehicleJourneyRef[1] journey JourneyPattern 0..1 direction 0..1 direction 1 Line 0..1 1 1 mode JourneyPatternInfo JourneyPatternRef[0..1] VehicleMode[0..1] RouteRef[0..1] PublishedLineName[0..1] DirectionName[0..1] ExternalLineRef[0..1] route 0..1 pattern 1 disruption LineRef[1] DirectionRef[1] FramedVehicleJourneyRef[0..1] JourneyPatternInfo[0..1] VehicleJourneyInfo[0..1] DisruptionInfo[0..1] OperationalInfo[0..1] Monitored[0..1] AimedDepartureTime[0..1] Extensions[0..1] Association3 0..1 1 1 operational infro 1 ServiceInfo[0..1] OriginRef[0..1] DestinationName[0..1] OriginShortName[0..1] Via[0..*] DestinationRef[0..1] DestinationName[0..1] DestinationShortName[0..1] VehicleJourneyNote[0..1] JourneyNote[0..1] HeadwayService[0..1] OriginAimedDepartureTime[0..1] DestinationAimedDepartureTime[0..1] info 1 0..1 operator 0..1 1 DisruptionInfo OperationalInfo SituationRef[0..1] FacilityChange[0..1] BlockRef[0..1] CourseOfJourneyRef[0..1] VehicleRef[0..1] 1 0..1 Situation 0..1 Operator 0..1 Route Mode 1 1 1 InterchangeJourney 10..1 0..1 destination VehicleJourneyInfo 1 pattern origin 1 1 DatedVehicleJourney pattern 0..10..1 0..1 Direction journey 11 1 0..1 StopPoint to stop FramedVehicleJourneyRef ServiceInfo OperatorRef[0..1] ProductCategoryRef[0..1] ServiceFeatureRef[0..*] VehicleFeatureRef[0..*] 0..1 0..1 1 Vehicle 1 0..1 0..1 1 Block CourseOfJourney 0..1 1 ServiceFeature 1 0..1 1 VehicleFeature ProductCategory Figure 9-3 ConnectionTimetableDelivery - Summary © Kizoom 2006- 2007 Page 34 SIRI Functional Services - UML Diagrams 9.2.2 ConnectionTimetableDelivery Detail 1 ProducerResponse participant 1 ResponseTimeStamp[1] : dateTime ProducerRef[0..1] : ParticipantCode Address[0..1] : EndPointAddress ResponseMessageIdentifier[0..1] : MessageQualifier RequestMessageRef[0..1] : MessageQualifier SIRI-CT ConnectionTimetableDelivery Participant © 2006 SIRI ServiceDelivery Status[0..1] : boolean ErrorCondition[1] : ErrorCondition MoreData[1] : boolean AbstractServiceDelivery ResponseTimeStamp[1] : dateTime RequestMesageRef[0..1] : MessageQualifier SubscriberRef[0..1] : ParticipantCode SubscriptionFilterRef[0..1] : SubscriptionFilterCode SubscriptionRef[0..1] : SubscriptionCode Address[0..1] : EndPointAddress ResponseMessageIdentifier[0..1] : MessageQualifier Status[0..1] : boolean ErrorCondition[0..1] : ErrorCondition ValidUntil[0..1] : dateTime ShortestPossibleCycle[0..1] : positiveDuration 0..1 1 1 ErrorCondition 0..1 ConnectionTimetableDelivery 1 version[1] : VersionString Extensions[1] : any RecordedAtTime[1] : dateTime 1 StopPointInSequence AbstractIdentifiedItem TimetabledFeederArrival InterchangeRef[0..1] : InterchangeCode ConnectionLinkRef[1] : ConnectionLinkCode StopPointInSequence[0..1] : StopPointInSequence FeederJourney[1] : InterchangeJourney AimedArrivalTime[1] : dateTime Extensions[0..1] : any 0..1 frame 1 1 1 0..1 Interchange 0..1 0..1 ConnectionLink FramedVehicleJourneyRef DataFrameRef[1] : DataFrameCode DatedVehicleJourneyRef[1] : DatedVehicleJourneyCode 1 1 1 TimetabledFeederArrivalCancellation 1 1 Direction 1 1 0..1 AbstractReferencedItem IdentifiedItemRef[0..1] : IdentifiedItemCode 1 at 1 0..* 1 DataFrame DatedVehicleJourney 0..1 StopPointRef[1] : StopPointCode VisitNumber[0..1] : VisitNumber Order[0..1] : positiveInteger StopPointName[0..1] : populatedString visit IdentifiedItemCode[0..1] : IdentifiedItemCode 0..* feeder Error[1] : AbstractError Description[1] : ErrorDescription 0..* AbstractItem 1 1 to stop 0..1 StopPoint 1 InterchangeJourney LineRef[1] : LineCode DirectionRef[1] : DirectionCode FramedVehicleJourneyRef[0..1] : FramedVehicleJourneyRef JourneyPatternInfo[0..1] : JourneyPatternInfo VehicleJourneyInfo[0..1] : VehicleJourneyInfo DisruptionInfo[0..1] : DisruptionInfo OperationalInfo[0..1] : OperationalInfo Monitored[0..1] : boolean AimedDepartureTime[0..1] : dateTime Extensions[0..1] : any 0..* InterchangeRef[0..1] : InterchangeCode ConnectionLinkRef[1] : ConnectionLinkCode StopPointInSequence[0..1] : StopPointInSequence LineRef[1] : LineCode DirectionRef[1] : DirectionCode VehicleJourneyRef[1] : FramedVehicleJourneyRef JourneyPatternInfo[0..1] : JourneyPatternInfo Reason[0..1] : populatedString Extensions[0..1] : any 1 destination 0..1 0..1 origin 1 1 VehicleJourneyInfo ServiceInfo[0..1] : ServiceInfo OriginRef[0..1] : JourneyPlaceCode JourneyPattern 0..1 DestinationName[0..1] : populatedString 1 OriginShortName[0..1] : populatedString Line pattern0..1 Via[0..*] : populatedString 1 1 DestinationRef[0..1] : DestinationCode DestinationName[0..1] : populatedString JourneyPatternInfo DestinationShortName[0..1] : populatedString JourneyPatternRef[0..1] : JourneyPatternCode VehicleJourneyNote[0..1] : populatedString 0..1 pattern 1 1 1 VehicleMode[0..1] : VehicleModesEnum JourneyNote[0..1] : populatedString disruption RouteRef[0..1] : RouteCode HeadwayService[0..1] : boolean 0..1 PublishedLineName[0..1] : populatedString 0..1 OriginAimedDepartureTime[0..1] : dateTime operational infro DirectionName[0..1] : populatedString DestinationAimedDepartureTime[0..1] : dateTime info ExternalLineRef[0..1] : LineCode DisruptionInfo 0..1 mode 1 -SituationRef[0..1] : SituationCode Route Operator 1 0..1 1 1 -FacilityChange[0..1] : FacilityChange 0..1 0..1 situation 0..1 ServiceInfo Situation 0..1 1 Mode OperatorRef[0..1] : OperatorCode 0..1 block 1 ProductCategoryRef[0..1] : ProductCategoryCode OperationalInfo ServiceFeatureRef[0..*] : ServiceFeatureCode 1 Block 0..1 VehicleFeatureRef[0..*] : VehicleFeatureCode run 1 BlockRef[0..1] : BlockCode CourseOfJourneyRef[0..1] : CourseOfJourneyCode CourseOfJourney 0..1 VehicleRef[0..1] : VehicleCode Vehicle Figure 9-4 ConnectionTimetableDelivery - Detail © Kizoom 2006- 2007 Page 35 SIRI Functional Services - UML Diagrams 10 SIRI ConnectionMonitoring (CM) The SIRI Connection Monitoring Service exchanges information between different AVMS to coordinate the real-time arrival and departure of PTVs at an interchange through which passengers may make connecting journeys. The departure time of the outgoing ‘distributor’ (or ‘fetcher from’) service may be adjusted to accommodate delays in the incoming ‘feeder to’ service. The service ensures that the AVMS are in a position to receive all the necessary data concerning the feeder vehicles to allow connection monitoring and dispatch to be carried out. The operational methods of dispatch remain unaffected. The Service can be used in conjunction with the SIRI Connection Timetable Service to exchange scheduled arrival times in the target connection links. The Topics allow a Consumer system to specify that only Connection Timetables for a specific Connection Link, Line, or Line Direction or Vehicle are to be returned. 10.1 Subscription & Request 10.1.1 ConnectionMonitoringRequest Summary SIRI-CM Summary ConnectionMonitoringSubscription & ConnectionMonitoringRequest participant Participant 1 1 1 requests SubscriptionRequest participant 0..* © 2007 SIRI 1 ConnectionMonitoringSubscriptionRequest ConnectionMonitoringRequest[1] ConnectionMonitoringSubscriptionPolicies[0..1] Extensions[0..1] 1 requests ServiceRequest 0..* ConnectionMonitoringSubscriptionPolicies policies ConnectionMonitoringRequest line Language[1] ConnectionTimeFilter ConnectionJourneyFilter DatedVehicleJourneyRef[0..1] VisitNumber[0..1] TimetabledArrivalTime[0..1] 1 0..1 0..1 ConnectionMonitoringPolicies 1 LineRef[0..1] DirectionRef[0..1] EarliestArrivalTime[0..1] LatestArrivalTime[0..1] direction 0..1 1 ConnectionMonitoringTopics[0..1] ConnectionMonitoringPolicies[0..1] Extensions[0..1] 1 1 request 1 1 policies journey 1 0..1 DatedVehicleJourney pattern 1 1 directions Line 0..1 Direction 1 0..* JourneyPattern stops 0..1 1 link ConnectionLink 2..* StopPointInSequence stop 0..1 1 to stop 0..1 1 1 StopPoint Figure 10-1 ConnectionMonitoringRequest - Summary © Kizoom 2006- 2007 Page 36 SIRI Functional Services - UML Diagrams 10.1.2 ConnectionMonitoringRequest Detail SIRI-CM ConnectionMonitoringSubscription & ConnectionMonitoringRequest SubscriptionRequest RequestTimestamp[1] : dateTime Address[0..1] : anyURI RequestorRef[1] : ParticipantCode MessageIdentifer[0..1] : string ConsumerAddress[0..1] : anyURI SubscriptionFilterIdentifier[1] : NMTOKEN SubscriptionContext[0..1] participant 1 © 2007 SIRI requests 1 AbstractSubscriptionRequest SubscriberRef[1] : ParticipantCode SubscriptionIdentifier[1] InitialTerminationTime[1] 1 0..* Participant participant 1 1 ConnectionMonitoringSubscriptionRequest ConnectionMonitoringRequest[1] : ConnectionMonitoringRequest ConnectionMonitoringSubscriptionPolicies[0..1] : ConnectionMonitoringSubscriptionPolicies Extensions[0..1] : any ServiceRequest RequestContext[1] : RequestContext RequestTimestamp[1] : dateTime Address[1] : anyURI RequestorRef[1] : ParticipantCode MessageIdentifer[1] : string 1 1 request policies 0..1 1 requests AbstractRequest RequestTimestamp[1] : dateTime MessageIdentifier[0..1] : string ConnectionMonitoringSubscriptionPolicies 1 0..* ConnectionMonitoringRequest ConnectionMonitoringTopics[0..1] : ConnectionMonitoringTopics ConnectionMonitoringPolicies[0..1] : ConnectionMonitoringPolicies Extensions[0..1] : any 1 1 topics policies ConnectionMonitoringPolicies 0..1 Language[1] : lang 0..1 ConnectionMonitoringTopics -PreviewInterval[0..1] : duration -ConnectionLinkRef[0..1] : ConnectionLinkCode -ConnectionTimeFilter[0..1] : ConnectionTimeFilter -ConnectionJourneyFilter[0..1] : ConnectionTimeFilter 1 link ConnectionLink 0..1 1 1 time scope 1 journeys 0..1 to stop StopPoint ConnectionTimeFilter ConnectionJourneyFilter -LineRef[0..1] : LineCode -DirectionRef[0..1] : DirectionCode -EarliestArrivalTime[0..1] : dateTime -LatestArrivalTime[0..1] : dateTime -DatedVehicleJourneyRef[0..1] : DatedVehicleJourneyCode -VisitNumber[0..1] : integer -TimetabledArrivalTime[0..1] : dateTime 1 0..1 0..* stop direction 1 1 line 1 journey 0..1 1 DatedVehicleJourney StopPointInSequence 1 pattern Line 0..1 0..1 1 directions Direction 0..1 stops 2..* 0..* -StopPointRef[1] : StopPointCode -VisitNumber[0..1] : VisitNumber -Order[0..1] : positiveInteger -StopPointName[0..1] : populatedString JourneyPattern 1 Figure 10-2 ConnectionMonitoringRequest - Detail © Kizoom 2006- 2007 Page 37 SIRI Functional Services - UML Diagrams 10.2 Delivery 10.2.1 ConnectionMonitoringDelivery Summary 1 1 participant ProducerResponse SIRI-CM Summary ConnectionMonitoringDelivery Participant © 2007 SIRI errors ServiceDelivery ErrorCondition deliveries 0..1 1 1 deliveries 1 0..* 1 arrvals 0..* ConnectionMonitoringFeederDelivery ConnectionMonitoringDistributorDelivery version[1] Extensions[1] version[1] Extensions[1] 1 0..* cancellations 1 1 1 0..* MonitoredFeederArrival MonitoredFeederArrivalCancellation InterchangeRef[0..1] ConnectionLinkRef[1] StopPointInSequence[0..1] ClearDownRef[0..1] FeederJourney[1] VehicleAtStop[1] NumberOfTransferPassengers[0..1] ExpectedArrivalTime[1] Extensions[0..1] 1 cancels InterchangeRef[0..1] ConnectionLinkRef[1] StopPointInSequence[0..1] LineRef[1] DirectionRef[1] VehicleJourneyRef[1] JourneyPatternInfo[0..1] Reason[0..1] Extensions[0..1] 1 11interchange 0..1 0..1 0..1 Interchange 1 interchange 1 ConnectionLink stops 0..1 1 distrinbutor 1 1 StopPoint stop 1 1 1 1 StopPointInSequence feeder StopPointRef[1] VisitNumber[0..1] Order[0..1] StopPointName[0..1] feeder 0..1 0..1 position change InterchangeRef[0..1] ConnectionLinkRef[1] StopPointRef[0..1] DistributorVisitNumber[0..1] DistributorOrder[0..1] DistributorJourney[1] FeederVehicleJourneyRef[0..1] Extensions[0..1] pattern 1 FramedVehicleJourneyRef DataFrameRef[1] DatedVehicleJourneyRef[1] 1 1 delayed wait AbstractDistributorItem to0..1 stop to stop 0..1 1 0..* WaitProlongedDeparture ExpectedDepartureTime[0..1] Extensions[0..1] 1 distributor DatedVehicleJourney StoppingPositionChangedDeparture journey 0..1 1 0..* ChangeNote[0..1] NewLocation[0..1] Extensions[0..1] Line 1 DistributorDepartureCancellation InterchangeJourney 1 1 LineRef[1] DirectionRef[1] FramedVehicleJourneyRef[0..1] JourneyPatternInfo[0..1] VehicleJourneyInfo[0..1] DisruptionInfo[0..1] OperationalInfo[0..1] Monitored[0..1] AimedDepartureTime[0..1] Extensions[0..1] 1 0..1 OperationalInfo 0..1 mode Direction Route 0..1 1 0..1 route 1 pattern 1 1 disruption 0..1 0..1 DisruptionInfo 0..1 1 Mode 1 0..* Reason[0..1] Extensions[0..1] VehicleJourneyInfo JourneyPatternInfo JourneyPatternRef[0..1] VehicleMode[0..1] RouteRef[0..1] PublishedLineName[0..1] DirectionName[0..1] ExternalLineRef[0..1] 0..1pattern JourneyPattern 1 0..1 Figure 10-3 ConnectionMonitoringDelivery - Summary © Kizoom 2006- 2007 Page 38 SIRI Functional Services - UML Diagrams 10.2.2 ConnectionMonitoringDelivery Detail 1 1 ProducerResponse SIRI-CM ConnectionMonitoringDelivery Participant ResponseTimeStamp[1] : dateTime ProducerRef[0..1] : ParticipantCode Address[0..1] : EndPointAddress ResponseMessageIdentifier[0..1] : MessageQualifier RequestMessageRef[0..1] : MessageQualifier © 2007 SIRI ServiceDelivery Status[0..1] : boolean ErrorCondition[1] : ErrorCondition MoreData[1] : boolean AbstractServiceDelivery 1 ResponseTimeStamp[1] : dateTime RequestMesageRef[0..1] : MessageQualifier SubscriberRef[0..1] : ParticipantCode SubscriptionFilterRef[0..1] : SubscriptionFilterCode SubscriptionRef[0..1] : SubscriptionCode Address[0..1] : EndPointAddress ResponseMessageIdentifier[0..1] : MessageQualifier Status[0..1] : boolean ErrorCondition[0..1] : ErrorCondition ValidUntil[0..1] : dateTime ShortestPossibleCycle[0..1] : positiveDuration 0..1 1 1 ErrorCondition Error[1] : AbstractError Description[1] : ErrorDescription 0..1 1 0..* 0..* ConnectionMonitoringDistributorDelivery ConnectionMonitoringFeederDelivery version[1] : VersionString Extensions[1] : any version[1] : VersionString Extensions[1] : any AbstractItem 1 1 -RecordedAtTime[1] : dateTime 1 1 1 AbstractIdentifiedItem AbstractReferencedItem -IdentifiedItemCode[0..1] : IdentifiedItemCode -IdentifiedItemRef[0..1] : IdentifiedItemCode 0..* 0..* MonitoredFeederArrivalCancellation InterchangeRef[0..1] : InterchangeCode ConnectionLinkRef[1] : ConnectionLinkCode StopPointInSequence[0..1] : StopPointInSequence LineRef[1] : LineCode DirectionRef[1] : DirectionCode VehicleJourneyRef[1] : FramedVehicleJourneyRef JourneyPatternInfo[0..1] : JourneyPatternInfo Reason[0..1] : populatedString Extensions[0..1] : any MonitoredFeederArrival 1 InterchangeRef[0..1] : InterchangeCode ConnectionLinkRef[1] : ConnectionLinkCode StopPointInSequence[0..1] : StopPointInSequence ClearDownRef[0..1] : CleardownCode FeederJourney[1] : InterchangeJourney VehicleAtStop[1] : boolean NumberOfTransferPassengers[0..1] : integer ExpectedArrivalTime[1] : dateTime Extensions[0..1] : any 0..1 11 0..1 Interchange 0..1 ConnectionLink 0..1 1 1 distrinbutor 0..1 0..1 1 JourneyPatternInfo StopPointInSequence AbstractDistributorItem 1 InterchangeRef[0..1] : InterchangeCode ConnectionLinkRef[1] : ConnectionLinkCode StopPointRef[0..1] : StopPointCode DistributorVisitNumber[0..1] : VisitNumber 1 DistributorOrder[0..1] : positiveInteger feederDistributorJourney[1] : InterchangeJourney 0..1 FeederVehicleJourneyRef[0..1] : FramedVehicleJourneyRef FramedVehicleJourneyRef Extensions[0..1] : any StopPointRef[1] : StopPointCode VisitNumber[0..1] : VisitNumber feeder Order[0..1] : positiveInteger StopPointName[0..1] : populatedString 1 StopPoint 1 1 1 1 1 JourneyPatternRef[0..1] : JourneyPatternCode VehicleMode[0..1] : VehicleModesEnum RouteRef[0..1] : RouteCode PublishedLineName[0..1] : populatedString DirectionName[0..1] : populatedString ExternalLineRef[0..1] : LineCode 0..1 1 1 Mode JourneyPattern 0..1 1 -Distributor InterchangeJourney WaitProlongedDeparture LineRef[1] : LineCode DirectionRef[1] : DirectionCode FramedVehicleJourneyRef[0..1] : FramedVehicleJourneyRef JourneyPatternInfo[0..1] : JourneyPatternInfo VehicleJourneyInfo[0..1] : VehicleJourneyInfo DisruptionInfo[0..1] : DisruptionInfo OperationalInfo[0..1] : OperationalInfo Monitored[0..1] : boolean AimedDepartureTime[0..1] : dateTime Extensions[0..1] : any ExpectedDepartureTime[0..1] : dateTime Extensions[0..1] : any Line 1 1 0..1 Route 1 1 0..1 Direction 0..1 1 0..* StoppingPositionChangedDeparture 0..* ChangeNote[0..1] : populatedString NewLocation[0..1] : Location Extensions[0..1] : any 0..* See ConnectionTimetable Service for details DistributorDepartureCancellation Reason[0..1] : populatedString Extensions[0..1] : any Figure 10-4 ConnectionMonitoringDelivery - Detail © Kizoom 2006- 2007 Page 39 SIRI Functional Services - UML Diagrams 11 SIRI GeneralMessage (GM) The SIRI General Message service is used to transmit messages between the participants. The data to be published will typically be informative messages such as travel news and other operational advice, entered or forwarded into the system, normally by a control centre. The General Message service can segregate different types of informative message into separate information channels; each info channel can be assigned to a different operational message group type (errors, messages, warnings, traffic information, operational messages, etc.). The Topics allow a Consumer system to specify that only specific categories of message are to be returned. 11.1 Subscription & Request 11.1.1 GeneralMessageRequest Summary participant Participant 1 1 SIRI-GM Summary GeneralMessageSubscription & GeneralMessageRequest 1 requests SubscriptionRequest © 2007 SIRI 1 participant * GeneralMessageSubscriptionRequest GeneralMessageRequest[1] GeneralMessageSubscriptionPolicies[0..1] Extensions[0..1] request requests request 1 1 1 ServiceRequest 1 * 1 1 * GeneralMessageSubscriptionPolicies 1 GeneralMessageRequest GeneralMessageTopics[0..1] GeneralMessagePolicies[0..1] Extensions[0..1] topics policies 1 0..1 policies 1 0..1 GeneralMessagePolicies Language[1] 0..1 channel 1 GeneralMessageTopics InfoChannel[0..1] InfoChannel Figure 11-1 GeneralMessageRequest - Summary © Kizoom 2006- 2007 Page 40 SIRI Functional Services - UML Diagrams 11.1.2 GeneralMessageRequest Detail SubscriptionRequest RequestTimestamp[1] : dateTime Address[0..1] : anyURI RequestorRef[1] : ParticipantCode MessageIdentifer[0..1] : string ConsumerAddress[0..1] : anyURI SubscriptionFilterIdentifier[1] : NMTOKEN SubscriptionContext[0..1] AbstractSubscriptionRequest 1 SubscriberRef[1] : ParticipantCode SubscriptionIdentifier[1] InitialTerminationTime[1] SIRI-GM GeneralMessageSubscription & GeneralMessageRequest © 2007 SIRI requests 1 1 * Participant GeneralMessageSubscriptionRequest 1 GeneralMessageRequest[1] : GeneralMessageRequest GeneralMessageSubscriptionPolicies[0..1] : GeneralMessageSubscriptionPolicies Extensions[0..1] : any 1 ServiceRequest RequestContext[1] : RequestContext RequestTimestamp[1] : dateTime Address[1] : anyURI RequestorRef[1] : ParticipantCode MessageIdentifer[1] : string policies 1 * 1 GeneralMessageSubscriptionPolicies request 1 AbstractRequest requests RequestTimestamp[1] : dateTime MessageIdentifier[0..1] : string 1 * GeneralMessageRequest GeneralMessageTopics[0..1] : GeneralMessageTopics GeneralMessagePolicies[0..1] : GeneralMessagePolicies Extensions[0..1] : any topics policies 1 1 0..1 GeneralMessageTopics InfoChannel[0..1] : InfoChannelCode 0..1 GeneralMessagePolicies Language[1] : lang channel 1 0..1 InfoChannel Figure 11-2 GeneralMessageRequest - Detail © Kizoom 2006- 2007 Page 41 SIRI Functional Services - UML Diagrams 11.2 Delivery 11.2.1 GeneralMessageDelivery Summary 1 participant 1 Participant ProducerResponse SIRI-GM Summary GeneralMessageDelivery © 2007 SIRI ServiceDelivery errors ErrorCondition 1 1 Error[1] Description[1] 0..1 deliveries 0..* cancellation GeneralMessageDelivery version[1] Extensions[0..1] 1 1 message 0..1 0..1 Situation 0..1 InfoChannel 1 info channel 0..1 GeneralMessageCancellation GeneralMessage info message 1 InfoMessageIdentifier[1] InfoMessageVersion[0..1] InfoChannelRef[0..1] ValidUntilTime[0..1] SituationRef[0..1] Content[1] cancels 1 1 InfoMessageIdentifier[1] InfoMessageVersion[0..1] InfoChannelRef[0..1] ValidUntilTime[0..1] SituationRef[0..1] Extensions[0..1] 1 content Content 1 format[0..1] value[0..1] Figure 11-3 GeneralMessageDelivery - Summary © Kizoom 2006- 2007 Page 42 SIRI Functional Services - UML Diagrams 11.2.2 GeneralMessageDelivery Detail ProducerResponse ResponseTimeStamp[1] : dateTime ProducerRef[0..1] : ParticipantCode Address[0..1] : EndPointAddress ResponseMessageIdentifier[0..1] : MessageQualifier RequestMessageRef[0..1] : MessageQualifier Participant © 2006 SIRI AbstractServiceDelivery ResponseTimeStamp[1] : dateTime RequestMesageRef[0..1] : MessageQualifier SubscriberRef[0..1] : ParticipantCode SubscriptionFilterRef[0..1] : SubscriptionFilterCode SubscriptionRef[0..1] : SubscriptionCode Address[0..1] : EndPointAddress ResponseMessageIdentifier[0..1] : MessageQualifier Status[0..1] : boolean ErrorCondition[0..1] : ErrorCondition ValidUntil[0..1] : dateTime ShortestPossibleCycle[0..1] : positiveDuration SIRI-GM GeneralMessageDelivery 1 1 ServiceDelivery ErrorCondition Status[0..1] : boolean ErrorCondition[1] : ErrorCondition MoreData[1] : boolean -Error[1] : AbstractError -Description[1] : ErrorDescription 1 0..1 0..1 1 1 0..* GeneralMessageDelivery 1 -version[1] : VersionString -Extensions[0..1] : any AbstractItem 1 RecordedAtTime[1] : dateTime AbstractIdentifiedItem AbstractReferencedItem IdentifiedItemCode[0..1] : IdentifiedItemCode IdentifiedItemRef[0..1] : IdentifiedItemCode 0..1 0..1 Situation 0..1 info message 1 info channel InfoChannel 0..1 1 GeneralMessage GeneralMessageCancellation InfoMessageIdentifier[1] : InfoMessageIdentifier InfoMessageVersion[0..1] : InfoMessageVersion InfoChannelRef[0..1] : InfoChannelCode ValidUntilTime[0..1] : dateTime SituationRef[0..1] : SituationCode Content[1] : Content InfoMessageIdentifier[1] : InfoMessageIdentifier InfoMessageVersion[0..1] : InfoMessageVersion InfoChannelRef[0..1] : InfoChannelCode ValidUntilTime[0..1] : dateTime SituationRef[0..1] : SituationCode Extensions[0..1] : any cancels 1 0..1 1 1 Content format[0..1] : anyURI value[0..1] : any «datatype» InfoMessageIdentifier «datatype» InfoMessageVersion «datatype» InfoChannelCode Figure 11-4 GeneralMessageDelivery - Detail © Kizoom 2006- 2007 Page 43 SIRI Functional Services - UML Diagrams 12 SIRI FacilityMonitoring (FM) 12.1 Subscription & Request 12.1.1 FacilityMonitoringRequest Summary [TODO] Figure 12-1 ProductionTimeTableRequest - Summary 12.1.2 FacilityMonitoringRequest Detail [TODO] Figure 12-2 ProductionTimetableRequest - Detail 12.2 Delivery 12.2.1 FacilityMonitoringDelviery Summary [TODO] Figure 12-3 ProductionTimetableDelivery - Summary 12.2.2 FacilityMonitoringDelviery Detail [TODO] Figure 12-4 ProductionTimetableDelivery - Detail © Kizoom 2006- 2007 Page 44 SIRI Functional Services - UML Diagrams 13 SIRI SituationExchange (SX) The SIRI-SX Service is for exchanging Situation content in real-time. It uses a structured Situation model for describing disruptions to services that includes element references that relate directly to the entities of other SIRI services. Incidents can thus be directly linked to stops, lines, journeys, pathways, etc: and provide an explanation of the disruption. The Topics allow a Consumer system to specify that only specific categories of message are to be returned. 13.1 Subscription & Request 13.1.1 SituationExchangeRequest Summary subscriptions SIRI-SX Summary SituationExchangeSubscription & SituationExchangeRequest SubscriptionRequest 1 participant 1 1 Participant * participant 1 1 © 2007 SIRI SituationExchangeSubscriptionRequest SituationExchangeRequest SituationExchangeSubscriptionPolicies Extensions policies SituationExchangeSubscriptionPolicies 1 request 1 ServiceRequest IncrementalUpdates * 1 policies 1 SituationExchangeRequest requests SituationExchangeTopics SituationExchangePolicies Extensions * «enumeration» TpegSeverityEnum unknown verySlight slight normal severe verySevere noImpact undefined SituationExchangePolicies 1 topics Language MaximumNumberOfSituations 0..1 1 mode 1 0..1 Mode 0..1 SituationExchangeTopics «enumeration» PredictabilityEnum planned unplanned both 1 filter 1 filter 0..1 PreviewInterval StartTime VehicleMode AffectedSubMode AccessMode Severity Predictability Keywords SituationNetworkFilter SituationStopPlaceFilter SituationJourneyFilter AccessibilityNeedFilter 1 filter 1 0..* 0..1 SituationNetworkFilter OperatorRef OperationalUnitRef NetworkRef LineRef StopPointRef ConnectionLinkRef network SituationStopPlaceFilter StopPlaceRef FacilityRef 1 1 line connection 1 stop place 1 1 operatorstop point 0..1 0..1 0..1 Line Operator «enumeration» AccessModesEnum foot bicycle car taxi shuttle filter 0..1 1 «enumeration» VehicleModesEnum air bus coach ferry metro rail tram underground StopPlace AccessibilityNeedsFilter SituationJourneyFilter VehicleJourneyRef InterchangeRef VehicleRef journey 1 0..1 1 UserNeed 0..1 user need vehicle 1 interchange VehicleJourney 0..1 Vehicle 1 UserNeed 0..1 0..1 0..1 0..1 Interchange Network StopPoint ConnectionLink Figure 13-1 SituationExchangeRequest - Summary © Kizoom 2006- 2007 Page 45 SIRI Functional Services - UML Diagrams 13.1.2 SituationExchangeRequest Detail SIRI-SX SituationExchangeSubscription & SituationExchangeRequest SubscriptionRequest RequestTimestamp[1] : dateTime Address[0..1] : anyURI RequestorRef[1] : ParticipantCode MessageIdentifer[0..1] : string ConsumerAddress[0..1] : anyURI SubscriptionFilterIdentifier[1] : NMTOKEN SubscriptionContext[0..1] 1 1 subscriptions 1 Participant © 2007 SIRI AbstractSubscriptionRequest SubscriberRef[1] : ParticipantCode SubscriptionIdentifier[1] InitialTerminationTime[1] * 1 1 SituationExchangeSubscriptionRequest ServiceRequest 1 policies SituationExchangeRequest[1] : SituationExchangeRequest SituationExchangeSubscriptionPolicies[0..1] : SituationExchangeSubscriptionPolicies Extensions[0..1] : any request RequestContext[1] : RequestContext RequestTimestamp[1] : dateTime Address[1] : anyURI RequestorRef[1] : ParticipantCode MessageIdentifer[1] : string 1 1 * AbstractRequest SituationExchangeSubscriptionPolicies RequestTimestamp[1] : dateTime MessageIdentifier[0..1] : string requests 1 IncrementalUpdates[0..1] : boolean * policies SituationExchangeRequest SituationExchangePolicies SituationExchangeTopics[0..1] : SituationExchangeTopics SituationExchangePolicies[0..1] : SituationExchangePolicies Extensions[0..1] : any 0..1 1 Language[1] : lang MaximumNumberOfSituations[1] : positiveInteger OperationalUnit 1 «enumeration» PredictabilityEnum planned unplanned both topics Operator 1 0..1 0..1 «enumeration» AccessModesEnum foot bicycle car taxi shuttle 1 Network line 0..1 1 0..1 line filter 0..1 1 Line StopPoint ConnectionLink SituationStopPlaceFilter 1 stop place StopPlaceRef[0..1] : StopPlaceCode FacilityRef[0..1] filter 0..1 0..1 StopPlace 1 0..1 1 journey VehicleJourney filter 0..1 SituationJourneyFilter VehicleJourneyRef[0..1] : DatedVehicleJourneyCode InterchangeRef[0..1] : InterchangeCode VehicleRef[0..1] : VehicleCode vehicle 1 Vehicle 0..1 interchange 1 0..* Interchange 0..1 AccessibilityNeedsFilter UserNeed[0..1] : UserNeed user need 1 0..1 UserNeed «enumeration» MobilityNeedEnum wheelchair motorizedWheelchair walkingFrame retsrictedMobility otherSpecifiedNeed 1 1 OperatorRef[0..1] : OperatorCode OperationalUnitRef[0..1] : OperationalUnitCode 1 stop point0..1 NetworkRef[0..1] : NetworkCode LineRef[0..1] : LineCode 1 0..1 StopPointRef[0..1] : StopPointCode ConnectionLinkRef[0..1] : ConnectionLinkCode connection 1 0..1 1 «enumeration» VehicleModesEnum air bus coach ferry metro rail tram underground network unit 0..1 SituationNetworkFilter filter SituationExchangeTopics PreviewInterval[1] : duration StartTime[0..1] : dateTime VehicleMode[0..1] : VehicleModesEnum AffectedSubMode[0..1] : AccessModesEnum AccessMode[1] : AccessModesEnum Severity[0..1] : TpegSeverityEnum Predictability[0..1] : boolean Keywords[0..*] : string SituationNetworkFilter[0..1] : SituationNetworkFilter SituationStopPlaceFilter[0..1] : SituationStopPlaceFilter SituationJourneyFilter[0..1] : SituationJourneyFilter AccessibilityNeedFilter[0..1] : AccessibilityNeedsFilter «enumeration» TpegSeverityEnum unknown verySlight slight normal severe verySevere noImpact undefined operator «enumeration» PsychosensoryNeedEnum visualImpairment auditoryImpairment cognitiveInputImpairment averseToLifts averseToEscalators averseToConfinedSpaces averseToCrowds otherSpecificNeed «enumeration» MedicalNeedEnum allergic heartCondition «enumeration» EncumbranceNeedEnum luggageEncumbered pushchair baggageTrolley oversizeBagagge guideDog otherAnimal otherEncumbrance Figure 13-2 SituationExchangeRequest - Detail © Kizoom 2006- 2007 Page 46 SIRI Functional Services - UML Diagrams 13.2 Delivery 13.2.1 SituationExchangeDelviery Summary ProducerResponse SIRI-SX Summary SituationExchangeDelivery errors ServiceDelivery deliveries 1 0..* 1 ErrorCondition © 2006 SIRI 0..1 SituationContext context SituationExchangeDelivery version[1] Extensions[0..1] 1 0..1 1 1 references 1 situations related to Participant RelatedTo Situation 0..* CreationTime[1] ParticipantRef[1] * SituationNumber[1] RelatedTo[0..*] SituationBody[1] 1 participant 1 1 body source 1 updates SituationVersion[0..1] UpdateParticipantRef[0..1]1 PtSituationBody 1 classifiers Reason 1 description 1 reason * 0..1 SituationUpdate 1 0..* when 11 1 SituationSource[1] SituationStatus[1] TemporalGroup[1] ClassifierGroup[1] DescriptionGroup[0..1] Affects[0..1] Consequences[0..*] PublishingActions[1] Extensions[0..1] 1 TemporalGroup 1 applies 0..1 Country[0..1] SourceType[1] Email[0..1] Phone[0..1] Fax[0..1] Web[0..1] Other[0..1] AgentReference[0..1] TimeOfCommunication[1] ExternalCode[0..1] 1 actions 1 0..1 Consequence ClassifierGroup ValidityPeriod[1] Repetitions[0..*] PublicationWindow[1] Reason[1] Subreason[0..1] ReasonName[0..1] Severity[1] Priority[0..1] Sensitivity[0..1] Audience[0..1] ReportType[0..1] ScopeType[0..1] Planned[0..1] Keywords[0..*] consequence 1 DescriptionGroup Summary[0..1] Description[0..1] Detail[0..1] Advice[0..1] Internal[0..1] Images[0..*] InfoLink[0..*] 0..* affects affects Period[0..1] Condition[0..1] Severiity[1] Affects[0..1] Suitabilities[0..*] Advice[1] Blocking[0..1] Boarding[0..1] Delay[0..1] Casualties[0..1] Easements[0..1] Extensions[0..1] ValidityPeriod AffectedNetwork networks 1 1 0..1 0..1 0..1 0..* operators 0..* Network PublishingActions 1 network -StartTime[1] -EndTime[1] «enumeration» RelatedEnum cause effect supercedes supercededBy association SituationSource 1 BaseSituation CreationTime[1] ParticipantRef[0..1] SituationNumber[1] SituationVersion[0..1] RelatedAs[1] 1 1 journeys AffectedVehicleJourney 0..* Affects journey 0..1 1 1 1places AffectedOperator DatedVehicleJourney 0..1 operator Operator 1 1 1 1 0..* 0..* places lines AffectedLine AffectedPlace stops 0..* 0..1 1 line Line place Place 0..* 0..1 AffectedScheduledStop AffectedStopPlace 0..1 1 stop StopPoint stop0..1 place 1 StopPlace Figure 13-3 SituationExchangeDelivery - Summary 13.2.2 SituationExchangeDelviery Detail [TODO] © Kizoom 2006- 2007 Page 47 SIRI Functional Services - UML Diagrams 13.2.3 Situation Model 13.2.3.1 Situation references RelatedTo Participant Situation 1 participant 1 CreationTime[1] : dateTime ParticipantRef[0..1] : ParticipantCode SituationNumber[1] : SituationIdentifier SituationVersion[0..1] : SituationVersion RelatedAs[1] : RelatedEnum 1 related to CreationTime[1] : dateTime ParticipantRef[1] : ParticipantCode SituationNumber[1] : SituationIdentifier RelatedTo[0..*] : RelatedTo SituationBody[1] : PtSituationBody 1 0..* 1 SituationSource 1 body BaseSituation updates 1 0..* SituationUpdate SituationVersion[0..1] : SituationVersion UpdateParticipantRef[0..1] : Participant * source 0..1 status SituationStatus Verication[1] : VerificationEnum Progress[1] : SituationProgressEnum Quality[1] : QualityIndexEnum 1 1 1 Country 1 country Country[0..1] : CountryEnum SourceType[1] : SourceEnum Email[0..1] : email Phone[0..1] : phoneNumber Fax[0..1] : phoneNumber Web[0..1] : anyURI Other[0..1] : string AgentReference[0..1] : string TimeOfCommunication[1] : dateTime ExternalCode[0..1] : string 0..1 «enumeration» RelatedEnum cause effect supercedes supercededBy association «enumeration» SourceEnum email phone fax post feed radio tv web pager text other actions PublishingActions PtSituationBody «enumeration» 0..1 TemporalGroup SituationSource[1] : SituationSource SensitivityEnum when SituationStatus[1] : SituationStatus veryHigh «enumeration» ValidityPeriod[1] : ValidityPeriod TemporalGroup[1] : TemporalGroup 1 high VerificationEnum Repetitions[0..*] : DayType ClassifierGroup[1] : ClassifierGroup * medium PublicationWindow[1] : ValidityPeriod unknown DescriptionGroup[0..1] : DescriptionGroup low 1 unverified 1 Affects[0..1] : Affects veryLow ValidityPeriod verified 1 applies 1 description classifiersConsequences[0..*] : Consequence PublishingActions[1] StartTime[1] : dateTime 1 1 Extensions[0..1] : any EndTime[1] : dateTime «enumeration» repetitions 0..1 SituationProgressEnum 1 1 draft DayType 1 approvedDraft ClassifierGroup DayType[1] : TpegDayTypeEnum * open DescriptionGroup Reason[1] : Reason closing Subreason[0..1] Summary[0..1] : DefaultedText DefaultedText closed ReasonName[0..1] : nlString Description[0..1] : DefaultedText consequence nlString : nlString Severity[1] : TpegSeverityEnum Detail[0..1] : DefaultedText links «enumeration» overridden : boolean Priority[0..1] : integer Advice[0..1] : DefaultedText QualityIndexEnum 1 Sensitivity[0..1] : SensitivityEnum Internal[0..1] : DefaultedText certain Audience[0..1] : AudienceEnum Images[0..*] : Image InfoLink veryReliable ReportType[0..1] : TpegReportEnum InfoLink[0..*] : InfoLink reliable Uri : any 0..* ScopeType[0..1] : ScopeEnum probablyReliable 0..* Label : nlString Planned[0..1] : boolean unconfirmed 1 Image : Image Keywords[0..*] : string LinkContent : LinkContentEnum Consequence images affects 1 «enumeration» Period[0..1] : HalfOpenTimestampRange «enumeration» 1 1 AudienceEnum Condition[0..1] : TpegServiceConditionEnum TpegSeverityEnum image Severiity[1] : TpegSeverityEnum public unknown Affects[0..1] : Affects Reason staff verySlight Suitabilities[0..*] : Suitability emergencyServices 0..* slight Advice[1] : Advice 0..1 management normal Blocking[0..1] : Blocking Network stationStaff severe Boarding[0..1] : Boarding infoServices Image verySevere network Delay[0..1] : duration 1 ImageRef : anyURI noImpact Casualties[0..1] : Casualties ImageBinary : any undefined Easements[0..1] : Easement 0..1 © 2007 1 ImageContent : ImageContenEnum Extensions[0..1] : any 0..* networks operators AffectedNetwork affects 0..1 1 0..* 0..1journey 1 journeys 0..1 AffectedVehicleJourney 1 operators SIRI Situation 1 0..* Affects 1 1 AffectedOperator operator 1 components 0..* 0..* 0..* 0..1 stop stop place 0..1 AffectedStopPlace AffectedScheduledStop 1links 1 StopPlace 0..* 0..* 1 components 1 AffectedLine 0..1 line 0..* DatedVehicleJourney 0..* 1 places 1 AffectedStopPlaceComponent operators Operator 1 stops lines 0..* 1 0..1 0..1 StopPoint 1 AffectedConnectionLink destinations Line 1 Figure 13-4 Situation Main elements © Kizoom 2006- 2007 Page 48 SIRI Functional Services - UML Diagrams 13.2.3.2 Situation Body Figure 13-5 SituationExchangeDelivery - Detail © Kizoom 2006- 2007 Page 49 SIRI Functional Services - UML Diagrams 13.2.3.3 Situation Affects Scope Operator 0..1 operator SIRI-SX Situation Affects Summary 1 © 2007 0..* 1 0..* 0..* DatedVehicleJourney operator AffectedOperator 1 consequence PtSituationBody operators 0..* 1 1 journey Consequence operators Network affects affects 1 0..1 0..1 1 network 0..1 0..1 1 operators AffectedNetwork 1 AffectedVehicleJourney 1 0..* networks 1 AffectedPlace 1 0..* place 1 1 components lines 0..* places 1 0..* TopographicPlace 1 Affects places 1 lines journeys 0..1 0..* place * 1 Place 0..1 AffectedStopPlaceComponent AffectedScheduledStop 0..1 0..1 1 0..1 links1 StopPlace AffectedCall 0..* components 0..* 0..* 1 destinations AffectedLine line calls 1 1 component StopPlaceComponent 0..1 0..1 stop place 0..1 AffectedStopPlace 11 origins 1 0..* stop AffectedConnectionLink 1 1 0..1 0..1 1 to stop 0..1 line Line StopPoint 1 line 0..1 1 © Kizoom 2006- 2007 Page 50 SIRI Functional Services - UML Diagrams Situation Affects Scope – Scheduled Journeys 13.2.3.4 consequence PtSituationBody SIRI-SX Situation Affects Consequence 1 affects 1 1 0..* 0..1 0..1 1 affects 1 AffectedStopPlace Affects journeys © 2007 0..1 operator Operator operators 1 0..* 1 1 AffectedOperator 0..1 OperatorRef[0..1] : OperatorCode OperatorName[0..1] : nlString 1 operators OperatorShortName[0..1] : nlString 0..* OperationalUnitRef[0..1] : OperationalUnitCode 0..1 journey 1 Extensions[0..1] : any 1 network lines 0..* AffectedNetwork 0..* 0..1 DatedVehicleJourney NetworkRef[0..1] : NetworkCode operators mode NetworkName[0..1] : nlString RoutesAffected[0..1] : nlString 0..1 AffectedOperators[0..*] : AffectedOperator 1 AffectedModes[0..1] : Mode AffectedLines[0..*] : AffectedLine Mode accessibility Extensions[1] : any 0..* Route 0..* 1 lines 0..1 routes AffectedLine 0..* LineRef[0..1] : LineCode PublishedineName[0..1] : nlString AffectedOperators[0..*] : AffectedOperator AffectedDestinations[0..*] : AffectedScheduledStop 1 Direction[0..1] : DirectionCode 0..* AffectedRoutes[0..*] : RouteCode direction AffectedSections[0..*] : NMTOKEN Extensions[1] : any line sections 1 1 0..1 0..1 Direction 0..* line 1 LineSection 0..1 AffectedConnectionLink «enumeration» ConnectionDirectionEnum both from to «enumeration» TpegInterchangeStatusEnum unknown connection replacement alternative connectionNotHeld connectionHeld statusOfConnectionUndecided undefined 0..1 link 1 1 0..1 1 0..1 1 arrival interchanges 0..1 1 0..* 1 destinations 0..* AffectedCall StopPoint stop 0..1 TopographicPlace 1 1 links 0..* ConnectionLinkRef[0..1] ConnectionName[0..1] : nlString LineRef[0..1] : LineCode PublishedLineName[0..1] : nlString ConnectingStopPointName[0..1] : nlString ConnectingZoneName[0..1] : nlString ConnectionDirection[0..1] : ConnectionDirectionEnum AffectedLinks[0..*] : AffectedLinks Extensions[0..1] : any TopographicPlace StopPointRef[0..1] : StopPointCode StopPointName[0..1] : nlString StopPointType[0..1] PrivateRef[1] : NMTOKEN Location[0..1] : Location AffectedModes[0..*] : Mode TopographicPlaceRef[0..1] : PlaceId PlaceName[0..1] : nlString AccessibilityDisruptions[0..*] : AccessibilityDisruption ConnectionLinks[0..*] : AffectedConnectionLink Extensions[0..1] : any stop 0..1 1 Line * AffectedScheduledStop 1 destinations 1 AccessibilityDisruption 1 line modes 1 AffectedVehicleJourney DatedVehicleJourneyRef[0..1] : DatedVehicleJourneyCode JourneyName[0..1] : nlString stops Operator[0..1] : AffectedOperator LineRef[0..1] : LineCode PublishedLineName[0..1] : nlString DirectionRef[0..1] : DirectionCode Origins[0..*] : AffectedScheduledStop Destinations[0..*] : AffectedScheduledStop OriginAimedDepartureTime[0..1] : dateTime DestinationAimedArrivalTime[0..1] : dateTime Calls[0..*] : AffectedCall AccessibilityDisruptions[0..*] : AccessibilityDisruption FacilityChange[1] : FacilityChange Extensions[0..1] : any accessibility 0..* 1 1 origins1 operator Network 0..1 0..* 1 networks 1 more... 0..* places 1 Order[1] : integer CallCondition[0..1] : TpegServiceConditionEnum VehicleAtStop[0..1] : boolean AffectedInterchanges[0..*] : AffectedInterchange ConnectingVehicleJourneyRef[0..1] : DatedVehicleJourneyCode ArrivalTimes[0..1] : ArrivalTimes ArrivalInfo[0..1] : ArrivalInfo DepartureTimes[0..1] : DepartureTimes DepartureInfo[0..1] : DepartureInfo HeadwayInfo[0..1] : HeadwayInfo departure 0..1 1 1 ArrivalTimes DepartureTimes AimedArrivalTime[0..1] ActualArrivalTimes[0..1] ExpectedArrivalTime[0..1] AimedDepartureTime[0..1] ActualDepartureTimes[0..1] ExpectedDepartureTime[0..1] AffectedInterchange ArrivalInfo InterchangeRef[0..1] : InterchangeCode InterchangeStopPointRef[0..1] : StopPointCode InterchangeStopPointName[0..1] : nlString ConnectingVehicleJourneyRef[0..1] : DatedVehicleJourneyCode InterchangeStatusType[0..1] : TpegInterchangeStatusEnum AffectedConnectionLinkRef[0..1] : AffectedConnectionLink Extensions[0..1] : any ArrivalStatus[0..1] ArrivalPlatformName[0..1] ArrivalBoardingActivity[0..1] HeadwayInfo * 1 1 arrival DepartureInfo departure 0..1 headway 0..1 DepartureStatus[0..1] DeparturePlatformName[0..1] DepartureBoardingActivity[0..1] 0..1 -AimedHeadWayInterval[0..1] -ExpectedHeadwayInterval[0..1] Figure 13-6 Affects Scope - Scheduled Journeys © Kizoom 2006- 2007 Page 51 SIRI Functional Services - UML Diagrams 13.2.3.5 Situation Affects Scope Stop Place AffectedPlace places Affects 1 0..* 1 PlaceRef[1] : StopPlaceId PlaceName[0..1] : nlString PlaceType[0..1] : NMTOKEN Extensions[0..1] : any place Place 1 0..1 places StopPlace AffectedStopPlaceElement accessibility AccessibilityDisruption[0..1] : AccessibilityDisruption 0..1place stop 1 0..* 0..1 1 AccessibilityDisruption AffectedStopPlace StopPlaceRef[1] : StopPlaceCode PlaceName[0..1] : nlString StopPlaceType[1] : StopPlaceTypeEnum Components[0..*] : AffectedStopPlaceComponent NavigationPaths[0..*] : ComponentId Extensions[0..1] : any components SIRI-SX Situation Affects - Stop Place 1 © 2007 Suitability UserNeed[1] : UserNeed Suitable[1] : SuitableEnum «enumeration» ComponentTypeEnum quay 0..* accessSpace boardingPosition stoppingPlace stoppingPosition entrance stopPathLink accessPathLink other «enumeration» AccessFacilityEnum unknown lift escalator travelator ramp stairs shuttle narrowEntrance barrier lowFloorAccess suitabilities 1 0..* 1 «enumeration» StopPlaceTypeEnum airport railStation metroStation coachStation busStation shipPort ferryPort ferryStop onStreetBus onStreetTram skiLift other MobilityImpairedAccess[1] : boolean Liimitations[0..1] Suitabilities[0..*] : Suitability «enumeration» SuitableEnum suitable notSuitable unknown AffectedStopPlaceComponent ComponentRef[1] : ComponentId ComponentName[0..1] : nlString ComponentType[1] : ComponentTypeEnum AccessFeatureType[0..1] : AccessFeatureEnum Extensions[0..1] : any component 1 «enumeration» AccessibilityEnum true false unknown 0..* 0..1 Limitation StopPlaceComponent 1 level Level 1 AbstractPathLink StopPathLink limitation AccessPathLink WheelchairAccess[0..1] : AccessibilityEnum StepFreeAccess[0..1] : AccessibilityEnum EscalatorFreeAccess[0..1] : AccessibilityEnum LiftFreeAccess[0..1] : AccessibilityEnum AudibleSignsAvailable[0..1] : AccessibilityEnum VisualSignsAvailable[0..1] : AccessibilityEnum AbstractStopPlaceSpace AccessSpace Quay BoardingPosition Figure 13-7 Affects Scope - Stop Place © Kizoom 2006- 2007 Page 52 SIRI Functional Services - UML Diagrams 14 SIRI Common Data Types © Kizoom 2006- 2007 Page 53 SIRI Functional Services - UML Diagrams 14.1 Common SIRI Data Types – Codes & Identifiers «datatype» boolean SIRI Simple DataTypes «datatype» dateTime «datatype» lang «datatype» any «datatype» string «datatype» integer © 2006 SIRI «datatype» NMTOKEN «datatype» positiveDuration «datatype» populatedString «datatype» positiveInteger «datatype» nlString «datatype» ParticipantCode «datatype» phoneNumber «datatype» Latitude «datatype» SubscriptionFilterCode «datatype» Longtitude «datatype» ErrorDescription «datatype» email «datatype» Coordinates «datatype» Bearing «datatype» VersionString «datatype» IdentifiedItemCode «datatype» DateTimePeriod «datatype» RouteCode «datatype» DataFrameCode «datatype» LineCode «datatype» MonitoringCode «datatype» JourneyPatternCode «datatype» DatedVehicleJourneyCode «datatype» OperatorCode «datatype» VisitNumber «datatype» TimetableVersionCode «datatype» SituationCode «datatype» ProductCategoryCode «datatype» JourneyPlaceCode «datatype» StopPlaceCode «datatype» EndPointAddress «datatype» Distance «datatype» MessageQualifier «datatype» SubscriptionCode «datatype» anyURI «datatype» duration «datatype» decimal «datatype» StopPlaceId «datatype» StopPointCode «datatype» ComponentId «datatype» CleardownCode «datatype» OperationalUnitCode «datatype» EquipmentFeatureCode «datatype» VehicleFeatureCode «datatype» ZoneCode «datatype» BlockCode «datatype» DestinationCode «datatype» VehicleJourneyCode «datatype» EquipmentTypeCode «datatype» ServiceFeatureCode «datatype» TrainPartCode «datatype» DirectionCode «datatype» EquipmentCode «datatype» NetworkCode «datatype» CourseOfJourneyCode «datatype» ConnectionLinkCode «datatype» VehicleCode «datatype» PlaceId «datatype» InterchangeCode Figure 14-1 Common Base Data types © Kizoom 2006- 2007 Page 54 SIRI Functional Services - UML Diagrams 14.2 Common SIRI Data Types The SIRI-SX services use a number of common SIRI data types. The common SIRI data types are listed in Figure 14-2. ErrorCondition -Error[1] : AbstractError -Description[1] : ErrorDescription AbstractError 1 SIRI Simple ErrorTypes -ErrorText[1] : string 1 © 2006 SIRI CapabilityNotSupportedError AccessNotAllowedError NoInfoForTopicError AllowedResourceUsageExceeded OtherError CapabilityCode[1] : NMTOKEN image DefaultedText InfoLink nlString[1] : nlString overridden[0..1] : boolean Uri[1] : any Label[1] : nlString Image[1] : Image LinkContent[1] : LinkContentEnum SIRI Complex Data Types © 2006 SIRI Location 1 Image 0..1 ImageRef[0..1] : anyURI ImageBinary[0..1] : any ImageContent[0..1] : ImageContenEnum «enumeration» LinkContentEnum details advice timetable relatedSite other «enumeration» ImageContenEnum map graphic logo id[0..1] : NMTOKEN srsName[0..1] : NMTOKEN Longitude[0..1] : Longtitude Latitude[0..1] : Latitude Coordinates[0..1] : Coordinates Precision[0..1] : Distance FacilityChange HalfOpenTimestampRange EquipmentAvailability[0..1] SituationRef[0..1] : SituationCode MobilityDisruption[0..1] EquipmentAvailability 0..1 1 EquipmentRef[0..1] : EquipmentCode Description[0..1] : populatedString EquipmentStatus[1] : EquipmentStatus ValidityPeriod[0..1] : HalfOpenTimestampRange EquipmentTypeRef[0..1] : EquipmentTypeCode EquipmentFeatures[0..*] : EquipmentFeatureCode 1 StartTime[1] : dateTime EndTime[0..1] : dateTime MobilityDisruption 0..1 FramedVehicleJourneyRef Mode DataFrameRef[1] : DataFrameCode DatedVehicleJourneyRef[1] : DatedVehicleJourneyCode -Mode[1] : VehicleModesEnum -SubMode[0..1] : TpegSubMode MobilityImpairedAccess[0..1] : boolean MobilityFacility[0..1] : MobilityFacility TpegSubMode Figure 14-2 UML Diagram of Common SIRI Data Types © Kizoom 2006- 2007 Page 55 SIRI Functional Services - UML Diagrams 14.3 Common General SIRI Enumerations The SIRI-SX services use a number of common SIRI enumerations. The common SIRI enumerations are listed in Figure 14-3 SIRI Enumerations © 2006 SIRI «enumeration» VehicleModesEnum air bus coach ferry metro rail tram underground «enumeration» ArrivalActivityEnum alighting noAlighting passThru «enumeration» DepartureActivityEnum boarding noBoarding passThru «enumeration» OccupancyEnum full seatsAvailable standingAvailable «enumeration» ProgressRateEnum noProgress slowProgress normalProgress fastProgress unknown «enumeration» SmDetailLevelEnum minimum basic normal calls full «datatype» CountryEnum «enumeration» FacilityStatusEnum unknown available notAvailable partiallyAvailable «enumeration» TimeStatusEnum early onTime delayed arrived cancelled noReport «datatype» EquipmentStatus «datatype» MobilityFacility Figure 14-3 UML Diagram of SIRI enumerations 14.4 SIRI-SX Enumerations Figure 14-4 summaries the enumerations that are specific to SIRI-SX. These also appear in context on individual diagrams. SIRI-SX Enumerations © 2006 SIRI «enumeration» RelatedEnum cause effect supercedes supercededBy association «enumeration» QualityIndexEnum certain veryReliable reliable probablyReliable unconfirmed «enumeration» SituationProgressEnum draft approvedDraft open closing closed «enumeration» AudienceEnum public staff emergencyServices management stationStaff infoServices «enumeration» ConnectionDirectionEnum both from to «enumeration» SituationNatureEnum planned unplanned both «enumeration» SensitivityEnum veryHigh high medium low veryLow «enumeration» ImageContenEnum map graphic logo «enumeration» VerificationEnum unknown unverified verified «enumeration» LinkContentEnum details advice timetable relatedSite other «enumeration» ScopeEnum general operator network route line place stopPlace stopPlaceComponent stopPoint vehicleJourney datedVehicleJourney connectionLink interchange Figure 14-4 UML Diagram of SIRI-SX Enumerations © Kizoom 2006- 2007 Page 56 SIRI Functional Services - UML Diagrams 14.5 IFOPT Enumerations Figure 14-5 UML Diagram of IFOPT Stop Place Enumerations summarises the IFOPT STOP PLACE enumerations that are used in SIRI-SX. These mostly also appear in context on individual UML diagrams. IFOPT Enumerations © 2006 SIRI «enumeration» CongestionEnum noWaiting queue crowding full «enumeration» StopPlaceTypeEnum airport railStation metroStation coachStation busStation shipPort ferryPort ferryStop onStreetBus onStreetTram skiLift other «enumeration» AcccessSpaceEnum concours bookingHall forecourt underpass overpass gallery garage shop «enumeration» ComponentTypeEnum quay accessSpace boardingPosition stoppingPlace stoppingPosition entrance stopPathLink accessPathLink other «enumeration» QuayTypeEnum airlineGate railPlatform metroPlatform coachStop busStop boatQuay ferryLanding tramStop telecabinPlatform taxiStand setDownPlace unknown other «enumeration» BoardingPositionTypeEnum doorFromAirlineGate positionOnRailPlatform positionOnMetroPlatform positionAtTramStop positionAtBusStop positionAtCoachStop ferryGangway boatGangway telecabinGangway taxiBay carSetDownPoint unknown other «enumeration» AccessFeatureEnum lift escalator travelator ramp stairs shuttle barrier narrowEntrance confinedSpace queueManagement none unknown «enumeration» AccessModesEnum foot bicycle car taxi shuttle Figure 14-5 UML Diagram of IFOPT Stop Place Enumerations © Kizoom 2006- 2007 Page 57 SIRI Functional Services - UML Diagrams 14.6 TPEG Miscellaneous Enumerations Figure 14-6 summarises the miscellaneous TPEG enumerations that are used in SIRISX. These mostly also appear in context on individual UML diagrams. «enumeration» TpegDayTypeEnum unknown monday tuesday wednesday thursday friday saturday sunday mondayToFriday mondayToSaturday weekends publicHoliday holiday regionalHoliday nationalHoliday sundaysAndPublicHolidays schooldays everyday undefinedDayType «enumeration» TpegSeverityEnum unknown verySlight slight normal severe verySevere noImpact undefined Tpeg pti-26 TPEG Enumerations «enumeration» TpegServiceConditionEnum unknown altered cancelled delayed diverted noService disrupted additionalService specialService onTime normalService intermittentService shortFormedService fullLengthService extendedService splitingTrain replacementTransport arrivesEarly shuttleService replacementService undefinedServiceInformation © 2006 SIRI TPEG pti_34 tpeg pti_13 tpeg pti 31 «enumeration» TpegInterchangeStatusEnum unknown connection replacement alternative connectionNotHeld connectionHeld statusOfConnectionUndecided undefined «enumeration» TpegReportEnum unknown network route point individualService undefined «enumeration» TpegTicketRestrictionEnum unknown allTicketClassesValid fullFareOnly certainTicketsOnly ticketWithReservation specialFare onlyTicketsOfSpecifiedOperator noRestrictions noOffPeakTickets noWeekendReturnTickets noReducedFareTickets unknwonTicketRestriction tpeg pti_27 tpeg pti_25 «enumeration» TpegRoutePointEnum unknown startPoint destination stop via notStopping temporaryStop temporarilyNotStopping exceptionalStop additionalStop requestStop frontTrainDestination rearTrainDestination throughServiceDestination notVia alteredStartPoint alteredDestination undefinedRoutePoint tpeg pti_5 Figure 14-6 UML Diagram of TPEG Enumerations © Kizoom 2006- 2007 Page 58 SIRI Functional Services - UML Diagrams 14.7 TPEG Mode Enumerations Figure 14-7 summarises the TPEG mode enumerations that are used in SIRI-SX. These mostly also appear in context on individual UML diagrams. TPEG pti02 + loc13 «enumeration» TpegRailSubmodeEnum unknown highSpeedRailService LongDistanceRailService interRegionalRailService carTransportRailService sleeperRailService regionalRail touristRailway railShuttle suburbanRailway replacementRailService specialTrainService lorryTransportRailService allRailServices crossCountryRailService vehiclRailTransportService rackAndPinionRailway additionalTrainService undefined local international TPEG pti05 «enumeration» TpegVehicleModesEnum +air +bus +coach +ferry +metro +rail +tram +underground «enumeration» TpegBusSubmodeEnum unknown regionalBus expressBus bus localBus nightBus postBus specialNeedsBus mobilityBus mobilityBusForRegisteredDisabled sightseeingBus shuttleBus schoolBus schoolAndPublicServiceBus railReplacementBus demandAndResponseBus airportLinkBus undefined TPEG pti06 TPEG pti04 «enumeration» TpegMetroSubmodeEnum unknown metro tube urbanRailway allRailServices undefined TPEG pti11 «enumeration» TpegTaxiSubmodeEnum unknown communalTaxi waterTaxi railTaxi bikeTaxi blackCab miniCab allTaxiServices undefined «enumeration» TpegTramSubmodeEnum unknown cityTram localTramService regionalTram sightseeingTram shuttleTram allTramServices undefined TPEG pti10 TPEG pti03 «enumeration» TpegCoachSubmodeEnum unknown internationalCoachService nationalCoachService shuttleCoachService regionalCoachService specialCoachService sightseeingCoachService tourist commuterCoachService allCoachServices undefined TPEG pti08 «enumeration» TpegAirSubmodeEnum unknown internationalFlight domesticFlight intercontinentalFlight domesticScheduledFlight shuttleFlight intercontinentalCharteFlight internationalCharteFlight roundTripCharterFlight sightseeingFlight helicopterService domesticCharterFlight SchengenAreaFlight airshipService allAirServices shortHaulInternationalFlight undefined TPEG pti09 + loc14 «enumeration» TpegFunicularSubmodeEnum unknown funicular allFunicularServices undefined TPEG pti07 «enumeration» TpegWaterSubmodeEnum unknown internationalCarFerryService nationalCarFerryService regionalCarFerryService localCarFerryService internationalPassengerFerry nationalPassengerFerry regionalPassengerFerry localPassengerFerry postBoat trainFerry roadFerryLink airportBoatLink highSpeedVehicleService highSpeedPassengerService sightseeingService schoolBoat cableFerry riverBus scheduledFerry shuttleFerryService allWaterTransportServices undefined «enumeration» TpegTelecabineSubmodeEnum unknown telecabine allFunicularServices undefined cableCar lift chairLift dragLift smallTelecabin allTelecabinServices eggLift mineralBuckets undefined telecabinLink Figure 14-7 UML Diagram of Tpeg submodes © Kizoom 2006- 2007 Page 59