CO:designator

Documentation

Syntax

This element does not appear in railML^® 3.3 within the CO subschema. It is available only in railML^® 3.1.
There exists an element <generic:designator> that might have replaced or preceded it. Do not hesitate to contact railML.org e.V. for further questions.

This element does not appear in railML^® 3.2 within the CO subschema. It is available only in railML^® 3.1.
There exists an element <generic:designator> that might have replaced or preceded it. Do not hesitate to contact railML.org e.V. for further questions.

Autoexport from the XML-Schema for element CO:designator of railML® version 3.1      UML-visualization of CO
Documentation	This element is not documented in the schema!
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.

Changes 3.1→3.2

There exists an overview of all changes between railML^® 3.1 and railML^® 3.2 on page Dev:Changes/3.2.
Removed with version 3.2. There exists an element <generic:designator> that might have replaced it.

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 shall be called by the respective code. E.g. register="DB640" for the register of station codes of the Austrian Federal Railways (Dienstbehelf 640).
• Project internal registers that do not appear in registers.xml shall be called with a code starting with an underscore. E.g. register="_CRL".
  If the register you are referring to is employed in productive use, please contacting us to get it included into the codelist.

Additional Information

Notes

railML.org added in autumn 2024 "UUID" as a register to use with <designator>s. When using UUIDs to reference objects this requires an extra step, that was already there for other external keys: include an element with a regular XML ID and the UUID (or other) designator, and then reference that element using the XML ID.