ApplicationState.h

Go to the documentation of this file.

#ifndef ESTATEAPP_H
#define ESTATEAPP_H

#include <QString>
#include <QSharedPointer>

#include "appcore/statelogic/State.h"
#include "ApplicationStateDefines.h"
#include "core/ApplicationDefines.h"
#include "businesslogic/location/GPSDefines.h"
#include "commondevices/emvterminaldriver/EMVDefines.h"
#include "businesslogic/dispatching/DispatchingTextMessagesReceiver.h"
#include "obcdevices/connboarddriver/ConnboardDefines.h"
#include "commondevices/slavedriver/ESlaveStruct.h"
#include "commondevices/emvterminaldriver/terminalFwUpdate/EmvTerminalFwUpdate.h"
#include "commondevices/emvterminaldriver/terminalCallForParams/EmvTerminalCallForParams.h"

class MenuCommand;
class ApplicationStateManager;
class WindowManager;
class BusinessLogicManager;
class UniversalDictionary;
class StateLogic;
class DeviceIdentifierForMenu;
class RouteSynchroPoint;
class Announcement;

namespace MonitoringDevices
{
    class MonitoringDeviceStatus;
}

class ApplicationState : public State
{
    Q_OBJECT
public:
    virtual void OnSecondTick();
    virtual void OnLeave();

    // gps functionality
    virtual void OnBusStopArrival( const int tripBusStopIndex, const GPSDefines::BusStopChangeType busStopChangeType );
    virtual void OnBusStopDeparture( const int tripBusStopIndex, const GPSDefines::BusStopChangeType busStopChangeType );
    virtual void OnSynchroPointArrival( const RouteSynchroPoint &routeSynchroPoint, const int tripBusStopIndex );
    virtual void OnSynchroPointDelayTimeout( const RouteSynchroPoint &routeSynchroPoint, const int tripBusStopIndex );
    virtual void OnSynchroPointDelayTimeout( const int tripBusStopIndex );

    // printer functionality
    virtual void OnPrinterReady();
    virtual void OnPrinterError();
    virtual void OnPrinterPaperLow( const int printerId );
    virtual void OnPrinterPaperFilled( const int printerId );
    void CheckPrinterLowPaperStateAndDisplayToastIfNeeded();
    void OnDisplayToastPrinterLowPaper();
    virtual void OnPrintFinished();

    // card functionality
    virtual void OnCardIn( const std::string &cardUID );
    virtual void OnCardOut();
    virtual void WriteOK();
    virtual void WriteError();
    virtual void ReadError();
    virtual void DataReceived();
    virtual void OnExtraOperationStart( QString message, long timeout, ApplicationStateDefines::MessageWindowType messageType );
    virtual void OnExtraOperationFinish( QString message, long timeout, ApplicationStateDefines::MessageWindowType messageType );
    virtual void OnSCSReady();
    virtual void SCSLocked();
    virtual void SCSUnlocked();
    virtual void OnUnfinishedOperation();
    virtual void OnSamUpdateCheck( ApplicationDefines::ResultValue status );
    virtual bool OnEMVCardPresent( const QString &pan );

    // panel functionality
    virtual void OnPanelActionButtonClicked();
    virtual void OnInformationButtonClicked();
    virtual void OnGPSStatusIconClicked();
    virtual void OnDeviceStatusIconClicked();
    virtual void OnMessageIconClicked();
    virtual void OnCameraIconClicked();

    // GPS functionality
    virtual void OnGpsOk();
    virtual void OnGpsError();
    virtual void OnPositionChanged( long latitude, long longitude, double altitude, double speed, long numberOfSatellites );

    // slave functionality
    virtual void OnIncorrectlyProcessedDataOnSlave();
    virtual void OnSlavePassengerCheckedIn( long passengerCount );
    virtual void OnSlaveConnected( long clientID );
    virtual void OnSlaveDisconnected( long clientID );
    virtual void OnSlaveTicketInformation( const QString &ticketInformation, const bool isTicketIssuedOnSlave );
    virtual void OnSlaveAuditor();
    virtual void OnSlaveActualTimeRequest( long clientID );
    virtual void OnSharedPaymentTerminalReady();

    // communication center functionality
    void OnReceiveFileStart( const char *fileName );
    void OnReceiveFileProgress( const char *fileName, long percentage );
    void OnReceiveFileOk();
    void OnReceiveFileError();

    // transfer file to slaves (also communication center functionality)
    virtual void OnTransferFileToSlaveStarted();
    virtual void OnTransferFileToSlaveProgress( const int percent, const QString &filename );
    virtual void OnTransferFileToSlaveSuccess();
    virtual void OnTransferFileToSlaveError();
    virtual void OnTransferFilesToAllSlavesFinished();

    // NON-emcommd type slave update
    virtual void OnSlaveUpdateStarted( const int slaveID );
    virtual void OnSlaveUpdateProgress( const int slaveID, const int progressPercent );
    virtual void OnSlaveUpdateFinished( const int slaveID );
    virtual void OnSlaveUpdateText( const int slaveID, const QString &text );

