AppCore
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | List of all members
EM::TicketIssueLogic::ECommonFunctionalityModule Class Reference

class represent common functionality for all ticket issue logic More...

#include <ECommonFunctionalityModule.h>

Inheritance diagram for EM::TicketIssueLogic::ECommonFunctionalityModule:
Inheritance graph
[legend]
Collaboration diagram for EM::TicketIssueLogic::ECommonFunctionalityModule:
Collaboration graph
[legend]

Public Member Functions

 ECommonFunctionalityModule (ETicketIssueLogic *ticketIssueLogic, ETicketIssueLogicDataStorage *dataStorage, std::string moduleName=E_COMMON_FUNCTIONALITY_MODUL_NAME)
 standard c++ constructor, Create data class More...
 
virtual ~ECommonFunctionalityModule ()
 standard c++ destructor, destroy data class More...
 
virtual
EIssueLogicDefines::ReturnValues 
Init ()
 Saves required modules into members. More...
 
virtual
EIssueLogicDefines::ReturnValues 
CheckTicketValidity (bool &isTicketValid, bool &ticketOnTimeTicket, signed char ticketIndex=0)
 Check ticket validity on card on ticketIndex. More...
 
virtual
EIssueLogicDefines::ReturnValues 
CheckCashIssueConditions ()
 Check conditions to issue a ticket. More...
 
virtual
EIssueLogicDefines::ReturnValues 
IsStayOnLastBusStop (bool &stayOnLastBusStop)
 Function check if actual bus stop is last on trip. More...
 
virtual
EIssueLogicDefines::ReturnValues 
PrepareIssueData ()
 Function prepare common data to issue ticket. More...
 
virtual
EIssueLogicDefines::ReturnValues 
PrepareIssueDataFromCard (unsigned char ticketIndex)
 PrepareIssueDataFromCard - Function create IssuedTicket, Prepare Tariff from one way ticket facade. More...
 
virtual
EIssueLogicDefines::ReturnValues 
PrepareAutoIssueCommonData (Strojcek::VstupneUdaje::TarifnySystem::ETarifa *tariff, Strojcek::VstupneUdaje::TarifnySystem::ETarifnaSkupina *&tariffGroup)
 Function save common data( tariff, tariffGroup, tariffGroupTariff ) by tariffGroupNumber to data storage. More...
 
virtual
EIssueLogicDefines::ReturnValues 
ClearFlagsWasPurchased (unsigned char startingTicketIndex)
 Function flaqs was purchased from starting ticket index on card cleared flags: More...
 
virtual
EIssueLogicDefines::ReturnValues 
ClearOneWayTickets (unsigned char ticketIndex)
 Function clears one way ticket flags on card cleared flags: More...
 
virtual
EIssueLogicDefines::ReturnValues 
ClearOneWayTicketsTimeValidity ()
 Function clears one way ticket time validity (shared attribute for all one way tickets) More...
 
virtual
EIssueLogicDefines::ReturnValues 
CheckTicketCount (long ticketIndex=-1)
 Function check setting in tariff system "max ticket count" on every ticket position on card and than check setting "global maximal ticket" with summary ticket count on card. More...
 
EIssueLogicDefines::ReturnValues GetBusStopID (unsigned long &checkInBusStopID, unsigned long &checkOutBusStopID)
 Function prepare bus stop ID by priceList type. More...
 
virtual
EIssueLogicDefines::ReturnValues 
OwnerHasFellowTravelers (bool &ownerHasFellowTravelers)
 
virtual
EIssueLogicDefines::ReturnValues 
GetNumberOfUsedFellowTravellersIndexesOnCard (unsigned char &ticketCont)
 
virtual
EIssueLogicDefines::ReturnValues 
GetFellowTravelersCount (unsigned long &fellowTravelerCount)
 GetFellowTravelersCount - Returns count of fellow travelers. More...
 
virtual
EIssueLogicDefines::ReturnValues 
IsPossibleSellTicket (bool &isTicketValid)
 IsPossibleSellTicket - function check ticket validity and owner ticket validity. More...
 
virtual
EIssueLogicDefines::ReturnValues 
PrepareCardTicketIndex ()
 PrepareCardTicketIndex - function calculate free card ticket index and set it to data storage. More...
 
