CO:designator

From railML 3 Wiki
Jump to navigation Jump to search

Introduction

Documentation

Syntax

Autoexport from the XML-Schema for element CO:designator of railML® version 3.2
Documentation Schema documentation missing!
Subschema common
Parents* activatedBy,

activationCondition, aspectRelatedDelay, aspectRelation, assetsForInterlocking, atpDevice, balise, baliseGroup, basculeBridge, border, bufferStop, combinedRoute, command, conflictingRoute, controlledInterlocking, controlledSystemAsset, controller, controlsInterface, controlsSystemAsset, controlsTrackAsset, crossing, crossingInPosition, dangerPoint, deactivatedBy, delayBySwitchPosition, derailerIL, derailerIS, derailerInPosition, destinationPoint, detector, detectorInState, distantAspect, electrificationSection, endOfTrack, facingSwitchInPosition, formation, genericDetector, givenAspect, givenPosition, givenPosition, givenPosition, givenState, givenState, givenState, hasAspect, hasCommunicationSettings, hasConfiguration, hasDetectorTypes, hasElementGroupType, hasHmiIndication, hasLevelCrossingType, hasOperatorCommand, hasPositionRestriction, hasRouteType, hasTVDresetStrategy, implementsElementGroup, implementsSignalplan, interface, itinerary, key, keyLockIL, keyLockIS, keyLockInState, levelCrossingIL, levelCrossingIS, levelCrossingInState, line, loadingGauge, localOperationArea, masterAspect, message, movableCrossing, operationalPoint, overCrossing, overlap, overlapRelease, permissionZone, platform, powerSupplyIL, radioBlockCenter, radioBlockCenterBorder, reasonForConflict, relatedCrossingAndPosition, relatedDerailerAndPosition, relatedDerailerInPosition, relatedDetectorAndState, relatedLevelCrossingAndState, relatedLockAndState, relatedSectionAndVacancy, relatedSignalAndAspect, relatedSwitchAndPosition, relatedSwitchInPosition, relatedToTunnelGateAndState, requiredCrossingPosition, requiredDerailerPosition, requiredDetectorState, requiredKeyLockState, requiredLevelCrossingState, requiredSectionState, requiredSignalAspect, requiredSwitchPosition, requiredTunnelGateState, requiresLevelCrossingInState, requiresSwitchInPosition, restrictionArea, route, routeActivationSection, routeEntry, routeExit, routeRelation, routeReleaseGroupAhead, routeReleaseGroupRear, routeStatusIndicator, serviceSection, shuntingZone, signalBox, signalDelayTime, signalIL, signalIS, signalIndicator, signalWithAspect, slaveAspect, speedSection, stationIndicator, stoppingPlace, switchIL, switchIS, switchInPosition, switchPositionInDepartureTrack, track, trackBed, trackGauge, trackIL, trailingSwitchInPosition, trainDetectionElement, trainNumberField, trainProtectionElement, trainRadio, tunnelGateIL, tvdSection, underCrossing, vehicle, vehiclePart, visualization, weightLimit, workZone

Children None
Attributes:
  • register: name of a register where the designator entry can be found (obligatory; xs:string),

  • entry: the designator of the element in the specified register (obligatory; xs:string),

  • description: description of the designator, which can be used to provide basic information about an external system that uses the designator for external referencing (optional; xs:string)
*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 CO:designator of railML® version 3.1
Documentation Schema documentation missing!
Subschema common
Parents* activatedBy,

activationCondition, aspectRelatedDelay, aspectRelation, assetsForIL, atpDevice, balise, border, bufferStop, combinedRoute, command, conflictingRoute, controlledInterlocking, controlledSystemAsset, controller, controlsInterface, controlsSystemAsset, controlsTrackAsset, crossing, crossingInPosition, dangerPoint, deactivatedBy, delayBySwitchPosition, derailerIL, derailerIS, derailerInPosition, destinationPoint, detectorInState, distantAspect, electrificationSection, facingSwitchInPosition, genericDetector, givenAspect, givenPosition, givenPosition, givenPosition, givenState, givenState, givenState, hasAspect, hasConfiguration, hasDetectorTypes, hasElementGroupType, hasLevelCrossingType, hasPositionRestriction, hasRouteType, hasTVDresetStrategy, implementsElementGroup, implementsSignalplan, interface, itinerary, key, keyLockIL, keyLockIS, keyLockInState, levelCrossingIL, levelCrossingIS, levelCrossingInState, line, loadingGauge, localOperationArea, masterAspect, message, movableCrossing, operationalPoint, overCrossing, overlap, overlapRelease, permissionZone, platform, powerSupplyIL, reasonForConflict, relatedCrossingAndPosition, relatedDerailerAndPosition, relatedDerailerInPosition, relatedDetectorAndState, relatedLevelCrossingAndState, relatedLockAndState, relatedSectionAndVacancy, relatedSignalAndAspect, relatedSwitchAndPosition, relatedSwitchInPosition, requiredCrossingPosition, requiredDerailerPosition, requiredDetectorState, requiredKeyLockState, requiredLevelCrossingState, requiredSectionState, requiredSignalAspect, requiredSwitchPosition, requiresLevelCrossingInState, requiresSwitchInPosition, restrictionArea, route, routeActivationSection, routeEntry, routeExit, routeRelation, routeReleaseGroupAhead, routeReleaseGroupRear, serviceSection, shuntingZone, signalBox, signalDelayTime, signalIL, signalIS, signalWithAspect, slaveAspect, specificIM, speedSection, stoppingPlace, switchIL, switchIS, switchInPosition, switchPositionInDepartureTrack, track, trackBed, trackGauge, trainDetectionElement, trainProtectionElement, trainRadio, tvdSection, underCrossing, weightLimit, workZone

Children None
Attributes:
  • register: name of a register where the designator entry can be found (obligatory; xs:string),

  • entry: the designator of the element in the specified register (obligatory; xs:string)
*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.

Semantics

Best Practice / Examples

Usage of @register

In principle, @register is defined as a xs:string and can be filled arbitrarily. Please, observe the rules explained under Dev:Registers#Expansion. In brief:

  • Registers that appear in codelist registers.xml should be called by the respective code. E.g. register=DB640 for the register of station codes of the Austrian Federal Railways (Dienstbehelf 640).
  • Registers that do not appear in registers.xml should be called with a project code starting with an underscore. E.g. register=_SnakeOilCatalogue.
    If the register you are referring to is widely employed, think about contacting us to get it included into the codelist.

Additional Information

Notes

Open Issues