ApplicationDefines.h

Go to the documentation of this file.

#ifndef _APPLICATIONDEFINES_H_
#define _APPLICATIONDEFINES_H_

#include <functional>
#include <unistd.h>
#include <inttypes.h>

#include <QFlags>
#include <QMetaEnum>

template <typename T1, typename T2> class QMap;

// PATH
extern const char *PATH_BASE_DATA;
extern const char *DATA_PATH_DISPATCHING_DATA_SENDER;
extern const char *APPLICATION_FONT_NAME;
extern const char *FILE_NAME_OPERATING_DATA_BACKUP;
extern const char *FILE_NAME_PROJECT_CONFIGURATION;
extern const char *FILE_NAME_MENU_CONFIGURATION;
extern const char *FILE_NAME_KEYBOARD_CONFIGURATION;
extern const char *FILE_NAME_VIN;
extern const char *FILE_NAME_FINAL_TICKET_COPY;
extern const char *VIN_TEMP_FILE_PATH;
extern const char *CAN_DRIVER_CONFIG_FILE;
extern const char *INV_SOURCE_FILE;

// MENU CATEGORIES
extern const char *MENU_CONFIGURATION_ROOT_ELEMENT_NAME;
extern const char *MENU_CATEGORY_ID_QUICK_ACTIONS;
extern const char *MENU_CATEGORY_ID_COMMON_ACTIONS;
extern const char *MENU_CATEGORY_ID_DEDUCTION;
extern const char *MENU_CATEGORY_ID_LISTS;
extern const char *MENU_CATEGORY_ID_SETTINGS;
extern const char *MENU_CATEGORY_ID_DEVICES;
extern const char *MENU_CATEGORY_ID_DISPATCHING;
extern const char *MENU_CATEGORY_ID_HELP;
extern const char *MENU_CATEGORY_ID_SYSTEM_INFO;

// TICKET TEMPLATES
extern const char *TICKET_TEMPLATE_FINAL_TICKET;
extern const char *TICKET_TEMPLATE_INITIAL_TICKET;
extern const char *TICKET_TEMPLATE_COINER_FINAL_TICKET;
extern const char *TICKET_TEMPLATE_LINES_LIST;
extern const char *TICKET_TEMPLATE_COMMANDS_LIST;
extern const char *TICKET_TEMPLATE_TARIFFS_LIST;
extern const char *TICKET_TEMPLATE_TICKETS_LIST;
extern const char *TICKET_TEMPLATE_BUS_STOP_LIST;
extern const char *TICKET_TEMPLATE_ZONE_BUS_STOPS_LIST;
extern const char *TICKET_TEMPLATE_LINE_TRIPS_LIST;
extern const char *TICKET_TEMPLATE_COMMAND_SEGMENTS_LIST;
extern const char *TICKET_TEMPLATE_PRINTER_TEST;
extern const char *TICKET_TEMPLATE_REFUELING_TICKET;

// SOUNDS
extern const char *SOUND_APPROACH_CARD_FILE_PATH;
extern const char *SOUND_AUDITOR_FILE_PATH;
extern const char *SOUND_UNFINISHED_OPERATION_FILE_PATH;
extern const char *SOUND_EMPTY_WALLET_FILE_PATH;
extern const char *SOUND_NEW_TEXT_MESSAGE_RECEIVED_FILE_PATH;
extern const char *SOUND_PRINT_PAUSED_REMOVE_OBSTACLE_FILE_PATH;
extern const char *SOUND_EVALUATE_QR_TICKET_OK;
extern const char *SOUND_EVALUATE_QR_TICKET_ERROR;
extern const char *SOUND_APPLY_QR_CODE;

// SCREEN SAVER WAKE UP EVENTS
extern const char *SCREEN_SAVER_WAKE_UP_EVENT_BUS_STOP_ARRIVAL;
extern const char *SCREEN_SAVER_WAKE_UP_EVENT_NEW_TEXT_MESSAGE_RECEIVED;