EIssueLogicDefines::ReturnValues IsProcessingJourneyOnTimeTicket (bool &journeyOnTimeTicket, IssuedTicketSegment *issuedTicketSegment=NULL)
 IsProcessingJourneyOnTimeTicket. Function checks time ticket collection validity and flag in oneWayTicket facade. More...
 
virtual
EIssueLogicDefines::ReturnValues 
IsCardTypeMatchingTariffDiscount (Strojcek::VstupneUdaje::TarifnySystem::ETarifa *tariff, bool &cardTypeMatching, bool checkTimeTicketDiscount, unsigned char customerProfileIndex)
 Function compare discount type on tariff and discount type on card. More...
 
virtual
EIssueLogicDefines::ReturnValues 
FillAdditionalDataCalculatePrice (const DataForPriceCalculation &dataForPriceCalculation, Strojcek::VstupneUdaje::_VSTUPNA_STRUKTURA &inputDataCalculatePrice)
 Function set to inputDataCalculatePrice nothing. More...
 
EIssueLogicDefines::ReturnValues IsCardCompanyNumberAccepted (std::vector< short > acceptedCompanyNumbers, bool &isAccepted) const
 Retrieves card company number from read facade and chcecks whether it's contained in the accepted company numbers. More...
 
virtual bool CheckMaxAgeForDiscount (unsigned char customerProfileIndex, bool timeTicket, bool &isDiscountAllowed)
 Function checks if age is within given discount. More...
 
EIssueLogicDefines::ReturnValues EvaluateCardNetworkWithTariffNetwork (bool &matchingNetwork)
 
EIssueLogicDefines::ReturnValues CheckTicketLineTripValidity (unsigned char ticketIndex, bool &isTicketValid)
 CheckTicketLineTripValidity - checks if ticket on card has same line, trip, protect number. More...
 
EIssueLogicDefines::ReturnValues CheckTicketLineTripBusStopValidity (unsigned char ticketIndex, bool &isTicketValid)
 CheckTicketLineTripBusStopValidity - checks if ticket on card has same line, trip, protect number and check-in bus stop. More...
 
- Public Member Functions inherited from EM::TicketIssueLogic::ETicketIssueModule
 ETicketIssueModule (const std::string &name, EIssueLogicDefines::ModuleFamily moduleFamily)
 
virtual ~ETicketIssueModule ()
 
bool GetName (std::string &moduleName)
 unique module identificator More...
 
bool GetModuleFamily (EIssueLogicDefines::ModuleFamily &moduleFamily)
 return by reference module family More...
 

Protected Member Functions

virtual
EIssueLogicDefines::ReturnValues 
PrepareTicketIssueData (IssuedTicketSegment *issuedTicketSegment)
 Function prepare common data ( tariff, tariffGroup, tariffGroupTariff ) by card type and set to data storage. More...
 
virtual
EIssueLogicDefines::ReturnValues 
PrepareTimeTicketData (Strojcek::VstupneUdaje::TarifnySystem::ETarifa *&tariff, short validTimeTicketIndex)
 Prepare time ticket common data by time ticket tariff ticket number. This function is called from PrepareTicketAutoIssueData. More...
 
virtual
EIssueLogicDefines::ReturnValues 
PrepareCashTicketData (Strojcek::VstupneUdaje::TarifnySystem::ETarifa *&tariff, unsigned char customerProfileIndex)
 Function prepare common data( tariff. tariffGroup, tariffGroupTariff ) by card type. This function is called from PrepareTicketAutoIssueData. More...
 
virtual
EIssueLogicDefines::ReturnValues 
PrepareMarkerIssueData (IssuedTicketSegment *IssuedTicketSegment)
 Function sets tariff by tariff group from data storage for marker issue. More...
 
virtual
EIssueLogicDefines::ReturnValues 
PrepareTariffDataForAutoIssue (IssuedTicketSegment *issuedTicketSegment)
 Function prepares data for auto issue. More...
 
virtual
EIssueLogicDefines::ReturnValues 
GetFirstCustomerProfileValidByTariff (IssuedTicketSegment *issuedTicketSegment, unsigned char &usedCustomerProfile)
 Function checks tariff discount type with issuing tariff discount. Calls IsAllowedTimeTicketTariffToCard (when selling time ticket) or IsAllowedOneWayTicketTariffToCard (when selling one way ticket) More...
 
