Template:InheritProcessStatus

From wiki.railML.org
Jump to: navigation, search

Usage

This template displays the attribute processStatus and lists the possible values planned, actual, calculated, toBeChecked, imported and other:anything (see CO:usingAny#New enumeration value). The attribute can be commented on both in English and in German.

Arguments

The template has an obligatory and two optional arguments:

  • Obligatory:
    • selfLink: the name of the described element
  • Optional:
    • processStatus: English comment
    • processStatus_de: German comment

Dependencies

The template depends on Template:Attr, Template:Enum, Template:OtherEnum and Template:AddAnn. No other templates build on it.

Examples

{{InheritProcessStatus|selfLink=ElementName}}

delivers

  • processStatus: It describes the ElementName status in relation to a working process.
Note.png The semantics of the attribute values for @processStatus have not been fully defined in the past. In general the attribute shall describe a state of the process supported by railML®. Therefore the precise semantics shall be clarified between data provider and the data consumer.
Examples:
If an updated version of a timetable is transferred, the @processStatus is used by some systems to indicate if a train was changed compared to the previous data transfer by providing @processStatus=changed.
For the use case slot ordering the attribute is used with the value planned by some systems to describe that a train has been planned in the scheduling tool, but hasn’t been taken into account for the slot ordering process.

Possible values are:

  • planned
  • actual
  • calculated
  • toBeChecked
  • changed
  • imported
  • other:anything Any value that does not fit any value from the previous enumeration list, fulfilling the constraint: at minimum two characters, whitespace is not allowed.
{{InheritProcessStatus
|selfLink=ElementName
|processStatus=English comment
|processStatus_de=Deutscher Kommentar
}}

delivers

  • processStatus: It describes the ElementName status in relation to a working process.
Note.png The semantics of the attribute values for @processStatus have not been fully defined in the past. In general the attribute shall describe a state of the process supported by railML®. Therefore the precise semantics shall be clarified between data provider and the data consumer.
Examples:
If an updated version of a timetable is transferred, the @processStatus is used by some systems to indicate if a train was changed compared to the previous data transfer by providing @processStatus=changed.
For the use case slot ordering the attribute is used with the value planned by some systems to describe that a train has been planned in the scheduling tool, but hasn’t been taken into account for the slot ordering process.

Possible values are:

  • planned
  • actual
  • calculated
  • toBeChecked
  • changed
  • imported
  • other:anything Any value that does not fit any value from the previous enumeration list, fulfilling the constraint: at minimum two characters, whitespace is not allowed.
    English comment
    Deutscher Kommentar

The template is employed by TT:train, TT:trainPart and TT:trainGroup.