// DISPATCHING ANNOUNCEMENTS
extern const char *XML_ANNOUNCEMENT_NODE_NAME;
extern const char *XML_ANNOUNCEMENT_ID_ATTRIBUTE_NAME;
extern const char *XML_ANNOUNCEMENT_AUDIO_CHANNEL_ATTRIBUTE_NAME;
extern const char *XML_ANNOUNCEMENT_SOUND_FILE_NODE_NAME;
extern const char *XML_ANNOUNCEMENT_PANEL_ANNOUNCEMENT_NODE_NAME;

#define DEFAULT_TABLE_TEXT_POSITION_Y                           13
#define DEFAULT_TABLE_TEXT_FONT_SIZE                            4

// Monitoring
#define MONITORING_CONNECTION_ADDRESS                           "tcp://127.0.0.1:4950"
#define MONITORING_RESPONSE_TIMEOUT                             5000
#define MONITORING_CONNECTION_TIMEOUT                           5000

#define MINUTES_PER_DAY                                         1440
#define DEFAULT_PRE_PRINT_VALUE                                 70
#define DEFAULT_LED_NOTIFICATION_DURATION                       3

class ApplicationDefines : public QObject
{
    Q_OBJECT
public:
    enum ResultValue : int
    {
        // Core results
        Ok                                                      = 0,
        ErrorInitTranslator                                     = 1,
        ErrorInitInputData                                      = 2,
        ErrorInitSCS                                            = 3,
        ErrorInitFonts                                          = 4,
        ErrorInitDispatching                                    = 5,
        ErrorInitDevices                                        = 6,
        ErrorInitStatistics                                     = 7,
        ErrorHwConfigNotFound                                   = 8,
        ErrorHwConfigParseError                                 = 9,
        ErrorGetTariffGroupOnSection                            = 10,
        ErrorLoadTariffSystemData                               = 11,
        ErrorLoadTariffList                                     = 12,
        ErrorUpdateTariffList                                   = 13,
        ErrorRecalculateAndShowPrice                            = 14,
        ErrorInitDispatchingTextMessages                        = 15,

        // Input data results
        ErrorInvalidInputData                                   = 100,
        ErrorGetTariffSettingValue                              = 101,
        ErrorInvalidTariffSystemSettings                        = 102,
        ErrorInvalidTimeTableData                               = 103,

        // Statistic results
        ErrorStatisticsError                                    = 200,
        ErrorCreateAndFillDeductionNumber                       = 201,
        ErrorDifferentDeductionVersions                         = 202,
        ErrorFillSAMNumberToDeductionNumber                     = 203,
        ErrorCreateAndFillChangeTripStatisticRecord             = 204,
        ErrorInvalidDeductionNumber                             = 205,
        ErrorDriverIsNotLoggedInToStatistic                     = 206,
        ErrorOpenDeduction                                      = 207,
        ErrorOpenDailyIdentificationRecord                      = 208,

        // Ticket issue results
        ErrorNotMultipleOfValue                                 = 300,
        ErrorValueUnderLimit                                    = 301,
        ErrorValueOverLimit                                     = 302,
        ErrorInitTicketIssueLogic                               = 303,
        ErrorWriteDataOnCard                                    = 304,
        MultiplePassengersOnTimeTicketPossible                  = 305,

        // Application logic results
        ErrorUnsupportedTypeOfCancellationBehaviour             = 400,
        ErrorPrepareTicketForCancel                             = 401,
        ErrorTicketWasAlreadyCancelled                          = 402,
        ErrorGetDeviceInformation                               = 403,
        ErrorProcessIssueLogicOutputData                        = 404,
        ErrorSoundNotCreated                                    = 405,
        ErrorPrintTicket                                        = 406,
        ErrorNullStateLogic                                     = 407,
        ErrorPrintPreFinalTicket                                = 408,
        ErrorCommunicationCentre                                = 409,
        ErrorIncorrectPlayerChannel                             = 410,
        ErrorNullBusinessLogic                                  = 411,
        ErrorBusinessLogicFailure                               = 412, // generic error when business logic (any) method returns failure output