virtual
EIssueLogicDefines::ReturnValues 
GetFirstCustomerProfileValidByTimeTicketTariff (IssuedTicketSegment *issuedTicketSegment, unsigned char &usedCustomerProfile)
 Function checks tariff discount type with issuing tariff discount. More...
 
virtual
EIssueLogicDefines::ReturnValues 
GetFirstCustomerProfileValidByOneWayTicketTariff (IssuedTicketSegment *issuedTicketSegment, unsigned char &usedCustomerProfile)
 Function checks tariff discount type with issuing tariff discount. More...
 
virtual
EIssueLogicDefines::ReturnValues 
EvaluateCardTypeMatch (bool cardTypeMatching)
 Evaluates information about matching card type. Application behaves different to not-matching card type according to setting in TS 121. More...
 
virtual
EIssueLogicDefines::ReturnValues 
PrepareTariffDataBySubstituteTariffGroups (IssuedTicketSegment *issuedTicketSegment)
 PrepareSubstituteTariffGroup - Function prepare substitute tariff from actual tariffGroup. More...
 
virtual
EIssueLogicDefines::ReturnValues 
PrepareSubstituteTariffGroup (IssuedTicketSegment *issuedTicketSegment, Strojcek::VstupneUdaje::TarifnySystem::ETarifa *tariff, Strojcek::VstupneUdaje::TarifnySystem::ETarifnaSkupina *tariffGroup)
 PrepareSubstituteTariffGroupTariff - Function finds substitute tariff group by selected tariff ticket number. If some matches, store it into data storage. More...
 
virtual
EIssueLogicDefines::ReturnValues 
PrepareTariffDataFromSubstituteTariffGroup (IssuedTicketSegment *issuedTicketSegment, Strojcek::VstupneUdaje::TarifnySystem::ETarifnaSkupina *tariffGroup, Strojcek::VstupneUdaje::TarifnySystem::ETarifa *manualSelectedtariff)
 PrepareTariffFromSubstituteTariffGroup - Function finds substitute tariff group by domestic currency ID. More...
 
EIssueLogicDefines::ReturnValues PrepareTariffDataForManualIssue (IssuedTicketSegment *issuedTicketSegment)
 
EIssueLogicDefines::ReturnValues SetNetworkWideFlag (IssuedTicket *issuedTicket)
 Sets network wide flag by price list type. More...
 
EIssueLogicDefines::ReturnValues SetIssuedTicketFlags (IssuedTicket *issuedTicket)
 SetIssuedTicketFlags Evaluate and set flags to issued ticket. More...
 
EIssueLogicDefines::ReturnValues FillIssuedTicketSegmentSpatialUnits (const EIssueLogicDefines::PriceComputeUnit priceComputeUnit, IssuedTicketSegment *issuedTicketSegment)
 

Detailed Description

class represent common functionality for all ticket issue logic

Constructor & Destructor Documentation

INTERNAL ECommonFunctionalityModule::ECommonFunctionalityModule ( ETicketIssueLogic ticketIssueLogic,
ETicketIssueLogicDataStorage dataStorage,
std::string  moduleName = E_COMMON_FUNCTIONALITY_MODUL_NAME 
)

standard c++ constructor, Create data class

Parameters
ticketIssueLogic- owner
dataStorage- pointer to data storage
moduleName- module identification name
ECommonFunctionalityModule::~ECommonFunctionalityModule ( )
virtual

standard c++ destructor, destroy data class

Member Function Documentation

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::CheckCashIssueConditions ( )
virtual

Check conditions to issue a ticket.

Returns
RestrictedZones - if zones combination is restricted Ok - all ok
bool ECommonFunctionalityModule::CheckMaxAgeForDiscount ( unsigned char  customerProfileIndex,
bool  timeTicket,
bool &  isDiscountAllowed 
)
virtual

Function checks if age is within given discount.

Parameters
customerProfileIndex- profile to be checked
isDiscountAllowed- return information about discount
Returns
true if given date is OK, otherwise false

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::CheckTicketCount ( long  ticketIndex = -1)
virtual

Function check setting in tariff system "max ticket count" on every ticket position on card and than check setting "global maximal ticket" with summary ticket count on card.

