Generic:designator

Documentation

Syntax

Autoexport from the XML-Schema for element Generic:designator of railML® version 3.2
Documentation	External identifier of the project.
Subschema	generic
Parents*	areaElementProjection, aspectRelation, assetsForInterlocking, balise, baliseGroup, border, bufferStop, combinedRoute, conflictingRoute, controller, controlsInterface, crossing, crossingInPosition, dangerPoint, derailerIL, derailerIS, derailerInPosition, destinationPoint, detector, detectorInState, electrificationSection, ellipticalProjection, endOfTrack, etcsArea, etcsLevelTransition, formation, freightFacilities, genericDetector, hasAspect, hasDetectorTypes, hasElementGroupType, hasHmiIndication, hasLevelCrossingType, hasOperatorCommand, hasRouteType, hasTVDresetStrategy, implementsElementGroup, infrastructureVisualization, interface, keeper, key, keyLockIL, keyLockIS, keyLockInState, levelCrossingIL, levelCrossingIS, levelCrossingInState, line, linearElementProjection, loadingGauge, localOperationArea, manufacturer, mileageChange, movableBridge, movableCrossing, netElement, operationalPoint, operator, overCrossing, overlap, overlapRelease, owner, permissionZone, places, platform, platformEdge, powerSupplyIL, project, radioBlockCentre, radioBlockCentreBorder, restrictionArea, route, routeActivationSection, routeEntry, routeExit, routeRelation, routeReleaseGroupAhead, routeReleaseGroupRear, routeSequence, routeStatusIndicator, service, serviceSection, shuntingZone, signalBox, signalIL, signalIS, signalIndicator, signalWithAspect, specificInfrastructureManager, speedSection, spotElementProjection, stationIndicator, stoppingPlace, switchIL, switchIS, switchInPosition, track, trackBed, trackGauge, trackIL, trainDetectionElement, trainNumberField, trainProtectionElement, trainRadio, tunnelGateIL, tunnelGateIS, tvdSection, underCrossing, usesSymbol, vehicle, vehiclePart, weightLimit, workZone
Children	None
Attributes: 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), entry: the designator of the element in the specified register (obligatory; xs:string), register: name of a register where the designator entry can be found (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.

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

Changes 3.1→3.2

Introduced with version 3.2. There exists an element <CO:designator> that might have preceded 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="_SnakeOilCatalogue".
  If the register you are referring to is employed in productive use, please contacting us to get it included into the codelist.