TT:circulation

circulation
 

Scheme description / Schemenbeschreibung

Position of circulation in the XML-Tree / Position von circulation im XML-Baum

• Parent: <circulations>
• Children: None

Multiplicity / Anzahl

[1..1]

Semantics / Bedeutung

The element <circulation> is for chaining the blocks into a complete rostering.

In dem Element <circulation> werden die "Dienste" (blocks) zu einem Umlaufplan verkettet.

Attributes of circulation / Attribute von circulation

• blockRef: This refers to the id attribute of the associated <block> element.

• startDate: If this is absent operatingPeriodRef must be defined.

• endDate: If this is absent operatingPeriodRef may be defined or it is "open end".

• operatingPeriodRef: This refers to the id attribute of the associated <operatingPeriod> element.
  This operatingPeriod constraints the dates the referenced block is to be fulfilled. If this is absent the referenced block runs daily from startDate to endDate.

• repeatCount: This is for abstract circulations from startDate to endDate.

• vehicleCounter (introduced with version 2.2): This indicates the right vehicle number (de: Fahrzeugnummer) within the circulations. (See also the Notes at the bottom of this page.)

• vehicleGroupCounter (introduced with version 2.2): This indicates the right vehicle group number (de: Gruppennummer) within the circulations. (See also the Notes at the bottom of this page.)

• nextBlockRef: This refers to the id attribute of the associated <block> element.
  This is the block which should follow the currently referenced block.

• nextOperatingPeriodRef: This refers to the id attribute of the associated <operatingPeriod> element.
  This operatingPeriod constraints the dates the following <circulation>.

• xs:anyAttribute: (introduced with version 2.3) This provides an extension point for non-railML^® attributes in a foreign namespace. How to use it?

Syntactic Constraints / Syntaktische Beschränkungen

• blockRef xs:IDREF, mandatory

• startDate xs:date, optional; shall be lower or equal endDate if both are used.

• endDate xs:date, optional; shall be higher or equal startDate if both are used.

• operatingPeriodRef xs:IDREF, optional

• repeatCount xs:nonNegativeInteger, optional

• vehicleCounter xs:nonNegativeInteger, optional

• vehicleGroupCounter xs:nonNegativeInteger, optional

• nextBlockRef xs:IDREF, optional

• nextOperatingPeriodRef xs:IDREF, optional

Best practice & Examples / Empfohlene Anwendung & Beispiele

see railML^®-Beispiel Umlauf (external link, 2012-05-23, PDF, 🇩🇪, visited on 2018-03-27; by Dirk Bräuer, iRFP Dresden)

Notes / Anmerkungen

There exists a <circulation> element for every block belonging to the roster on every operating day. Via the attributes nextBlockRef and nextOperatingperiodRef the blocks are connected to a chain and form a rostering. A circulation without nextBlockRef models a block that has no successor in the linked chain. Similarly, a block that is referenced via blockRef but not via nextBlockRef models a block that has no predecessor on the linked chain. It is also legal that a block is completely unlinked within the roster. The presence of a circulation element that references this block via blockRef, in this case, merily expresses that fact that the block is considered as belonging to the roster.

A rostering is closed (can be repeated), if for each <circulation> element the nextBlockRef and nextOperatingperiodRef elements exist.

The attribute vehicleCounter is completely redundant because the information can be recreated by counting links (nextBlockRef,…) which link to earlier days (vehicleCounter) or to lower vehicles number (vehicleGroupCounter). Nevertheless, providing these values makes it easier to get the data and to avoid misunderstandings (skipping of vehicles during standstill).

Open issues / Offene Punkte/Pendenzen

Not yet described. / Noch nicht beschrieben.