Parameters
ticketIndex- free ticket index
Returns
ErrorIssueTicket - error get something from data storage or check ticket count on card position - see log Ok - all ok

Here is the call graph for this function:

EIssueLogicDefines::ReturnValues EM::TicketIssueLogic::ECommonFunctionalityModule::CheckTicketLineTripBusStopValidity ( unsigned char  ticketIndex,
bool &  isTicketValid 
)

CheckTicketLineTripBusStopValidity - checks if ticket on card has same line, trip, protect number and check-in bus stop.

Parameters
ticketIndex- index of ticket to check
isTicketValid- output parameter set to true if ticket has same line, trip, protect number and check-in bus stop as in data storage
Returns
Ok - all ok
other - see enumerator in EIssueLogicDefines::ReturnValues
EIssueLogicDefines::ReturnValues EM::TicketIssueLogic::ECommonFunctionalityModule::CheckTicketLineTripValidity ( unsigned char  ticketIndex,
bool &  isTicketValid 
)

CheckTicketLineTripValidity - checks if ticket on card has same line, trip, protect number.

Parameters
ticketIndex- index of ticket to check
isTicketValid- output parameter set to true if ticket has same line, trip, protect number as in data storage
Returns
Ok - all ok
other - see enumerator in EIssueLogicDefines::ReturnValues

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::CheckTicketValidity ( bool &  isTicketValid,
bool &  ticketOnTimeTicket,
signed char  ticketIndex = 0 
)
virtual

Check ticket validity on card on ticketIndex.

Parameters
isTicketValid- output value - true valid ticket, false otherwise
ticketIndex- ticket indentificator on card
Returns
BadInputData - bad data on cardor datastorage - see logs Ok - all ok

flag Line, Trip, ProtectNumber - shared flags

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::ClearFlagsWasPurchased ( unsigned char  startingTicketIndex)
virtual

Function flaqs was purchased from starting ticket index on card cleared flags:

  • FlagWasPurchased
Returns
Ok - all ok

Here is the call graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::ClearOneWayTickets ( unsigned char  ticketIndex)
virtual

Function clears one way ticket flags on card cleared flags:

  • FlagWasPurchased
  • FlagWasInterchange
  • InterchangeTime
  • TicketCount
  • TicketPrice
Returns
Ok - all ok

Here is the call graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::ClearOneWayTicketsTimeValidity ( )
virtual

Function clears one way ticket time validity (shared attribute for all one way tickets)

Returns
Ok - all ok

Here is the call graph for this function:

EIssueLogicDefines::ReturnValues EM::TicketIssueLogic::ECommonFunctionalityModule::EvaluateCardNetworkWithTariffNetwork ( bool &  matchingNetwork)
Parameters
matchingNetwork- output parameter - matching card network adn tariff network
Returns
Ok - all ok
other - see enumerator in EIssueLogicDefines::ReturnValues

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::EvaluateCardTypeMatch ( bool  cardTypeMatching)
protectedvirtual

Evaluates information about matching card type. Application behaves different to not-matching card type according to setting in TS 121.

Parameters
cardTypeMatching- tells if card type is matching discount type of tariff
Returns
Ok - all ok
other - see enumerator in EIssueLogicDefines::ReturnValues
Note
allow portable EP setting in TS 121

allow portable EP setting may have value:

  • 0 - forbidden issue tariff( another discount type ) as discount type on card
  • 1 - On device Slave is allowed issue another cardType&&discountType combination. On OBC is forbidden
  • 2 - On device OBC is allowed issue another cardType&&discountType combination. On Slave is forbidden
  • 3 - allow another cardType&&discountType combination - allow all portable cards

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::FillAdditionalDataCalculatePrice ( const DataForPriceCalculation dataForPriceCalculation,
Strojcek::VstupneUdaje::_VSTUPNA_STRUKTURA &  inputDataCalculatePrice 
)
virtual

Function set to inputDataCalculatePrice nothing.

Warning
please leave this function CLEAR !.
Note
This functionality is here, beacuse child combined ticket need this functionality
Parameters
inputDataCalculatePrice- input data to calculate price

Implements EM::TicketIssueLogic::ECalculatePriceModuleInterface.