    // menu functionality
    virtual void OnMenuCommandSelected( MenuCommand *menuCommand );

    // menu action functionality
    virtual void OnMenuActionAccident();
    virtual void OnMenuActionSelectAnotherTrip();
    virtual void OnMenuActionFinishState();
    virtual void OnMenuActionChangeState( const QString stateName, const StateDefines::ChangeStateFlag changeStateFlag = StateDefines::ChangeStateFlagUndefined );
    virtual void OnMenuActionChangeStateToApproachCard( const ApplicationDefines::CardReadIntention cardReadIntention );
    virtual void OnMenuActionChangeIssueMode();
    virtual void OnMenuActionTicketSummary();
    virtual void OnMenuActionCurrentTripInformation();
    virtual void OnMenuActionEmergencyMessageToDispatching();
    virtual void OnMenuActionSelectDeviationBusStops();
    virtual void OnMenuActionEMVPaymentTransaction();
    virtual void OnMenuActionEMVHandshakeTransaction();
    virtual void OnMenuActionEMVCallParamsTransaction( EM::Devices::EMVDefines::ProtocolTypeRequest protocolTypeRequest );

    // monitoring functionality
    virtual void OnMonitoringDataFromAnalyzerReceived( const QString &data );
    virtual void OnMonitoringDataFromSingleDeviceReceived( const MonitoringDevices::MonitoringDeviceStatus &status );

    // barcode scanning functionality
    virtual void OnBarcodeScanned( const QByteArray &barcode );
    virtual void OnBarcodeProcessReceived( const EM::Devices::BarcodeDataMap &barcodeDataMap );

    // EMV Terminal functionality
    void SetEmvTransactionIntention( const ApplicationDefines::EmvTransactionIntention &emvTransactionIntention );
    ApplicationDefines::EmvTransactionIntention GetEmvTransactionIntention() const;
    virtual void OnEMVActivityInfoMessage( QString message );
    virtual void OnEMVPaymentSuccesfull( unsigned long amount, QString cardNumber, QString cardBranch, QString approvalCode, QString serialNumber, QString terminalId, QString invoiceNumber );
    virtual void OnEMVPaymentUnsuccesfull( long terminalError, QString message, QString terminalId, QString invoiceNumber );
    virtual void OnEMVPassivateSuccesfull( unsigned long amount, QString message, QString terminalId );
    virtual void OnEMVPassivateUnsuccesfull( long terminalError, QString message, QString terminalId );
    virtual void OnEMVPassivatePaymentNotActive( QString message, QString terminalId );
    virtual void OnEMVReversalSuccesfull( QString terminalId );
    virtual void OnEMVReversalUnsuccesfull( long terminalError, QString message, QString terminalId );
    virtual void OnEMVHandshakeSuccesfull( QString message, QString terminalId );
    virtual void OnEMVHandshakeUnsuccesfull( long terminalError, QString message, QString terminalId );
    virtual void OnEMVLedState( EM::Devices::EMVDefines::EMVLedState ledState );
    virtual void OnEMVBuzzerState( EM::Devices::EMVDefines::EMVBuzzerState buzzerState );
    virtual void OnEMVNonEMVCardPresent( EM::Devices::EMVDefines::EMVAntennaStatus antennaStatus, QByteArray cardUid );
    virtual void OnEMVCloseTotalsSuccessful( QString terminalSums, QString terminalId );
    virtual void OnEMVCloseTotalsUnsuccessful( long terminalError, QString terminalId );
    virtual void OnEMVCallParamsSuccesfull( QString message, QString terminalId );
    virtual void OnEMVCallParamsUnsuccesfull( long terminalError, QString message, QString terminalId );
    virtual void OnEMVReadStoplistVersion( QString stoplistVersion, QString stoplistValidity );
    virtual void OnEMVGetLastTransaction( const EM::Devices::EMVDefines::EMVTerminalErrorCode &responseCode, const QDateTime &transactionDateTime, const QString &message, const unsigned long &amount, const QString &cardNumber, const QString &cardBranch, const QString &approvalCode, const QString &serialNumber, const QString &terminalId, const QString &invoiceNumber );
    virtual void OnEMVUpdateStatus( const EM::Devices::EMVDefines::EMVTerminalStatus &terminalStatus );
    virtual void OnEMVGetTerminalStatus( const EM::Devices::EMVDefines::EMVTerminalStatus &terminalStatus );
    virtual void OnEMVTerminalInTransaction( const bool isEmvTerminalInTransaction );
    virtual void OnEMVSetLocalFTPForUpdate( const EM::Devices::EMVDefines::EMVTerminalErrorCode responseCode );
    virtual void OnSlaveEmvResult( const EM::Devices::SlaveEmvResult &slaveEmvResult );
    virtual void OnSlaveEmvTerminalUpdateProcessResult( const int slaveID, const EmvTerminalFwUpdate::UpdateProcessState result );
    virtual void OnSlaveEmvTerminalCallForParamsResult( const int slaveID, const EmvTerminalCallForParams::CallForParamsProcessState result );

