Template:InheritConnection: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[unchecked revision][checked revision]
(Created template for 'connection' elements in the Infrastructure subschema)
 
(Simplified template as it is now only used by switch and crossing. Modified descriptions.)
 
(49 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{ElementDocu|
<includeonly>{{ElementDocu|
elementName = connection
elementName = connection
|parent = {{{parentLink|FIXME}}}
|parent = {{{parentLink|FIXME}}}
 
|minocc={{{minocc|1}}}
|semantics =
|maxocc={{{maxocc|1}}}
A {{{selfLink|FIXME}}} is an element to determine which branches of a {{IS:Doc|track}} are connected at a certain position. {{AddAnn|{{{semantics_en|}}}|{{{semantics_de|}}} }}
|semantics = The {{{selfLink|FIXME}}} describes a branch of the {{{parentLink|FIXME}}}, including which other {{IS:Doc|track}} this branch is connected to. See [[Dev:Connection between tracks]] for more details on different connections between tracks.


|inheritedAttributes =  
|inheritedAttributes =  
{{InheritId
{{InheritId}}
|id = {{{id|}}}
|id_de = {{{id_de|}}}
}}
{{InheritRef
{{InheritRef
|attributeName = ref
|attributeName = ref
|contextLink = '''<connection>'''
|contextLink = {{IS:Tag|connection}}
|notes_en = {{{ref|}}}
|notes_de = {{{ref_de|}}}
}}
}}
|ownAttributes =
* {{Attr|orientation}}: Orientation of the {{{parentLink|FIXME}}} branch relative to the direction of the {{IS:Tag|track}} (looking towards the {{IS:Tag|trackEnd}}).
:* {{Enum|incoming}}: This branch is merging into the track, tracks are converging relative to the direction.
:* {{Enum|outgoing}}: Twis branch is splitting out from the track, tracks are diverging relative to the direction.
:* {{Enum|rightAngled}}: This branch is crossing perpendicular to the track. Only meaningful for {{IS:Tag|crossing}}, not for {{IS:Tag|switch}}.
:* {{Enum|unknown}}: The direction is not known.
:* {{OtherEnum}}
* {{Attr|course}}: Sideways direction of this branch relative to the continuation of the {{IS:Tag|track}} in the track's direction (looking towards the {{IS:Tag|trackEnd}}).
:* {{Enum|straight}} This branch continues straight. This assumes the principal track is not considered straight ({{IS:Tag|switch|@=trackContinueCourse}} is not <tt>"straight"</tt>).
:* {{Enum|left}}: This branch is merging from the left or is diverging leftward from the track.
:* {{Enum|right}}: This branch is merging from the right or is diverging rightward from the track.
:* {{OtherEnum}}
* {{Attr|radius}}: Radius of the curve with which the branch rails converge into or diverge from the track, measured from an imaginary center of a circle. Defined in the same way as {{IS:Tag|radiusChange|@=value}}.
* {{Attr|maxSpeed}}: Speed restriction for passing over the switch on this branch.


|ownAttributes =
* {{Attr|passable}} Denotes if you can pass between the track the {{{selfLink|FIXME}}} is placed on and the track referred to by {{Attr|ref}}. See [[Dev:Connection_between_tracks]] for descriptions of the usage.
{{#if: {{PAGENAME}} = (IS:switch or IS:crossing)
* {{Attr|branchDist}} {{Depr|2.1}} Since originally no separate, connecting track element was allowed, a special attribute denoted the length of the connection. See [[Dev:Connection_between_tracks]].
|
* {{Attr|orientation}}
:* {{Enum|incoming}}
:* {{Enum|outgoing}}
:* {{Enum|rightAngled}}
:* {{Enum|unknown}}
:* {{OtherEnum
|notes_en = {{{orientation|}}}
|notes_de = {{{orientation_de|}}}
}}
* {{Attr|course}}
:* {{Enum|straight}}
:* {{Enum|left}}
:* {{Enum|right}}
:* {{OtherEnum
|notes_en = {{{course|}}}
|notes_de = {{{course_de|}}}
}}
* {{Attr|radius}}
* {{Attr|maxSpeed}}
* {{Attr|passable}}
* {{Attr|branchDist}} {{Depr|2.1}}
|
}}


|constraints =
|constraints =
{{InheritIdConstraints}}
{{InheritIdConstraints}}
* {{Attr|ref}} {{RailMLType|tGenericRef}}, mandatory {{AddAnn|{{{constraints_en|}}}|{{{constraints_de|}}} }}
*{{constraint|ref|rml|tGenericRef|required}} {{AddAnn|Must point to the {{Attr|id}} of another {{IS:Tag|connection}}}}
{{#if: {{PAGENAME}} = (IS:switch or IS:crossing)
*{{constraint|orientation|rml|tConnectionOrientation|required}}
|
*{{constraint|course|rml|tCourse}}
* {{Attr|orientation}} mandatory
*{{constraint|radius|rml|tRadiusM}} {{intro|2.4}}{{note|Until {{rml}} 2.3: tLengthM ({{RailMLType|tLengthM}}) {{depr|2.3}}}}
* {{Attr|course}} optional
*{{constraint|maxSpeed|rml|tSpeedKmPerHour}}
* {{Attr|radius}} {{RailMLType|tLengthM}}, optional
*{{constraint|passable|xsd|boolean|default=TRUE}}
* {{Attr|maxSpeed}} {{RailMLType|tSpeedKmPerHour}}, optional
*{{constraint|branchDist|rml|tLengthM}}
* {{Attr|passable}} {{XsdType|Boolean}}, optional
 
* {{Attr|branchDist}} {{RailMLType|tLengthM}}, optional
|notes = {{AddAnn|{{{notes_en|None.}}}|{{{notes_de|}}} }}
|
|bestpractice={{{bestpractice|}}}
}}
|example =
Please also refer to [[Dev:Connection between tracks]] for information on how to use connections and switches/crossings.


}}
}}</includeonly><noinclude>{{TemplateDocu}}</noinclude>

Latest revision as of 06:04, 5 June 2024

Usage

This is an Element Template. Element templates are intended to avoid routine work in railML® element documentation. These templates are very specific and are therefore documented uniformely by Template:TemplateDocu. They are collected in Category:Element Template and are based on Template:ElementDocu. They represent Template:ElementDoku with specific values and hand all other parameters through to Template:ElementDoku. If you want to use or handle an Element Template, you have to examine the code to find out, which arguments are set, and you have to be careful, because occationally arguments will be renamed, so that the use of argument names of Template ElementDoku may cause errors.

Arguments

As this is a bulk documentation, we do not explain the specific arguments of element templates.

Dependencies

As this is a bulk documentation, we do not explain the specific dependencies of element templates. You can find out, which other templates the current template supports by following this link. You can find out easily, which other templates the current template employs, as templates are included via {{doubble braces}}.

Example

As this is a bulk documentation, we do not offer specific examples of element templates. You can find in the field examples by following this link.

Retrieved from "https://wiki2.railml.org/index.php?title=Template:InheritConnection&oldid=15663"