vdvticket.h

/*
    SPDX-FileCopyrightText: 2019 Volker Krause <vkrause@kde.org>
 
    SPDX-License-Identifier: LGPL-2.0-or-later
*/
 
#pragma once
 
#include "kitinerary_export.h"
 
#include <KItinerary/Person>
 
#include <QDateTime>
#include <QExplicitlySharedDataPointer>
#include <QMetaType>
 
namespace KItinerary {
 
class VdvTicketHeader;
class VdvTicketPrivate;
class VdvTicketCommonTransactionData;
class VdvTicketIssueData;
class VdvTicketTrailer;
namespace BER { class Element; }
 
/** Ticket information from a VDV barcode.
 *  For use by tooling or custom extractor scripts.
 */
class KITINERARY_EXPORT VdvTicket
{
    Q_GADGET
    /** Begin of the validitiy of this ticket. */
    Q_PROPERTY(QDateTime beginDateTime READ beginDateTime)
    /** End of the validity of this ticket. */
    Q_PROPERTY(QDateTime endDateTime READ endDateTime)
 
    /** VDV organization identifier of the ticket issuer. */
    Q_PROPERTY(int issuerId READ issuerId)
    /** VDV organization identifier of the operator. */
    Q_PROPERTY(int operatorId READ operatorId)
    /** Service class for this ticket. */
    Q_PROPERTY(ServiceClass serviceClass READ serviceClass)
    /** The person this ticket is valid for. */
    Q_PROPERTY(KItinerary::Person person READ person)
    /** Ticket number. */
    Q_PROPERTY(QString ticketNumber READ ticketNumber)
 
    Q_PROPERTY(QByteArray rawData READ rawData STORED false)
 
public:
    VdvTicket();
    VdvTicket(const QByteArray &data, const QByteArray &rawData);
    VdvTicket(const VdvTicket&);
    ~VdvTicket();
    VdvTicket& operator=(const VdvTicket&);
 
    QDateTime beginDateTime() const;
    QDateTime endDateTime() const;
    int issuerId() const;
    int operatorId() const;
 
    enum ServiceClass {
        UnknownClass = 0,
        FirstClass = 1,
        SecondClass = 2,
        FirstClassUpgrade = 3
    };
    Q_ENUM(ServiceClass)
    ServiceClass serviceClass() const;
 
    Person person() const;
    QString ticketNumber() const;
 
    // low-level content access
    const VdvTicketHeader* header() const;
    BER::Element productData() const;
    const VdvTicketCommonTransactionData* commonTransactionData() const;
    BER::Element productSpecificTransactionData() const;
    const VdvTicketIssueData* issueData() const;
    const VdvTicketTrailer* trailer() const;
 
    /** Raw data of this ticket.
     *  Useful for generating a barcode for it again.
     */
    QByteArray rawData() const;
 
private:
    QExplicitlySharedDataPointer<VdvTicketPrivate> d;
};
 
}