    bool LockSCSImmediately( bool displayToastErrorMessageIfLockingFailed = true );

    // automatic passenger counting functionality
    virtual void OnAutomaticPassengerCountResultsArrived( const uint16_t boardingCount, const uint16_t alightingCount );
    virtual void OnAutomaticPassengerCountResultsArrived( const uint8_t fullness, const uint16_t capacity, const uint16_t passengerCount, const QString &calculationTime, const uint32_t busStopID, const uint8_t busStopOrder );

    // connboard events
    virtual void OnDigitalInputChanged( const unsigned char pinNumber, const bool pinValue );
    virtual void OnTemperatureChanged( const EM::Devices::ConnboardDefines::TemperatureSensorIndexToTemperatureValueMap &temperatures );
    virtual void OnFuelTankOpenClosedStateChanged( const bool fuelTankIsOpen );

    // messages from dispatching functionality
    virtual void OnReceiveTextMessage( const QDateTime &messageTime, const QString &messageText, const uint32_t messageID, const bool showPopUp = true );
    virtual void OnReceivePredefinedMessages( const PredefinedMessages &predefinedMessages, const DispatchingTextMessagesReceiver::ReceivedMessageNotificationType receivedMessageNotificationType );
    virtual void OnReplyToTextMessageClosed();
    virtual void OnReplyToTextMessageConfirmed( const QDateTime &messageTime, const QString &messageText, const uint32_t messageID );
    virtual void OnReplyToTextMessageMarkAsRead( const QDateTime &messageTime, const uint32_t messageID );

    virtual void OnPopUpMessageCreated();
    virtual void OnPopUpMessageHidden();
    virtual void OnLastPopUpMessageClosed();

    // voip functionality
    virtual void OnVoipMakingCallFailed( const bool isEmergencyCall, const int errorCode );
    void RetryToMakeACallDefaultButtonHandler( const bool isEmergencyCall );

    virtual void OnNetworkReply( ApplicationDefines::NetworkRequestType networkRequestType, const QJsonDocument &replyData );
    virtual void OnNetworkReply( const ApplicationDefines::NetworkRequestType networkRequestType, const QByteArray &replyData );
    virtual void OnNetworkReplyTimeout( const ApplicationDefines::NetworkRequestType networkRequestType );
    virtual void OnWebSocketMessage( ApplicationDefines::WebSocketType webSocketType, const QJsonDocument &replyData );
    virtual void OnNetworkReplyError( const ApplicationDefines::NetworkRequestType networkRequestType );

    // data update
    virtual void OnDataUpdateStarted();
    virtual void OnDataUpdateFinished();

#ifdef DEVELOP
    // developer utilities
    virtual void ShowModelRouteSimulator();
    virtual void ShowGPSTestConfigCreator();
    virtual void FillGPSTestEvents();
#endif

    void OnPanicButtonPushed();
    void OnIgnitionStateReceived( const bool ignitionState );

    void OnPowerButtonPressed();

    void OnQadraRealtimeDataReceived( const QStringList &realtimeData );
    void OnQadraSynchronizeDateTime( const long long diffSecs );

    // announcements from dispatching
    void OnAnnouncementFromDispatchingReceived( const Announcement &announcement );

protected:
    ApplicationState( const QString &stateName, ApplicationStateManager *stateManager );
    virtual ~ApplicationState();

    void RegisterStateLogic( StateLogic *stateLogic );
    StateLogic *GetStateLogicByType( ApplicationStateDefines::StateLogicType stateLogicType );

    BusinessLogicManager *GetBusinessLogicManager() const;
    ApplicationStateManager *GetStateManager() const;
    WindowManager *GetWindowManager() const;

    void DefaultOnSlaveConnected( long clientID );
    void DefaultOnUnfinishedOperation();
    void RefreshDataSynchronizationIcon();

    // device blocking functionality
    void HideReaderBlockedToastMessage();
    void LockIssue( const bool lockByDriver = false );
    void UnlockIssue();

    bool CloseDeductionAndPrintFinalTicket();

    void CloseDailyRecordAndDeductionOnNewMonth();

    ApplicationDefines::ResultValue InvokeBreakWriteRequest( bool &isInWritingProcess );

    void ChangeStateToDispatcherLogin( bool printTicketEnabled );
    void ChangeStateToTicketIssue( StorageList storageList );
    void ChangeStateToEnterDailyIdentificationRecord();

    // methods handling print failed becouse of obstacle
    void ShowToastObstacleCausedFailedPrint();
    bool IsToastObstacleCausedFailedPrintDisplayed() const;
    void HideToastObstacleCausedFailedPrint();

    void OnBatteryVoltageAction( const uint16_t batteryVoltage );

signals:
    void OnLeavingState();

private:

    void IssueOutAndSelectCommandSegmentOrLineAndTrip();

    class DataClass;
    QScopedPointer<DataClass> d;

};

#endif // ESTATEAPP_H