        // State machine results
        ErrorFatalErrorApplicationInitState                     = 500,
        ErrorInvalidStateDictionaryData                         = 501,
        ErrorInvalidStateTransitionData                         = 502,
        ErrorInvalidStateInputData                              = 503,

        // Database results
        ErrorOpenDatabase                                       = 600,
        ErrorPrepareDatabaseQuery                               = 601,
        ErrorExecuteDatabaseQuery                               = 602,
        ErrorDatabaseNotOpen                                    = 603,
        ErrorFailedToExecuteSQLQuery                            = 604,
        ErrorFailedToSaveIDAfterInsert                          = 605,
        ErrorInvalidDatabaseTransaction                         = 606,
        ErrorDatabaseUpdateFailed                               = 607,

        ErrorOffsetMin                                          = 9999,
        ErrorOffsetTicketIssueLogic                             = 10000, // V intervale od 10 000 .. 20 000 - chyba vydaja listka
        ErrorOffsetStatistic                                    = 20000, // V intervale od 20 000 .. 30 000 - chyba pocas prace so statistikou
        ErrorOffsetSmartCardSystem                              = 30000, // V intervale od 30 000 .. 40 000 - chyba pocas prace s kartovym systemom
        ErrorOffsetDataIO                                       = 40000, // V intervale od 40 000 .. 50 000 - chyba vstupnych dat
        ErrorOffsetEmvTerminal                                  = 60000, // V intervale od 50 000 .. 70 000 - chyba pocas prace s EMV terminalom (dvojnasobny rozsah z dovodu zapornych navratovych hodnot EMV terminalu)
        ErrorOffsetMax                                          = 69999
    };
    Q_ENUM( ResultValue );

    enum BusinessLogicLifeTimeType
    {
        LifeTimeUndefined                                       = 0,
        LifeTimePersistent                                      = 1,
        LifeTimeTransient                                       = 2
    };
    Q_ENUM( BusinessLogicLifeTimeType )

    enum BusinessLogicType
    {
        UndefinedBusinessLogic                                  = 0,
        PrinterBusinessLogic                                    = 1,
        CommandSegmentsBusinessLogic                            = 2,
        DeductionBusinessLogic                                  = 3,
        DailyIdentificationRecordBusinessLogic                  = 4,
        DriverIdentificationBusinessLogic                       = 5,
        GPSBusinessLogic                                        = 6,
        PassengerCountBusinessLogic                             = 7,
        StatisticBusinessLogic                                  = 8,
        VehicleIdentificationBusinessLogic                      = 9,
        TicketSummaryBusinessLogic                              = 10,
        TableBusinessLogic                                      = 11,
        PrinterDisplayBusinessLogic                             = 12,
        DispatchingBusinessLogic                                = 13,
        TicketCancellationBusinessLogic                         = 14,
        BusStopCommentBusinessLogic                             = 15,
        SpecialTextOnTableBusinessLogic                         = 16,
        AnnouncementSoundBusinessLogic                          = 17,
        SlaveBusinessLogic                                      = 18,
        PlayerBusinessLogic                                     = 19,
        TripTransfersAndDelaysBusinessLogic                     = 20,
        SmartCardServiceBusinessLogic                           = 21,
        ContinuousTripBusinessLogic                             = 22,
        AutomaticBrightnessBusinessLogic                        = 23,
        DeviceInformationBusinessLogic                          = 24,
        DeviceLockBusinessLogic                                 = 25,
        LedNotificationBusinessLogic                            = 26,
        AutomaticCardHandlingBusinessLogic                      = 27,
        DataSynchronizationBusinessLogic                        = 28,
        CommunicationCentreBusinessLogic                        = 29,
        MonitoringBusinessLogic                                 = 30,
        TicketIssueBusinessLogic                                = 31,
        PowerLossBusinessLogic                                  = 32,
        EMVTerminalBusinessLogic                                = 33,
        DispatchingTextMessagesBusinessLogic                    = 34,
        CameraBusinessLogic                                     = 35,
        ModelRouteBusinessLogic                                 = 36,
        RegistrationTicketBusinessLogic                         = 37,
        EngineStateBusinessLogic                                = 38,
        DigitalInputPinBusinessLogic                            = 39,
        TripStartAcousticSignalizationBusinessLogic             = 40,
        AccidentBusinessLogic                                   = 41,
        BeeperBusinessLogic                                     = 42,
        CrossroadPreferencesBusinessLogic                       = 43,
        UnpaidExpenseBusinessLogic                              = 44,
        ManualPricelistRowBusinessLogic                         = 45,
        DestinationBusStopOrZoneSelectionBusinessLogic          = 46,
        TransfareInfoProviderBusinessLogic                      = 47,
        BusTableInterchangesBusinessLogic                       = 48,
        BusTableMessageFromDispatchingBusinessLogic             = 49,
        QadraMessagesToDispatchingBusinessLogic                 = 50,
        BarcodeEvaluatingBusinessLogic                          = 51,
        TripGuaranteedConnectionsBusinessLogic                  = 52,
        TripGetPlatformChangeBusinessLogic                      = 53,
        SystemTimeSynchronizationBusinessLogic                  = 54,
        BusinessLogicCount                                      = 55
    };
    Q_ENUM( BusinessLogicType )

