ECardFacadeDefines.h

Go to the documentation of this file.

#ifndef _ECARDFACADEDEFINES_H_
#define _ECARDFACADEDEFINES_H_

#ifndef __GNUC__
    #ifdef DLL_EXPORTS
        #define DLL_API __declspec(dllexport)
    #else
        #define DLL_API __declspec(dllimport)
    #endif
#else
    #define DLL_API
#endif

namespace EM
{
    namespace CardFacade
    {
        extern const unsigned char UNDEFINED_PRICE_UNIT;

        class DLL_API ECardFacadeDefines
        {
        private:
            enum OperationBits
            {
                UnspecifiedBit                                     = 0x0000,
                TimeTicketBit                                      = 0x0001,
                OneWayTicketBit                                    = 0x0002,
                PurseBit                                           = 0x0004,
                CommonBit                                          = 0x0008,
                ServiceBit                                         = 0x0010,
                CommercialDiscountBit                              = 0x0020,
                DiscountCouponBit                                  = 0x0040,
                CardHolderBit                                      = 0x0080,
                EventsDataBit                                      = 0x0100
            };

        public:
            enum OneWayTicketCardFeaturesEnum
            {
                OWTCardFeatureUndefined                            = 0x0000,
                OWTCardFeatureLine                                 = 0x0001,
                OWTCardFeatureTrip                                 = 0x0002,
                OWTCardFeatureProtectNumber                        = 0x0004,
                OWTCardFeaturePurseJourneyWritable                 = 0x0008,
                OWTCardFeaturePrepaidJourneyWritable               = 0x0010,
                /*
                 * Feature pre zistenie akym sposobom sa poznacuje na kartu cas platnosti.
                 * Su dve moznosti:
                 *     a) karta ma polozky 'zaciatok platnosti' a 'cas/ dlzka platnosti'
                 *           - Transdata struktura Mifare/Desfire standard
                 *           - Microelektronika2 mifare standard struktura
                 *           - Emtest IDOL struktury
                 *     b) karta ma polozky 'zaciatok platnosti' a 'koniec platnosti'
                 *           - XT Desfire struktura
                 *           - Microelektronika1 mifare standard struktura
                 */
                OWTCardFeatureTimeValidityDuration                 = 0x0020,
                OWTCardFeatureTariff                               = 0x0040,
                OWTCardFeatureSummaryPrice                         = 0x0080,
                OWTCardFeatureTimeValidityStart                    = 0x0100,
                OWTCardFeatureTimeValidityEnd                      = 0x0200,
                OWTCardFeatureSupportedCheckOutBusStop             = 0x0400,
                OWTCardFeatureClearTicketOnCancel                  = 0x0800,
                OWTCardFeatureCheckInCheckOutZone                  = 0x1000
            };

            enum LogCardFeatures
            {
                LogCardFeatureUndefined                            = 0x00,
                LogCardFeatrueCardStructureSupported               = 0x01
            };

            enum AnswerCardFeatures
            {
                AnswerCardFeatureUndefined                         = 0x00
            };

            enum CommonCardFeatures
            {
                CommonCardFeatureUndefined                         = 0x00,
                CommonCardFeaturePublisherVersion                  = 0x01,
                CommonCardFeatureCountryCode                       = 0x02,
                CommonCardFeatureNetworkCode                       = 0x04,
                /*
                 * Feature pre overenie ci je regionalny kod podporovany na strukture karty reprezentujucu dopravnu cast(penazenku).
                 *
                 * Regionalny kod sa moze nachadzat bud na karte(penazenka) alebo zlavovom kupone.
                 * Podporovane len pre Desfire implementaciu.
                 *
                 * Pozor, BMK karta je reprezentovana voci app ako Desfire ale nepodporuje regionalny kod na dopravnej casti(penazenke).
                 *  Na odlisenie Desfire/BMK je mozne pouzit ECardFacadeDefines::CommonDataFeatureHasRegionCardNumber.
                 */
                CommonCardFeatureRegionCodeOnCard                  = 0x08,
                CommonCardFeatureCapping                           = 0x10
            };

            enum PurseCardFeatures
            {
                PurseCardFeatureUndefined                          = 0x00,
                PurseCardFeatureRequiredApplicationChecking        = 0x01
            };

            enum ServiceCardFeatures
            {
                ServiceCardFeatureUndefined                        = 0x00
            };

            enum CommercialDiscountCardFeatures
            {
                CommercialDiscountCardFeatureUndefined             = 0x00
            };

            enum TimeTicketCardFeatures
            {
                TimeTicketCardFeatureUndefined                     = 0x00,
                TimeTicketCardFeatureCounterWritable               = 0x01,
                TimeTicketCardFeatureNetworkWideStructureSupport   = 0x02,
                TimeTicketCardFeatureProlongIndexOnlyOnSameType    = 0x04,
                TimeTicketCardFeatureFillEmptySlotFirst            = 0x08,
                TimeTicketCardFeatureClearTicketOnCancel           = 0x10,
                TimeTicketCardFeatureFileNumber                    = 0x20
            };

            enum TimeTicketFeatures
            {
                TimeTicketFeatureUndefined                         = 0x00,
                TimeTicketFeatureUrbanTransportNumber              = 0x01,
                TimeTicketFeatureNetworkID                         = 0x02,
                TimeTicketFeaturePreviousNumber                    = 0x04,
                TimeTicketFeatureProviderNumber                    = 0x08,
                TimeTicketFeaturePairedTimeTicket                  = 0x10
            };

