FixedPointData

Module Info

Reference: FixedPointData
Numeric OID: 1.3.6.1.4.1.17218.1.0.6.1.0

Exports

This module explicitly exports the following symbols:

FixedPoint fixedPointData

Imports

From GeneralData

GenericId CompanyCode Station CoachPlaces DATA-ELEMENT Data cuperEncoding SharedVehicleVariety SharedVehiclePropulsionType SharedVehicleReturnConstraint TransportId LineId UnicodeText

Assignments

FixedPoint

SEQUENCE

This sequence contains the following fields:

id

The ID SHOULD be eternally unique per issuer.

GenericId

issuer Optional

If different from the security provider. MUST be set if the barcode is unsigned (i.e. no security provider).

CompanyCode

specimen

BOOLEAN

affixedTo Optional

Object

infoText Optional

Additional important information about this fixed point.

UnicodeText

extension Optional

SEQUENCE OF

This type is constrained in the following way:

Size

The length of the value must be greater than or equal to: 1

The length of the value must be less than or equal to: 8

Data

This type is concretely parameterised with the following:

ElementSet: FixedPointExtensions

This type is constrained in the following way:

Fields

The type must satisfy the following field constraints, other fields are unconstrained:

Field	Presence	Value
format	No stipulation	Inverse Any value, except any satisfying the following: Union Any of the following can be true: Single value The value must be exactly: `!C` OR Single value The value must be exactly: `!P`

FixedPointExtensions

OBJECT SET

This object set has the following members:

&id	&Type	&encoding
Other members may be added at runtime.

fixedPointData

OBJECT

This is an object of the class: DATA-ELEMENT

This object has the following field values:

&id: FPD1
&Type: FixedPoint
&encoding: cuperEncoding

Object

CHOICE

The value of this choice may be one of the following:

station: e.g. for check-in/check-out by scanning.

StationPoint
vehicle: e.g. for at-seat ordering, customer reporting of vehicle defects, vehicle based check-in.

Vehicle
sharedVehicle: e.g. bike, e-scooter, car sharing.

SharedVehicle
proprietary: Values defined by the issuer.

GenericId
vehicleDynamic: VehicleDynamic

StationPoint

SEQUENCE

This sequence contains the following fields:

station: Station
platform Optional: VisibleString
subLocationProprietary Optional: Values defined by the issuer.

GenericId

Vehicle

SEQUENCE

This sequence contains the following fields:

id: VehicleIdentifier
place Optional: For identifying at which carriage and seat/compartment this barcode is placed, if at a seat.

CoachPlaces
subLocationProprietary Optional: When affixed non-seat items or sub-items within a compartment, values defined by the issuer.

GenericId

VehicleDynamic

Representing a barcode/tag that is updated as the vehicle progresses along its route.

SEQUENCE

This sequence contains the following fields:

vehicleId: VehicleIdentifier
currentStop: Station
transport Optional: TransportId
line Optional: LineId
terminusStop: Station

VehicleIdentifier

CHOICE

The value of this choice may be one of the following:

evn: ERA European Vehicle Number, including the check digit.

INTEGER
This type is constrained in the following way:

Range

The value must be greater than or equal to: 0

The value must be less than or equal to: 999999999999
vin: VIN per ISO 3779.

VisibleString
This type is constrained in the following way:

Intersection

All the following must be true:

Size

The length of the value must exactly: 17

AND

Permitted alphabet

The characters in the string value must satisfy the following constraint:

Union

Any of the following can be true:

Range

The value must be greater than or equal to: A

The value must be less than or equal to: Z

OR

Range

The value must be greater than or equal to: 0

The value must be less than or equal to: 9
proprietary: Values defined by the issuer.

GenericId

SharedVehicle

Built upon GBFSv3.0. Reference: github.com/MobilityData/gbfs-json-schema/blob/master/v3.0/vehicle_types.json.

SEQUENCE

This sequence contains the following fields:

id: Values defined by the issuer.

GenericId
variety: SharedVehicleVariety
propulsion: SharedVehiclePropulsionType
returnConstraint: SharedVehicleReturnConstraint

/**
*  UIC Fixed Point Data - version 1.0.0
*
*  The UICBarcodeHeader need not be signed (i.e. level1Signature unset), if the situation does not require it.
*
*  ## Optional format for combining a FixedPointData structure with a URL for inclusion in a QR code
*  This is useful, for example, in the case of customer feedback barcodes that should link to the operator's website.
*  for reporting faults, or for directing users to download an app to access a shared vehicle.
*
*  1. Encode this structure in the DOSIPAS format in the usual way, optionally signed
*  2. Base-41 encode the resultant binary data, with the alphabet `0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ$*-.:`; see here: [github.com/sveljko/base41](https://github.com/sveljko/base41)
*  3. Append it to the end of a URL with the prefix `$UIC:`
*
*  Example: `HTTPS://RAIL.EXAMPLE/QRFB/$UIC:A2I9...`
*  n.b. uppercase should be used in the whole URL, as this is much more efficient to encode in a QR code
*
*  ## Encoding in an NFC tag
*  1. Encode this structure in the DOSIPAS format in the usual way, optionally signed
*  2. Place the encoded DOSIPAS in an NDEF record of the format 0x02 (IANA Media Type),
*      with the media type `application/vnd.uic.dosipas.v2` or `application/vnd.uic.dosipas.v1`, as appropriate
*  3. Write the NDEF record to an NDEF formatted NFC tag
*
*  Other records may exist in the same NDEF message. Readers MUST be prepared to look beyond the
*   first record to find a UIC DOSIPAS record.
*/
FixedPointData { iso(1) identified-organization(3) dod(6)
    internet(1) private(4) enterprise(1) uic(17218) fcb(1) modules(0) fpd(6) v1(1) 0 }
    DEFINITIONS AUTOMATIC TAGS ::= BEGIN