    enum DatabaseServiceType
    {
        UndefinedDatabaseService                                = 0,
        DatabaseServiceModelRoute                               = 1,
        DatabaseServiceCount                                    = 2
    };

    enum NetworkRequestType
    {
        NetworkRequestUndefined                                 = 0,
        //NetworkRequestModelRoute                              = 1, Obsolete
        NetworkRequestModelRouteGzipped                         = 2,
        NetworkRequestAutomaticLogin                            = 3,
        NetworkRequestInputDataCheck                            = 4,
        NetworkRequestCrossroadPreferences                      = 5,
        NetworkRequestBusTableInterchanges                      = 6,
        NetworkRequestBusTableMessagesFromDispatching           = 7,
        NetworkRequestQadraMessagesToDispatching                = 8,
        NetworkRequestTripGuaranteedConnections                 = 9,
        NetworkRequestTripsDelays                               = 10,
        NetworkRequestTripGetPlatformChange                     = 11
    };
    Q_ENUM( NetworkRequestType )

    enum WebSocketType
    {
        WebSocketTypeUndefined                                  = 0,
        WebSocketTypeAutomaticLogin                             = 1
    };

    enum NetworkRequestParameter
    {
        NetworkRequestParameterUndefined                        = 0x00,
        NetworkRequestParameterReplyInRawGzippedData            = 0x01
    };

    enum CardReadIntention
    {
        IntentionUndefined                                      = 0,
        IntentionToShowCardInfo                                 = 1,
        IntentionToCancelTicket                                 = 2,
        IntentionToDriverIdentification                         = 3,
        IntentionToSellOneWayTicket                             = 4,
        IntentionToCreditRecharge                               = 5,
        IntentionToTimeTicketProlongation                       = 6,
        IntentionToTimeTicketSell                               = 7,
        IntentionToDispatcherLogin                              = 8
    };
    Q_ENUM( CardReadIntention )

    enum InformationIconIndex
    {
        InformationIconIndexDeviceStatus                        = 0,
        InformationIconIndexDataSynchronization                 = 1,
        InformationIconIndexGPRSStatus                          = 2,
        InformationIconIndexWiFiStatus                          = 3,
        InformationIconIndexGPSStatus                           = 4,
        InformationIconIndexMessageCommunication                = 5,
        InformationIconIndexDeviceInformation                   = 6,
        InformationIconIndexCamera                              = 7,
        InformationIconIndexVoipStatus                          = 8,
        InformationIconsCount                                   = 9
    };

