Template:InheritSwitchCrossing: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
No edit summary
Line 84: Line 84:
}}
}}


The template is employed by [[IS:Crossing]] and [[IS:Switch]].
The template is employed by [[IS:crossing]] and [[IS:switch]].


[[Category:AttributeTemplate]]</noinclude>
[[Category:AttributeTemplate]]</noinclude>

Revision as of 16:02, 12 October 2022

Usage

This template lists seven attributes concerning switches and lists and obligatory comments for some of them. All attributes can be optionally commented in English and in German.

Arguments

The template allows for fourteen optional arguments:

  • ocpStationRef: English comment on ocpStationRef
  • ocpStationRef_de: German comment on ocpStationRef
  • controllerRef: English comment on controllerRef
  • controllerRef_de: German comment on controllerRef
  • trackContinueCourse: English comment on trackContinueCourse
  • trackContinueCourse_de: German comment on trackContinueCourse
  • trackContinueRadius: English comment on trackContinueRadius
  • trackContinueRadius_de: German comment on trackContinueRadius
  • normalPosition: English comment on normalPosition
  • normalPosition_de: German comment on normalPosition
  • model: English comment on model
  • model_de: German comment on model
  • length: English comment on length
  • length_de: German comment on length

Dependencies

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

Examples

{{InheritSwitchCrossing}}

delivers


  • ocpStationRef: This refers to the id attribute of the associated <ocp> element.
    (introduced with version 2.1)
  • controllerRef: This refers to the id attribute of the associated <controller> element.
    (introduced with version 2.1)
  • trackContinueCourse Possible values are:
  • straight straight leg (no curve) of the switch
  • left left curved leg of switch
  • right right curved leg of switch
  • 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. Please, apply Dev:usingAny accordingly.
  • trackContinueRadius
  • normalPosition Possible values are:
  • straight straight leg (no curve) of the switch
  • left left curved leg of switch
  • right right curved leg of switch
  • 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. Please, apply Dev:usingAny accordingly.
  • model
  • length
  • remoteOperated: (introduced with version 2.5) Flag, whether the position of the switch or crossing is operated from anywhere else, i.e. from signalbox or remote operator place but not directly at the switch/crossing.
  • remoteIndicated: (introduced with version 2.5) Flag, whether the position of the switch or crossing is indicated at a remote operator place.
  • lockRef: (introduced with version 2.5) The reference to the lock used to control the position of this switch or crossing.
  • clearancePosOffset: (introduced with version 2.5) The distance between the switch location (@pos) and the position of the switch clearance point. This value is always positive.
{{InheritSwitchCrossing
|ocpStationRef=English comment on ocpStationRef
|ocpStationRef_de=German comment on ocpStationRef
|controllerRef=English comment on controllerRef
|controllerRef_de=German comment on controllerRef
|trackContinueCourse=English comment on trackContinueCourse
|trackContinueCourse_de=German comment on trackContinueCourse
|trackContinueRadius=English comment on trackContinueRadius
|trackContinueRadius_de=German comment on trackContinueRadius
|normalPosition=English comment on normalPosition
|normalPosition_de=German comment on normalPosition
|model=English comment on model
|model_de=German comment on model
|length=English comment on length
|length_de=German comment on length
}}

delivers


  • ocpStationRef: This refers to the id attribute of the associated <ocp> element.
    (introduced with version 2.1)
    English comment on ocpStationRef

    German comment on ocpStationRef
  • controllerRef: This refers to the id attribute of the associated <controller> element.
    (introduced with version 2.1)
    English comment on controllerRef

    German comment on controllerRef
  • trackContinueCourse Possible values are:
  • straight straight leg (no curve) of the switch
  • left left curved leg of switch
  • right right curved leg of switch
  • 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. Please, apply Dev:usingAny accordingly.
    English comment on trackContinueCourse
    German comment on trackContinueCourse
  • trackContinueRadius
    English comment on trackContinueRadius
    German comment on trackContinueRadius
  • normalPosition Possible values are:
  • straight straight leg (no curve) of the switch
  • left left curved leg of switch
  • right right curved leg of switch
  • 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. Please, apply Dev:usingAny accordingly.
    English comment on normalPosition
    German comment on normalPosition
  • model
    English comment on model
    German comment on model
  • length
    English comment on length
    German comment on length
  • remoteOperated: (introduced with version 2.5) Flag, whether the position of the switch or crossing is operated from anywhere else, i.e. from signalbox or remote operator place but not directly at the switch/crossing.
  • remoteIndicated: (introduced with version 2.5) Flag, whether the position of the switch or crossing is indicated at a remote operator place.
  • lockRef: (introduced with version 2.5) The reference to the lock used to control the position of this switch or crossing.
  • clearancePosOffset: (introduced with version 2.5) The distance between the switch location (@pos) and the position of the switch clearance point. This value is always positive.

The template is employed by IS:crossing and IS:switch.