EXPORTS FixedPoint, fixedPointData;

IMPORTS GenericId, CompanyCode, Station, CoachPlaces, DATA-ELEMENT, Data, cuperEncoding, SharedVehicleVariety,
 SharedVehiclePropulsionType, SharedVehicleReturnConstraint, TransportId, LineId, UnicodeText
 FROM GeneralData { iso(1) identified-organization(3) dod(6) internet(1) private(4) enterprise(1) uic(17218) fcb(1) modules(0) general(5) v1(1) 0 };

FixedPoint ::= SEQUENCE {
    /**
    * The ID **SHOULD** be eternally unique per issuer.
    */
    id          GenericId,
    /**
    * If different from the security provider.
    * **MUST** be set if the barcode is unsigned (i.e. no security provider).
    */
    issuer      CompanyCode                                             OPTIONAL,
    specimen    BOOLEAN,
    affixedTo   Object                                                  OPTIONAL,
    /**
    * Additional important information about this fixed point.
    */
    infoText    UnicodeText                                             OPTIONAL,
    extension   SEQUENCE (SIZE(1..8)) OF Data{FixedPointExtensions} (WITH COMPONENTS {
        ...,
        format (ALL EXCEPT ("!C" | "!P"))
    }) OPTIONAL,
    ...
}

FixedPointExtensions DATA-ELEMENT ::= { ... }

fixedPointData DATA-ELEMENT ::= { FixedPoint IDENTIFIED BY "FPD1" ENCODED WITH cuperEncoding }

Object ::= CHOICE {
    /**
    * e.g. for check-in/check-out by scanning.
    */
    station         StationPoint,
    /**
    * e.g. for at-seat ordering, customer reporting of vehicle defects, vehicle based check-in.
    */
    vehicle         Vehicle,
    /**
    * e.g. bike, e-scooter, car sharing.
    */
    sharedVehicle   SharedVehicle,
    /**
    * Values defined by the issuer.
    */
    proprietary     GenericId,
    vehicleDynamic  VehicleDynamic,
    ...
}

StationPoint ::= SEQUENCE {
    station                 Station,
    platform                VisibleString   OPTIONAL,
    /**
    * Values defined by the issuer.
    */
    subLocationProprietary  GenericId       OPTIONAL,
    ...
}

Vehicle ::= SEQUENCE {
    id                      VehicleIdentifier,
    /**
    * For identifying at which carriage and seat/compartment this barcode is placed, if at a seat.
    */
    place                   CoachPlaces             OPTIONAL,
    /**
    * When affixed non-seat items or sub-items within a compartment, values defined by the issuer.
    */
    subLocationProprietary  GenericId               OPTIONAL,
    ...
}

/**
* Representing a barcode/tag that is updated as the vehicle progresses along its route.
*/
VehicleDynamic ::= SEQUENCE {
    vehicleId               VehicleIdentifier,
    currentStop             Station,
    transport               TransportId         OPTIONAL,
    line                    LineId              OPTIONAL,
    terminusStop            Station,
    ...
}

VehicleIdentifier ::= CHOICE {
    /**
    * ERA European Vehicle Number, including the check digit.
    */
    evn             INTEGER (0..999999999999),
    /**
    * VIN per ISO 3779.
    */
    vin             VisibleString (SIZE(17) ^ FROM ("A".."Z"|"0".."9")),
    /**
    * Values defined by the issuer.
    */
    proprietary     GenericId,
    ...
}

/**
* Built upon GBFSv3.0.
* Reference: [github.com/MobilityData/gbfs-json-schema/blob/master/v3.0/vehicle_types.json](https://github.com/MobilityData/gbfs-json-schema/blob/master/v3.0/vehicle_types.json).
*/
SharedVehicle ::= SEQUENCE {
    /**
    * Values defined by the issuer.
    */
    id                  GenericId,
    variety             SharedVehicleVariety,
    propulsion          SharedVehiclePropulsionType,
    returnConstraint    SharedVehicleReturnConstraint,
    ...
}

END

Module Info

Exports

Imports

From GeneralData

Assignments

FixedPoint

Size

Fields

Inverse

Union

Single value

Single value

FixedPointExtensions

fixedPointData

Object

StationPoint

Vehicle

VehicleDynamic

VehicleIdentifier

Range

Intersection

Size

Permitted alphabet

Union

Range

Range

SharedVehicle