    enum InformationIconStatus
    {
        InformationIconStatusUnknown                            = -1,

        DeviceStatusUnknown                                     = 0,
        DeviceStatusBroken                                      = 1,
        DeviceStatusOperational                                 = 2,

        DataSynchronizationStatusUnknown                        = 10,
        DataSynchronizationStatusDataNOTSynchronized            = 11,
        DataSynchronizationStatusDataSynchronized               = 12,
        DataSynchronizationStatusSynchronizationInProgress      = 13,

        GPRSStatusUnknown                                       = 20,
        GPRSStatusDisabled                                      = 21,
        GPRSStatusNoSignal                                      = 22,
        GPRSStatusLowSignal                                     = 23,
        GPRSStatusMediumSignal                                  = 24,
        GPRSStatusHighSignal                                    = 25,
        GPRSStatusFullSignal                                    = 26,

        WiFiStatusUnknown                                       = 30,
        WiFiStatusDisabled                                      = 31,
        WiFiStatusLowSignal                                     = 32,
        WiFiStatusMediumSignal                                  = 33,
        WiFiStatusHighSignal                                    = 34,
        WiFiStatusFullSignal                                    = 35,

        GPSStatusUnknown                                        = 40,
        GPSStatusDisabled                                       = 41,
        GPSStatusSearching                                      = 42,
        GPSStatusReady                                          = 43,

        MessageCommunicationStatusUnknown                       = 50,
        MessageCommunicationStatusDisabled                      = 51,
        MessageCommunicationStatusAlert                         = 52,
        MessageCommunicationStatusDefault                       = 53,
        MessageCommunicationStatusNewMessage                    = 54,
        MessageCommunicationStatusCommentAll                    = 55,

        DeviceInformationStatusNoInformation                    = 60,
        DeviceInformationStatusWarning                          = 61,
        DeviceInformationStatusWarningGreen                     = 62,
        DeviceInformationStatusWarningRed                       = 63,

        CameraStatusFunctionalityDisabled                       = 70,
        CameraStatusFunctionalityEnabled                        = 71,

        VoipStatusIdle                                          = 80,
        VoipStatusCallRequestSent                               = 81,
        VoipStatusCallConnected                                 = 82
    };

    enum StateRequestCode
    {
        RequestCodeUndefined                                    = 0,
        RequestCodeFinishImpulse                                = 1,
        RequestCodeOneWayTicketIssueCash                        = 2,
        RequestCodeOneWayTicketIssueCard                        = 3,
        RequestCodeAuditorPrintLists                            = 4,
        RequestCodeAutoIssue                                    = 5,
        RequestCodeCloseDailyIdentificationRecord               = 6
    };

    enum StateResultCode
    {
        ResultCodeUndefined                                     = 0,
        ResultCodeFinishImpulseWriteOK                          = 1,
        ResultCodeFinishImpulse                                 = 2,
        ResultCodeFinishAutoAuditorReaderBlocked                = 3,
        ResultCodeFinishAutoAuditorReaderUnblocked              = 4,
        ResultCodeFinishAutoAuditorError                        = 5,
        ResultCodeDailyIdentificationRecordClosed               = 6
    };

    enum ExtraOperationGeneralCheck
    {
        ExtraOperationGeneralCheckUndefined                     = 0x0,
        ExtraOperationGeneralCheckAllowedCardCompany            = 0x1,
        ExtraOperationGeneralCheckWhetherStatisticIsOpen        = 0x2
    };

    enum OperatorLoginType
    {
        OperatorLoginDriver                                     = 0,
        OperatorLoginDispatcher                                 = 1,
        OperatorLoginDriverChange                               = 2
    };

    enum IssueOutMethod
    {
        IssueOutOnEscape                                        = 0,
        IssueOutOnTimeout                                       = 1
    };