Reimplemented in EM::TicketIssueLogic::ECommonFunctionalityModuleCombinedTicket.

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::FillIssuedTicketSegmentSpatialUnits ( const EIssueLogicDefines::PriceComputeUnit  priceComputeUnit,
IssuedTicketSegment issuedTicketSegment 
)
protected

Here is the call graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::GetBusStopID ( unsigned long &  checkInBusStopID,
unsigned long &  checkOutBusStopID 
)

Function prepare bus stop ID by priceList type.

Note
Default check in/out busStop - ETicketIssueLogicDataStorage::SetCheckInBusStopID , ETicketIssueLogicDataStorage::GetCheckInBusStopID
VSB priceList - try to use ETicketIssueLogicDataStorage::GetCheckOutZoneBusStopID, ETicketIssueLogicDataStorage::GetCheckInZoneBusStopID If this function ends with failure, use default functions
EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::GetFellowTravelersCount ( unsigned long &  fellowTravelerCount)
virtual

GetFellowTravelersCount - Returns count of fellow travelers.

Parameters
fellowTravelerCount- output parameter fellow travelers count
Returns
other - see enumerator in EIssueLogicDefines::ReturnValues

Here is the call graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::GetFirstCustomerProfileValidByOneWayTicketTariff ( IssuedTicketSegment issuedTicketSegment,
unsigned char &  usedCustomerProfile 
)
protectedvirtual

Function checks tariff discount type with issuing tariff discount.

Parameters
issuedTicketSegment- from issued ticket is gained issuing tariff
usedCustomerProfile- output param, customer profile on card that matches selected tariff from oneWayTicket
See also
IsAllowedTariffToCard

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::GetFirstCustomerProfileValidByTariff ( IssuedTicketSegment issuedTicketSegment,
unsigned char &  usedCustomerProfile 
)
protectedvirtual

Function checks tariff discount type with issuing tariff discount. Calls IsAllowedTimeTicketTariffToCard (when selling time ticket) or IsAllowedOneWayTicketTariffToCard (when selling one way ticket)

Parameters
issuedTicket- from issued ticket is gained issuing tariff
usedCustomerProfile- output param, customer profile on card that matches selected tariff
Note
If cardTypeDiscount && tariffDiscount combination is matching with card type => issue ticket, check setting 121"allowProtableEP" in tariff system otherwise
See also
EvaluateCardTypeMatch
IsAllowedTimeTicketTariffToCard
IsAllowedOneWayTicketTariffToCard

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::GetFirstCustomerProfileValidByTimeTicketTariff ( IssuedTicketSegment issuedTicketSegment,
unsigned char &  usedCustomerProfile 
)
protectedvirtual

Function checks tariff discount type with issuing tariff discount.

Parameters
issuedTicketSegment- from issued ticket is gained issuing tariff
usedCustomerProfile- output param, customer profile on card that matches selected tariff from timeTicket
See also
IsAllowedTariffToCard

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::GetNumberOfUsedFellowTravellersIndexesOnCard ( unsigned char &  ticketCont)
virtual

Returns number of occupuied indexes on card

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::Init ( void  )
virtual

Saves required modules into members.

Returns
NullInternalPointer - failed to get module manager
ModuleNotFound - failed to get some required module
Ok - all ok

Reimplemented from EM::TicketIssueLogic::ETicketIssueModule.

Reimplemented in EM::TicketIssueLogic::ECommonFunctionalityModuleCombinedTicket.

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::IsCardCompanyNumberAccepted ( std::vector< short >  acceptedCompanyNumbers,
bool &  isAccepted 
) const

Retrieves card company number from read facade and chcecks whether it's contained in the accepted company numbers.

Parameters
acceptedCompanyNumberslist of accepted company numbers
isAccepted
Returns
EIssueLogicDefines::ReturnValues

Here is the call graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::IsCardTypeMatchingTariffDiscount ( Strojcek::VstupneUdaje::TarifnySystem::ETarifa *  tariff,
bool &  cardTypeMatching,
bool  checkTimeTicketDiscount,
unsigned char  customerProfileIndex 
)
virtual

Function compare discount type on tariff and discount type on card.

