IL:key

Documentation

Syntax

Autoexport from the XML-Schema for element IL:key of railML® version 3.2 UML-visualization of IL
Documentation	An ancillary element used for operation of a specific locking device.
Subschema	interlocking
Parents*	keys
Children	designator (0..*), isPhysical (0..1)
Attributes: id: unique identifier (obligatory; xs:string; patterns: (urn:uuid:)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|\{[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\}); compare: Dev:Identities
*Notice: Elements may have different parent elements. As a consequence they may be used in different contexts. Please, consider this as well as a user of this wiki as when developing this documentation further. Aspects that are only relevant with respect to one of several parents should be explained exclusively in the documentation of the respective parent element.

Autoexport from the XML-Schema for element IL:key of railML® version 3.1 UML-visualization of IL
Documentation	An ancillary element used for operation of a specific locking device.
Subschema	interlocking
Parents*	keys
Children	any (0..*), designator (0..1), isPhysical (0..1)
Attributes: id: unique identifier (optional; xs:ID; patterns: (urn:uuid:)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|\{[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\}); compare: Dev:Identities
*Notice: Elements may have different parent elements. As a consequence they may be used in different contexts. Please, consider this as well as a user of this wiki as when developing this documentation further. Aspects that are only relevant with respect to one of several parents should be explained exclusively in the documentation of the respective parent element.

Changes 3.1→3.2

The children have changed.

The attributes have been changed.

Best Practice / Examples

🗒️ There can be various logical devices like <keyLockIL> and <genericDetector>, which provide their state as input to the interlocking. Depending on their use it is also possible to send particular information from the interlocking to the logical device in order to provoke a specific reaction. It is an abstract class extended by the particular instances of it like keyLockIL or genericDetector. The common attributes and elements are: @elementNumber - A positive integer number unique within one <signalBox> to index the element in internal lists of engineering data. @id - The unique identifier used to reference this element within railML. @description – The string element takes a more detailed description of the logic. This is for information of the user only. <designator> - A coded name as per a specified register for the asset. <assetName> - A name for the asset in a given language. <belongsToOperationalPoint> - The reference to an <operationalPoint> this device belongs to from operational point of view. <hasCommand> - The reference to any predefined operator command, which can be used with this element. For details refer to <hasOperatorCommand>. <hasIndication> - The reference to any predefined indication on HMI, which is used with this element. For details refer to <hasHmiIndication>. <takesControlOf> – This is the reference to a movable element which can be controlled with the lock. In case of a detector, it is used as reference to any track asset, which is related to the logical device. <hasInterface> – The reference to the physical interface of the logical device to the interlocking. For details refer to <interface>. <refersTo> - The reference to the physical device like <keyLockIS> in the infrastructure. This element is optional as some detectors may not have a corresponding element in the infrastructure because they are not located at the track. The particular instantiation extends the abstract type of logicalDevice by some additional elements and attributes. There are further logical devices conceivable. Currently the <movableBridge> is implemented using this abstract class.

Although the key itself is not a logical device it is handled here due to its relation to key locks. The element mainly needs just the <designator> and @id to describe a key that can be referred by any lock as suitable to operate it. In a conventional system this means a hardware key that is related to physical lock.

• @isPhysical – The Boolean value gives indication whether the key is of physical type for use in a mechanical lock.