            enum CommonDataFeatures
            {
                CommonDataFeatureUndefined                         = 0x00,
                CommonDataFeatureCustomerProfileValidityStart      = 0x01,
                 /* Desfire karty podporuju regionCardNumber (CommonCardFeatureRegionCodeOnCard), avsak pri BMK sa
                  *  to nevyuziva - pokus o nacitanie RegionCardNumber pri BMK skonci chybou.
                 */
                CommonDataFeatureHasRegionCardNumber               = 0x02
            };

            enum ReturnValues
            {
                Ok                                                 = 0,
                NullDataCollection                                 = 1,
                NullAnswer                                         = 2,
                NullEOneWayticketCollection                        = 3,
                NullTimeTicketCollection                           = 4,
                NullSuperCardVersion                               = 5,
                UndefinedCardType                                  = 6,
                BadInputParameter                                  = 7,
                BadActualCardStructure                             = 8,
                BadAbstractAnswer                                  = 9,
                ErrAddDataToWriteRequest                           = 10,
                ErrAddDataToReadRequest                            = 11,
                ErrorNullImplementation                            = 12
            };

            enum CardFacadeType
            {
                Read                                               = 0,
                Writing                                            = 1,
                CardFacadeCount                                    = 2
            };

            enum CardType
            {
                Mifare                                             = 0,
                Desfire                                            = 1,
                VDVKa                                              = 2,
                DesfireXT                                          = 3,
                MifareMikroelektronika1                            = 4,
                MifareMikroelektronika2                            = 5,
                MifareIDOL                                         = 6,
                DesfireAcos                                        = 7,
                DesfireService                                     = 8,
                CardTypeCount                                      = 9
            };

            enum TimeTicketType
            {
                TimeTicketTypeUndefined                            = -1,
                //TimeTicketType24Hours                              = 0,
                TimeTicketTypeTrip                                 = 1,
                TimeTicketTypeRegionInterval                       = 2, // zonovy casovy listok - valid zones are defined by (closed) interval e.g. [55,124]
                TimeTicketTypeTariffArea                           = 3, // pasmovy casovy listok
                TimeTicketTypeZoneList                             = 4, // all zones are accessible through ZoneList, has no Check-IN/OUT zone
                TimeTicketTypeZoneVia                              = 5, // has Check-IN/OUT zone, and ViaZones (accessible byt ZoneList) too
                TimeTicketTypeTimeValidityOnly                     = 6, // time ticket has only time validity (no zones or other additinal restrictions)
                TimeTicketTypeRelation                             = 7, // relation of zones or busstops (from-to and possible via)
                TimeTicketTypeNetworkWide                          = 8,
                TimeTicketTypeKilometric                           = 9
            };

            enum OneWayTicketType
            {
                OneWayTicketTypeUndefined                          = -1,
                OneWayTicketTypeStandard                           = 0,
                OneWayTicketTypeRelation                           = 1,
                OneWayTicketTypeZoneList                           = 2,
                OneWayTicketTypeZoneVia                            = 3,
                OneWayTicketTypeZoneAmount                         = 4,
                OneWayTicketTypeNetworkWide                        = 5
            };

            enum TextEncoding
            {
                EncodingUndefined                                  = 0, // means that application has to decide according to the project
                EncodingUtf8                                       = 1
            };

            enum DataTypeOperation
            {
                NoOperation                                        = UnspecifiedBit,
                TimeTicketOperation                                = TimeTicketBit,
                OneWayTicketOperation                              = OneWayTicketBit,
                PurseOperation                                     = PurseBit,
                CommonDataOperation                                = CommonBit,
                ServiceDataOperation                               = ServiceBit,
                CommercialDiscountOperation                        = CommercialDiscountBit,
                DiscountCouponOperation                            = DiscountCouponBit,
                CardHolderDataOperation                            = CardHolderBit,
                EventsDataOperation                                = EventsDataBit,
                DefaultDataTypesOperation                          = CommonBit | OneWayTicketBit,
                FullDataTypesOperation                             = CommonBit | OneWayTicketBit | ServiceBit | PurseBit | TimeTicketBit
            };

            enum ServiceCardType
            {
                UndefinedServiceCardType                           = -1,
                DriverNoCompanyCard                                = 0,
                ServiceCard                                        = 1,
                DriverCard                                         = 2,
                AuditorCard                                        = 3
            };

            enum CardTypeStandard
            {
                StandardUndefined                                  = 0,
                StandardCardTypeEmtest                             = 1,
                StandardCardTypeEN1545                             = 2
            };

            enum WalletISOCountryCode
            {
                WalletISOCountryCodeUndefined                      = 0,
                WalletISOCountryCodeCzech                          = 203,
                WalletISOCountryCodeGermany                        = 276,
                WalletISOCountryCodeLithuania                      = 440,
                WalletISOCountryCodePoland                         = 616,
                WalletISOCountryCodeSlovakia                       = 703,
                WalletISOCountryCodeSlovenia                       = 705,
                WalletISOCountryCodeMacedonia                      = 807
            };

            enum WalletISOPayUnitCode
            {
                WalletISOPayUnitCodeUndefined                      = 0,
                WalletISOPayUnitCodeCroatianKuna                   = 191,
                WalletISOPayUnitCodeCzechKoruna                    = 203,
                WalletISOPayUnitCodeHungarianForint                = 348,
                WalletISOPayUnitCodeLithuanianLitas                = 440,
                WalletISOPayUnitCodeSlovakKoruna                   = 703,
                WalletISOPayUnitCodeMacedonianDenar                = 807,
                WalletISOPayUnitCodeEur                            = 978,
                WalletISOPayUnitCodePolishZloty                    = 985
            };

            enum CappingProviderType
            {
                CappingProviderTypeUndefined                               = -1,
                CappingProviderTypeProviderCode                            = 0,
                CappingProviderTypeNetworkCode                             = 1
            };
        };
    }
}

#endif // _ECARDFACADEDEFINES_H_