Function get corporate number from companies config ( documentation:

See also
http://192.168.10.22/wiki/doku.php?id=dev_doc:configs ). Than call libedatainput function "GetTypKartyTypZlavyByTypKartyID" to get instance ETypKartyTypZlavy. In instance of ETypKartyTypZlavy is saved home and external discount type. Check card provider number is home Company or external company. If home company, compare tariff discount with home discount saved in ETypKartyTypZlavy, otherwise compare with external discount type
Parameters
tariff- checked tariff, from which i get discount type
cardTypeMatching- output parameter where will be stored information if card type is matching or not
checkTimeTicketDiscount- when true, discount type of tariff will be checked against discount type of TT by card type (otherwise against OWT discount type)
Returns
true if card type discount is same as tariff discount type, false otherwise ( for particulars see log )

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::IsPossibleSellTicket ( bool &  isTicketValid)
virtual

IsPossibleSellTicket - function check ticket validity and owner ticket validity.

Returns
OK - all ok
See also
EIssueLogicDefines::ReturnValues

Here is the call graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::IsProcessingJourneyOnTimeTicket ( bool &  journeyOnTimeTicket,
IssuedTicketSegment issuedTicketSegment = NULL 
)

IsProcessingJourneyOnTimeTicket. Function checks time ticket collection validity and flag in oneWayTicket facade.

Parameters
journeyOnTimeTicket- output parameter - actual journey (alle trip sections or desired issued ticket segment) is or isn't journey on time ticket
issuedTicketSegment- optional input parameter - if parameter is set, only this trip segment will be checked if it is time ticket type
Returns
Ok - all ok, ::ReturnValues

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::IsStayOnLastBusStop ( bool &  stayOnLastBusStop)
virtual

Function check if actual bus stop is last on trip.

Parameters
stayOnLastBusStop- if value is true, actual bus stop is last on trip, false otherwise
Returns
BadInputData - error get data from data storage or readed data collection Ok - all ok
EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::OwnerHasFellowTravelers ( bool &  ownerHasFellowTravelers)
virtual

Checks if there are also tickets for fellow travelers wirtten on card

Returns
Ok - all ok
other - see enumerator in EIssueLogicDefines::ReturnValues

Here is the call graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::PrepareAutoIssueCommonData ( Strojcek::VstupneUdaje::TarifnySystem::ETarifa *  tariff,
Strojcek::VstupneUdaje::TarifnySystem::ETarifnaSkupina *&  tariffGroup 
)
virtual

Function save common data( tariff, tariffGroup, tariffGroupTariff ) by tariffGroupNumber to data storage.

Parameters
tariff- actual tariff - saveto data storage
Returns
BadInputData - error get tariffGroup by tariffGroupNumber or get tariffGroupTariff from tariffGroup Ok - all ok
Note
function call only if issueType is AutoIssue

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::PrepareCardTicketIndex ( )
virtual

PrepareCardTicketIndex - function calculate free card ticket index and set it to data storage.

Returns
OK - all ok
See also
EIssueLogicDefines::ReturnValues

Here is the call graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::PrepareCashTicketData ( Strojcek::VstupneUdaje::TarifnySystem::ETarifa *&  tariff,
unsigned char  customerProfileIndex 
)
protectedvirtual

Function prepare common data( tariff. tariffGroup, tariffGroupTariff ) by card type. This function is called from PrepareTicketAutoIssueData.

Parameters
tariff- output param represent actual calculated tariff by card type
customerProfileIndex- index of customerProfile to be used for calculations
Returns
Ok - all ok BadInputData - error get something from data storage or readed data collection

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::PrepareIssueData ( )
virtual

Function prepare common data to issue ticket.

In function is created IssuedTicket and set to him common flags. If sucessfully init issued ticket call CalculatePrice and set calculated price to issued ticket.

issueType is :

  • AutoIssue
    • prepare data( tariff, tariffGroup, tariffGroupTariff ) by card type in function : PrepareTicketAutoIssueData
    • set default ticket count to 1
  • ManualIssue
    • set to actual issued ticket ticket count, which is set from aplication
Returns
BadInputData - error get data from data storage Ok - all ok Other - see result value from other function
See also
PrepareTicketAutoIssueData, PrepareIssueData, CalculatePrice

Reimplemented in EM::TicketIssueLogic::ECommonFunctionalityModuleCombinedTicket.

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::PrepareIssueDataFromCard ( unsigned char  ticketIndex)
virtual

PrepareIssueDataFromCard - Function create IssuedTicket, Prepare Tariff from one way ticket facade.

Parameters
ticketIndex- ticket indentificator on card

Here is the call graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::PrepareMarkerIssueData ( IssuedTicketSegment IssuedTicketSegment)
protectedvirtual

Function sets tariff by tariff group from data storage for marker issue.

Parameters
issueTicket- actual issued ticket structure
Returns
Ok - all ok
BadInputData - error get tariff group or save actual tariff
NullTariff - empty tariff list

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::PrepareSubstituteTariffGroup ( IssuedTicketSegment issuedTicketSegment,
Strojcek::VstupneUdaje::TarifnySystem::ETarifa *  tariff,
Strojcek::VstupneUdaje::TarifnySystem::ETarifnaSkupina *  tariffGroup 
)
protectedvirtual

PrepareSubstituteTariffGroupTariff - Function finds substitute tariff group by selected tariff ticket number. If some matches, store it into data storage.

Parameters
issuedTicket- actual issued ticket structure
tariff- selected tariff
tariffGroup- actualtariff group
Returns
Ok - all ok
other - see enumerator in EIssueLogicDefines::ReturnValues

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::PrepareTariffDataBySubstituteTariffGroups ( IssuedTicketSegment issuedTicketSegment)
protectedvirtual

PrepareSubstituteTariffGroup - Function prepare substitute tariff from actual tariffGroup.

Parameters
issuedTicket- actual issued ticket structure
Returns
Ok - all ok
other - see enumerator in EIssueLogicDefines::ReturnValues

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::PrepareTariffDataForAutoIssue ( IssuedTicketSegment issuedTicketSegment)
protectedvirtual

Function prepares data for auto issue.

Parameters
issueTicket- actual issued ticket structure
Returns
Ok - all ok
BadInputData - error get valid time ticket
ErrorIssueTicket - error set tariff
See also
PrepareTimeTicketData, PrepareCashTicketData, PrepareCommonData

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::PrepareTariffDataForManualIssue ( IssuedTicketSegment issuedTicketSegment)
protected

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::PrepareTariffDataFromSubstituteTariffGroup ( IssuedTicketSegment issuedTicketSegment,
Strojcek::VstupneUdaje::TarifnySystem::ETarifnaSkupina *  tariffGroup,
Strojcek::VstupneUdaje::TarifnySystem::ETarifa *  manualSelectedtariff 
)
protectedvirtual

PrepareTariffFromSubstituteTariffGroup - Function finds substitute tariff group by domestic currency ID.

Function prepare: tariff, tariffGroup and tariffGroupTariff from substitute tariffGroupNumber

Parameters
issuedTicket- actual issued ticket structure
tariffGroup- actualtariff group
Returns
Ok - all ok
other - see enumerator in EIssueLogicDefines::ReturnValues

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::PrepareTicketIssueData ( IssuedTicketSegment issuedTicketSegment)
protectedvirtual

Function prepare common data ( tariff, tariffGroup, tariffGroupTariff ) by card type and set to data storage.

Parameters
issueTicket- actual issued ticket structure
Returns
Ok - all ok
Other - see result values of function PrepareTicketAutoIssueData
See also
PrepareTicketAutoIssueData

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::PrepareTimeTicketData ( Strojcek::VstupneUdaje::TarifnySystem::ETarifa *&  tariff,
short  validTimeTicketIndex 
)
protectedvirtual

Prepare time ticket common data by time ticket tariff ticket number. This function is called from PrepareTicketAutoIssueData.

Parameters
tariff- output param tariff - this tariff get from input data by time ticket tariff ticket number
validTimeTicketIndex- indicate valid timeticket index on card
Returns
Ok - all ok BadInputData - error get something from data storage or readed card datacollection

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::SetIssuedTicketFlags ( IssuedTicket issuedTicket)
protected

SetIssuedTicketFlags Evaluate and set flags to issued ticket.

Returns
ErrorIssueTicket - set flag to issued ticket
BadInputData - get operation type from data storage

Here is the call graph for this function:

Here is the caller graph for this function:

EIssueLogicDefines::ReturnValues ECommonFunctionalityModule::SetNetworkWideFlag ( IssuedTicket issuedTicket)
protected

Sets network wide flag by price list type.

Here is the call graph for this function:

Here is the caller graph for this function:


The documentation for this class was generated from the following files: