AppCore
Loading...
Searching...
No Matches
ECardDataFacadeTimeTicket.h
Go to the documentation of this file.
1
2#ifndef ECARDDATAFACADETIMETICKET_H
3#define ECARDDATAFACADETIMETICKET_H
4
5#include <list>
6#include <vector>
7#include <string>
8
9#include "core/common/eplatform.h"
10#include "appcore/cardfacade/ECardFacadeDefines.h"
11
12class EMoneyData;
13
14namespace EM
15{
16 namespace PT
17 {
18 class EDataCollection;
19 class EAplRequest;
20 }
21
22 namespace CardFacade
23 {
24 class ECardDataStorage;
25 class DLL_API ECardDataFacadeTimeTicket
26 {
27 public:
30
36
43 bool GetAvailableTimeTicketSlots( short &timeTicketsSlots ) const;
44
50 bool GetTimeTicketsCount( short &timeTicketsCount ) const;
51
57 bool SetTimeTicketsCount( const short timeTicketsCount ) const;
58
66 bool IsTimeTicketValid( const unsigned char ticketIndex, bool &valid ) const;
67
75 bool SetTimeTicketValid( const unsigned char ticketIndex, const bool valid ) const;
76
89 bool GetTariffTicketNumber( const unsigned char ticketIndex, unsigned short &tariffTicketNumber ) const;
90
103 bool SetTariffTicketNumber( const unsigned char ticketIndex, const unsigned short tariffTicketNumber ) const;
104
105
113 bool GetTicketTariffProfile( const unsigned char ticketIndex, unsigned char &tariffProfile ) const;
114
115
123 bool SetTicketTariffProfile( const unsigned char ticketIndex, const unsigned char tariffProfile ) const;
124
125
133 bool GetTicketCustomerProfile( const unsigned char ticketIndex, unsigned char &customerProfile ) const;
134
135
143 bool SetTicketCustomerProfile( const unsigned char ticketIndex, const unsigned char customerProfile ) const;
144
145
152 bool GetPrice( const unsigned char ticketIndex, EMoneyData &price ) const;
153
160 bool SetPrice( const unsigned char ticketIndex, const EMoneyData &price ) const;
161
168 bool GetPriceUnit( const unsigned char ticketIndex, unsigned char &priceUnit ) const;
169
176 bool SetPriceUnit( const unsigned char ticketIndex, const unsigned char priceUnit ) const;
177
184 bool GetPaymentType( const unsigned char ticketIndex, unsigned char &paymentType ) const;
185
192 bool SetPaymentType( const unsigned char ticketIndex, const unsigned char paymentType ) const;
193
200 bool GetValidityStartTime( const unsigned char ticketIndex, unsigned long &validityStartTime ) const;
201
208 bool SetValidityStartTime( const unsigned char ticketIndex, const unsigned long validityFrom ) const;
209
216 bool GetValidityEndTime( const unsigned char ticketIndex, unsigned long &validityEndTime ) const;
217
224 bool SetValidityEndTime( const unsigned char ticketIndex, const unsigned long validityTo ) const;
225
232 bool GetRestrictDayOfWeek( const unsigned char ticketIndex, unsigned char &restrictDayOfWeek ) const;
233
240 bool SetRestrictDayOfWeek( const unsigned char ticketIndex, const unsigned char restrictDayOfWeek ) const;
241
248 bool GetProvider( const unsigned char ticketIndex, short &providerNumber ) const;
249
259 bool SetProvider( const unsigned char ticketIndex, const short providerNumber ) const;
260
267 bool GetTimeTicketNumber( const unsigned char ticketIndex, unsigned short &timeTicketNumber ) const;
268
275 bool SetTimeTicketNumber( const unsigned char ticketIndexunsigned, const unsigned short timeTicketNumber ) const;
276
283 bool GetTimeTicketPreviousNumber( const unsigned char ticketIndex, unsigned short &timeTicketNumber ) const;
284
291 bool SetTimeTicketPreviousNumber( const unsigned char ticketIndex, const unsigned short timeTicketNumber ) const;
292
299 bool GetPriceListRowNumber( const unsigned char ticketIndex, unsigned short &priceListRowNumber ) const;
300
307 bool SetPriceListRowNumber( const unsigned char ticketIndex, const unsigned short priceListRowNumber ) const;
308
315 bool GetAvailableJourneyCount( const unsigned char ticketIndex, unsigned short &availableJourneyCount ) const;
316
323 bool SetAvailableJourneyCount( const unsigned char ticketIndex, const unsigned short availableJourneyCount ) const;
324
331 bool GetJourneyCount( const unsigned short ticketIndex, unsigned short &journeyCount ) const;
332
339 bool SetJourneyCount( const unsigned char ticketIndex, const unsigned short journeyCount ) const;
340
347 bool GetTicketType( const unsigned char ticketIndex, ECardFacadeDefines::TimeTicketType &ticketType ) const;
348
355 bool SetTicketType( const unsigned char ticketIndex, const ECardFacadeDefines::TimeTicketType ticketType ) const;
356
366 bool SetZoneSize( const unsigned char ticketIndex, const unsigned char zoneSize ) const;
367
374 bool GetCheckInZone( const unsigned char ticketIndex, unsigned short &checkinZone ) const;
375
382 bool SetCheckInZone( const unsigned char ticketIndex, const unsigned short checkinZone ) const;
383
390 bool GetCheckOutZone( const unsigned char ticketIndex, unsigned short &checkoutZone ) const;
391
398 bool SetCheckOutZone( const unsigned char ticketIndex, const unsigned short checkOutZone ) const;
399
406 bool GetZoneList( const unsigned char ticketIndex, std::list<unsigned long> &zoneList ) const;
407
414 bool SetZoneList( const unsigned char ticketIndex, const std::list<unsigned long> &zoneList ) const;
415
423 bool GetZoneBitCollection( const unsigned char ticketIndex, std::vector<unsigned char> &bitCollection) const;
424
432 bool SetZoneBitCollection( const unsigned char ticketIndex, const std::vector<unsigned char> &bitCollection) const;
433
440 bool GetRouteNumber( const unsigned char ticketIndex, unsigned short &routeNumber ) const;
441
448 bool SetRouteNumber( const unsigned char ticketIndex, const unsigned short routeNumber ) const;
449
456 bool GetUrbanTransportIdentificationNumber( const unsigned char ticketIndex, long &urbanTransportIdentificationNumber ) const;
457
464 bool SetUrbanTransportIdentificationNumber( const unsigned char ticketIndex, const long urbanTransport ) const;
465
472 bool GetCountryCode( const unsigned char ticketIndex, unsigned short &countryCodeInBCD ) const;
473
480 bool SetCountryCode( const unsigned char ticketIndex, const unsigned short countryCodeInBCD ) const;
481
489 bool GetNetworkCode( const unsigned char ticketIndex, unsigned short &networkCodeInBCD ) const;
490
498 bool SetNetworkCode( const unsigned char ticketIndex, const unsigned short networkCodeInBCD ) const;
499
507 bool GetActivationFlag( const unsigned char ticketIndex, bool &activationFlag ) const;
508
515 bool SetActivationFlag( const unsigned char ticketIndex, const bool activationFlag ) const;
516
517
524 bool IsHourTimeTicket( const unsigned char ticketIndex, bool &hourTimeTicketFlag ) const;
525
530 bool GetFileNumber( const unsigned char ticketIndex, unsigned long &fileNumber ) const;
531
535 bool SetFileNumber( const unsigned char ticketIndex, const unsigned long fileNumber ) const;
536
540 void Clear();
541
546 bool IsModifiedData() const;
547
553 bool AddDataToWriteRequest( EM::PT::EDataCollection *writeRequest ) const;
554
560 bool AddDataTypeToReadRequest(PT::EAplRequest *readRequest[] , const unsigned short dataTypesOperation) const;
561
568 bool IsCardFeatureEnabled( const ECardFacadeDefines::TimeTicketCardFeatures feature, bool &enabled ) const;
569
577 bool IsTimeTicketFeatureEnabled( const ECardFacadeDefines::TimeTicketFeatures feature, unsigned char ticketIndex, bool &enabled ) const;
578
585 bool GetDeviceSNR( const unsigned char ticketIndex, unsigned long &snr ) const;
586
593 bool SetDeviceSNR( const unsigned char ticketIndex, const unsigned long snr ) const;
594
601 bool GetDriverNumber( const unsigned char ticketIndex, unsigned long &driverNumber ) const;
602
610 bool SetDriverNumber( const unsigned char ticketIndex, const unsigned long driverNumber ) const;
611
618 bool SetUrbanTransportFlag( const unsigned char ticketIndex, const bool isUrbanTransportEnabled ) const;
619
626 bool SetSubUrbanTransportFlag( const unsigned char ticketIndex, const bool isSuburbanTransportEnabled ) const;
627
633 bool SetCouponRestrictCode( const unsigned char ticketIndex, const unsigned char couponRestrictCode ) const;
634
638 bool GetCouponRestrictCode( const unsigned char ticketIndex, unsigned char &couponRestrictCode ) const;
639
649 bool GetCouponKilometers( const unsigned char ticketIndex, unsigned char &couponKilometers ) const;
650
660 bool SetCouponKilometers( const unsigned char ticketIndex, const unsigned char couponKilometers ) const;
661
671 bool GetRestrictLineType( const unsigned char ticketIndex, unsigned char &couponRestrictLineType ) const;
672
682 bool SetRestrictLineType( const unsigned char ticketIndex, const unsigned char couponRestrictLineType );
683
693 bool GetFlagIsIdsCoupon( const unsigned char ticketIndex, bool &isIdsCoupon ) const;
694
704 bool SetFlagIsIdsCoupon( const unsigned char ticketIndex, const bool isIdsCoupon );
705
727 bool GetIndexOfPairedTimeTicket( const unsigned char ticketIndex, unsigned char &indexOfPairedTimeTicket ) const;
728
736 bool GetFlagIsBaggageTicket( const unsigned char ticketIndex, bool &baggageTicket );
737
745 bool SetFlagIsBaggageTicket( const unsigned char ticketIndex, bool baggageTicket );
746
747 unsigned short GetRequiredDataReadOperation() const;
748
755 bool CreateSnapshotData( const unsigned char ticketIndex, std::string &data );
756
763 bool FillFromSnapshot( const unsigned char ticketIndex, const std::string &data );
764
765 private:
767
768 class DataClass;
769 DataClass *d;
770
772 };
773 }
774}
775
776#endif // ECARDDATAFACADETIMETICKET_H
#define DLL_API
Definition ECardFacadeDefines.h:8
bool GetZoneBitCollection(const unsigned char ticketIndex, std::vector< unsigned char > &bitCollection) const
GetZoneBitCollection - Function return zones bit field as byte collection.
bool GetAvailableJourneyCount(const unsigned char ticketIndex, unsigned short &availableJourneyCount) const
bool SetTimeTicketNumber(const unsigned char ticketIndexunsigned, const unsigned short timeTicketNumber) const
bool SetPaymentType(const unsigned char ticketIndex, const unsigned char paymentType) const
bool SetValidityStartTime(const unsigned char ticketIndex, const unsigned long validityFrom) const
bool GetTicketTariffProfile(const unsigned char ticketIndex, unsigned char &tariffProfile) const
bool GetTimeTicketsCount(short &timeTicketsCount) const
bool SetDriverNumber(const unsigned char ticketIndex, const unsigned long driverNumber) const
bool SetTicketCustomerProfile(const unsigned char ticketIndex, const unsigned char customerProfile) const
bool GetPrice(const unsigned char ticketIndex, EMoneyData &price) const
bool GetProvider(const unsigned char ticketIndex, short &providerNumber) const
bool IsModifiedData() const
check in actual implementation, if data was modified
bool GetCountryCode(const unsigned char ticketIndex, unsigned short &countryCodeInBCD) const
bool SetUrbanTransportIdentificationNumber(const unsigned char ticketIndex, const long urbanTransport) const
bool GetCouponKilometers(const unsigned char ticketIndex, unsigned char &couponKilometers) const
GetCouponKilometers.
bool GetValidityEndTime(const unsigned char ticketIndex, unsigned long &validityEndTime) const
bool AddDataToWriteRequest(EM::PT::EDataCollection *writeRequest) const
bool SetTimeTicketsCount(const short timeTicketsCount) const
bool GetFlagIsIdsCoupon(const unsigned char ticketIndex, bool &isIdsCoupon) const
GetFlagIsIdsCoupon.
bool SetPriceListRowNumber(const unsigned char ticketIndex, const unsigned short priceListRowNumber) const
bool GetPriceListRowNumber(const unsigned char ticketIndex, unsigned short &priceListRowNumber) const
bool SetFileNumber(const unsigned char ticketIndex, const unsigned long fileNumber) const
SetFileNumber set file number by ticketIndex.
bool GetNetworkCode(const unsigned char ticketIndex, unsigned short &networkCodeInBCD) const
bool GetRouteNumber(const unsigned char ticketIndex, unsigned short &routeNumber) const
ECardFacadeDefines::ReturnValues Init()
set to member actual card implementation and call init on actual implementation
bool SetFlagIsIdsCoupon(const unsigned char ticketIndex, const bool isIdsCoupon)
SetFlagIsIdsCoupon.
bool FillFromSnapshot(const unsigned char ticketIndex, const std::string &data)
FillFromSnapshot - deserializes ticket data (in base64 format) into time ticket on specified position...
bool SetDeviceSNR(const unsigned char ticketIndex, const unsigned long snr) const
bool IsCardFeatureEnabled(const ECardFacadeDefines::TimeTicketCardFeatures feature, bool &enabled) const
bool SetTariffTicketNumber(const unsigned char ticketIndex, const unsigned short tariffTicketNumber) const
bool SetTimeTicketPreviousNumber(const unsigned char ticketIndex, const unsigned short timeTicketNumber) const
bool SetCouponKilometers(const unsigned char ticketIndex, const unsigned char couponKilometers) const
SetCouponKilometers.
bool SetRouteNumber(const unsigned char ticketIndex, const unsigned short routeNumber) const
bool AddDataTypeToReadRequest(PT::EAplRequest *readRequest[], const unsigned short dataTypesOperation) const
bool GetTimeTicketPreviousNumber(const unsigned char ticketIndex, unsigned short &timeTicketNumber) const
bool GetCheckOutZone(const unsigned char ticketIndex, unsigned short &checkoutZone) const
bool GetTariffTicketNumber(const unsigned char ticketIndex, unsigned short &tariffTicketNumber) const
bool GetPaymentType(const unsigned char ticketIndex, unsigned char &paymentType) const
bool SetJourneyCount(const unsigned char ticketIndex, const unsigned short journeyCount) const
bool GetUrbanTransportIdentificationNumber(const unsigned char ticketIndex, long &urbanTransportIdentificationNumber) const
bool GetValidityStartTime(const unsigned char ticketIndex, unsigned long &validityStartTime) const
bool GetFlagIsBaggageTicket(const unsigned char ticketIndex, bool &baggageTicket)
GetFlagIsBaggageTicket.
bool SetPrice(const unsigned char ticketIndex, const EMoneyData &price) const
bool SetAvailableJourneyCount(const unsigned char ticketIndex, const unsigned short availableJourneyCount) const
bool GetRestrictDayOfWeek(const unsigned char ticketIndex, unsigned char &restrictDayOfWeek) const
bool IsHourTimeTicket(const unsigned char ticketIndex, bool &hourTimeTicketFlag) const
IsHourTimeTicket - Check time ticket type whether ticket type is TYPE_TIME_TICKET_24_HOUR.
bool GetActivationFlag(const unsigned char ticketIndex, bool &activationFlag) const
GetActivationFlag - Function retrun flag on timet ticket - activation.
bool GetIndexOfPairedTimeTicket(const unsigned char ticketIndex, unsigned char &indexOfPairedTimeTicket) const
Gets index of paired time ticket. Paired time ticket is special case of sharing data between time tic...
bool IsTimeTicketValid(const unsigned char ticketIndex, bool &valid) const
bool GetTicketCustomerProfile(const unsigned char ticketIndex, unsigned char &customerProfile) const
bool SetNetworkCode(const unsigned char ticketIndex, const unsigned short networkCodeInBCD) const
bool GetDriverNumber(const unsigned char ticketIndex, unsigned long &driverNumber) const
bool SetZoneBitCollection(const unsigned char ticketIndex, const std::vector< unsigned char > &bitCollection) const
SetZoneBitCollection - Function byte collection to TimeTicket as byte field.
bool SetFlagIsBaggageTicket(const unsigned char ticketIndex, bool baggageTicket)
SetFlagIsBaggageTicket.
bool SetCountryCode(const unsigned char ticketIndex, const unsigned short countryCodeInBCD) const
bool SetTicketTariffProfile(const unsigned char ticketIndex, const unsigned char tariffProfile) const
bool SetCheckOutZone(const unsigned char ticketIndex, const unsigned short checkOutZone) const
bool GetCheckInZone(const unsigned char ticketIndex, unsigned short &checkinZone) const
bool GetFileNumber(const unsigned char ticketIndex, unsigned long &fileNumber) const
GetFileNumber get file number by ticketIndex.
bool SetValidityEndTime(const unsigned char ticketIndex, const unsigned long validityTo) const
bool SetTimeTicketValid(const unsigned char ticketIndex, const bool valid) const
bool SetUrbanTransportFlag(const unsigned char ticketIndex, const bool isUrbanTransportEnabled) const
SetUrbanTransportFlag - this functionality is supported only for mifare with IDOL Structures.
bool SetCheckInZone(const unsigned char ticketIndex, const unsigned short checkinZone) const
bool GetTimeTicketNumber(const unsigned char ticketIndex, unsigned short &timeTicketNumber) const
bool GetTicketType(const unsigned char ticketIndex, ECardFacadeDefines::TimeTicketType &ticketType) const
bool SetTicketType(const unsigned char ticketIndex, const ECardFacadeDefines::TimeTicketType ticketType) const
bool SetSubUrbanTransportFlag(const unsigned char ticketIndex, const bool isSuburbanTransportEnabled) const
SetSubUrbanTransportFlag - this functionality is supported only for mifare with IDOL Structures.
bool GetRestrictLineType(const unsigned char ticketIndex, unsigned char &couponRestrictLineType) const
GetRestrictLineType.
bool GetDeviceSNR(const unsigned char ticketIndex, unsigned long &snr) const
bool SetRestrictLineType(const unsigned char ticketIndex, const unsigned char couponRestrictLineType)
SetRestrictLineType.
bool SetRestrictDayOfWeek(const unsigned char ticketIndex, const unsigned char restrictDayOfWeek) const
bool CreateSnapshotData(const unsigned char ticketIndex, std::string &data)
CreateSnapshotData - serializes ticket on specified position and returns serialized data of ticket in...
ECardDataFacadeTimeTicket(ECardDataStorage *cardDataStorage)
unsigned short GetRequiredDataReadOperation() const
bool SetActivationFlag(const unsigned char ticketIndex, const bool activationFlag) const
SetActivationFlag - Function set flag on timet ticket - activation.
bool SetCouponRestrictCode(const unsigned char ticketIndex, const unsigned char couponRestrictCode) const
bool SetZoneList(const unsigned char ticketIndex, const std::list< unsigned long > &zoneList) const
bool IsTimeTicketFeatureEnabled(const ECardFacadeDefines::TimeTicketFeatures feature, unsigned char ticketIndex, bool &enabled) const
IsTimeTicketFeatureEnabled.
bool GetJourneyCount(const unsigned short ticketIndex, unsigned short &journeyCount) const
bool SetProvider(const unsigned char ticketIndex, const short providerNumber) const
bool SetPriceUnit(const unsigned char ticketIndex, const unsigned char priceUnit) const
bool SetZoneSize(const unsigned char ticketIndex, const unsigned char zoneSize) const
bool GetZoneList(const unsigned char ticketIndex, std::list< unsigned long > &zoneList) const
bool GetCouponRestrictCode(const unsigned char ticketIndex, unsigned char &couponRestrictCode) const
bool GetPriceUnit(const unsigned char ticketIndex, unsigned char &priceUnit) const
bool GetAvailableTimeTicketSlots(short &timeTicketsSlots) const
return count of all time ticket slots on card ( max Time Tickets)
card data storage, who fill if card readed
Definition ECardDataStorage.h:60
TimeTicketFeatures
Definition ECardFacadeDefines.h:125
TimeTicketType
The TimeTicketType enum.
Definition ECardFacadeDefines.h:191
TimeTicketCardFeatures
Definition ECardFacadeDefines.h:114
ReturnValues
Definition ECardFacadeDefines.h:145
SYSTEM INCLUDES.
Definition CardFacadeManagerXML.h:7