    enum AuditorPrintLists
    {
        AuditorPrintBusStopsAndTickets                          = 0,
        AuditorPrintBusStopsAndTicketsAndTariffZones            = 1,
        AuditorPrintNothing                                     = 2
    };

    enum UnlockPeripheralsOnArrivalMode
    {
        DoNotUnlockPeripherals                                  = 0,
        UnlockPeripherals                                       = 1,
        UnlockPeripheralsOnlyIfLockedByDriver                   = 2
    };

    enum DispatchingSystemErrorID
    {
        // driver bug report IDs 257-267
        UnspecifiedError                                        = 257,
        TicketIssueError                                        = 258,
        TicketPrinterError                                      = 259,
        CardError                                               = 260,
        PaymentCardError                                        = 261,
        BusStopSwitchingError                                   = 262,
        ApplicationRestart                                      = 263,
        ApplicationSlowness                                     = 264,
        SlaveError                                              = 265,
        CameraError                                             = 266,
        InformationPanelsError                                  = 267,

        InternalBugReport                                       = 271
    };

    enum AutoModule
    {
        AutoModuleNone                                          = 0x0000,
        AutoModuleAuditor                                       = 0x0001,
        AutoModuleTicketIssue                                   = 0x0002,
        AutoModuleInfo                                          = 0x0004
    };

    enum PrinterState
    {
        PrinterReady                                            = 0,
        PrinterWarning                                          = 1,
        PrinterError                                            = 2
    };

    enum MonitoringDeviceStatus
    {
        MonitoringDeviceStatusUnknown                           = 0,
        MonitoringDeviceStatusOK                                = 1,
        MonitoringDeviceStatusWarning                           = 2,
        MonitoringDeviceStatusError                             = 3
    };

    enum StateImportanceType
    {
        //StateImportanceTypeOK                                 = 0, unused
        //StateImportanceTypeDontTrack                          = 1, unused
        //StateImportanceTypeTrack                              = 2, unused
        StateImportanceTypeWarning                              = 3,
        StateImportanceTypeError                                = 4
    };

    enum CustomApplicationEventType
    {
        CustomEventReplyToTextMessageConfirmed                  = 1,
        CustomEventReplyToTextMessageClosed                     = 2,
        CustomEventReplyToTextMessageRead                       = 3,
        CustomEventBusStopDeparture                             = 4,
        CustomEventBusStopArrival                               = 5,
        CustomEventSynchroPointArrival                          = 6,
        CustomEventBusStopDelayTimeout                          = 7,
        CustomEventSynchroPointDelayTimeout                     = 8,
        CustomPopUpMessageCreatedEventType                      = 9,
        CustomPopUpMessageHiddenEventType                       = 10,
        CustomLastPopUpMessageClosedEventType                   = 11,
        CustomEventDisplayToastPrinterLowPaper                  = 12,
        CustomEventPowerButtonPressed                           = 13
    };

    enum DefaultIssueWindowFocus
    {
        IssueWindowFocusCheckinBusStop,
        IssueWindowFocusCheckoutBusStop,
        IssueWindowFocusTariff,
        IssueWindowFocusPassengerCount,
        IssueWindowFocusDontChange
    };

    enum EmvTransactionIntention
    {
        EmvIntentionUndefined,
        EmvIntentionPayment,
        EmvIntentionHandshake,
        EmvIntentionCallParamsB,
        EmvIntentionCallParamsN,
        EmvIntentionPassivate,
        EmvIntentionReversal
    };

    Q_DECLARE_FLAGS( AutoModules, AutoModule )

    using ButtonAction = std::function<void()>;

    template<typename QEnum>
    static QString QtEnumToString( const QEnum value )
    {
        return QString( QMetaEnum::fromType<QEnum>().valueToKey( value ) );
    }

private:
    ApplicationDefines();
};

Q_DECLARE_OPERATORS_FOR_FLAGS( ApplicationDefines::AutoModules )

#endif // _APPLICATIONDEFINES_H_