uicstationcode.h

/*
    SPDX-FileCopyrightText: 2021 Volker Krause <vkrause@kde.org>
 
    SPDX-License-Identifier: LGPL-2.0-or-later
*/
 
#ifndef KPUBLICTRANSPORT_UICSTATIONCODE_H
#define KPUBLICTRANSPORT_UICSTATIONCODE_H
 
#include <cstdint>
#include <vector>
 
class QString;
class QStringView;
 
namespace KPublicTransport {
 
 
/** Utility functions for dealing with UIC station codes.
 *  Also works for the syntactically identical IBNR station codes.
 */
namespace UicStationCode
{
 
/** Returns @c true if @p id is a valid UIC station code.
 *  @params allowedCountryCodes if non-empty, only UIC station codes with an UIC country code included
 *  in that list are considered valid. This list has to be sorted.
 */
[[nodiscard]] bool isValid(QStringView id, const std::vector<uint8_t> &allowedCountryCodes = {});
 
/** Returns the country code of a given valid UIC station code. */
[[nodiscard]] QStringView country(QStringView id);
 
/** The identifier type for use in @c Location::identifer for UIC station ids. */
[[nodiscard]] QString identifierType();
 
}
 
}
 
#endif // KPUBLICTRANSPORT_UICSTATIONCODE_H