#include <ETimeTicketSellModule.h>

Inheritance diagram for EM::TicketIssueLogic::ETimeTicketSellModule:

[legend]

Collaboration diagram for EM::TicketIssueLogic::ETimeTicketSellModule:

[legend]

Public Types
enum	FillTimeTicketResult { OK = 0 , TariffNotFound = 1 , PriceListNotFound = 2 , ErrorWhileObtainingData = 3 , ErrorWhileSettingData = 4 }

Public Member Functions
	ETimeTicketSellModule (ETicketIssueLogicDataStorage *dataStorage, std::string moduleName=E_TIME_TICKET_SELL_MODULE_NAME)

virtual	~ETimeTicketSellModule ()

virtual EIssueLogicDefines::ReturnValues	Init ()
	init module input data ( for example other module )

virtual bool	GetAvailableTimeTicketIndex (unsigned char &index)
	Finds first time ticket that is invalid (it means that it's status is set as not valid) or no longer valid.

virtual FillTimeTicketResult	FillTimeTicket (unsigned char index)
	FillTimeTicket - sets all time ticket data to facade @list what is set to facade:

virtual bool	CalculateEndValidity ()
	CalculateEndValidity - Calculates validity end of time ticket and stores it in DataStorage.

virtual bool	CorrectValidity ()
	CorrectValidity corrects already values (validity from and validity to) stored in dataStorage according to properties of actual tariff (PlatnPredZacPlCL and PlatnPoSkoncPlCL) and saves it back into DataStorage.

virtual bool	AutoBeginValidity (unsigned long date=0)
	Automatically modifies date relative to property of actual tariff. Result is stored in DataStorage in TimeTicketValidityStart If date wasn't given (default param), method works with actual time-date.

virtual bool	CheckValidity (unsigned long validityBeginDate, unsigned long validityEndDate)
	Function checks if given date isn't too far in future of too far in tha past (according to tariff properties in input data)

virtual bool	GetTimeTicketIndexByTariffTicketNumber (unsigned short tariffTicketNumber, char &correspondingTTIndex)
	GetTimeTicketIndexByTariffTicketNumber - function return time ticket index with entered tariff ticket number and oldest end validity of ticket on index ( multiple indexes could have same tariff ticket number )

virtual EIssueLogicDefines::ReturnValues	FillAdditionalDataCalculatePrice (const DataForPriceCalculation &dataForPriceCalculation, Strojcek::VstupneUdaje::_VSTUPNA_STRUKTURA &inputDataCalculatePrice)
	Function set to inputDataCalculatePrice time ticket validity.

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

bool	GetModuleFamily (EIssueLogicDefines::ModuleFamily &moduleFamily)
	return by reference module family

Member Enumeration Documentation

◆ FillTimeTicketResult

enum EM::TicketIssueLogic::ETimeTicketSellModule::FillTimeTicketResult

Enumerator
OK
TariffNotFound
PriceListNotFound
ErrorWhileObtainingData
ErrorWhileSettingData

Constructor & Destructor Documentation

◆ ETimeTicketSellModule()

EM::TicketIssueLogic::ETimeTicketSellModule::ETimeTicketSellModule	(	ETicketIssueLogicDataStorage *	dataStorage,
		std::string	moduleName = `E_TIME_TICKET_SELL_MODULE_NAME`
	)

◆ ~ETimeTicketSellModule()

virtual EM::TicketIssueLogic::ETimeTicketSellModule::~ETimeTicketSellModule ( )

virtual

Member Function Documentation

◆ AutoBeginValidity()

virtual bool EM::TicketIssueLogic::ETimeTicketSellModule::AutoBeginValidity ( unsigned long date = 0 )

virtual

Automatically modifies date relative to property of actual tariff. Result is stored in DataStorage in TimeTicketValidityStart If date wasn't given (default param), method works with actual time-date.

Parameters

date	- to be modified and set

Returns: true when everything's ok, otherwise false

◆ CalculateEndValidity()

virtual bool EM::TicketIssueLogic::ETimeTicketSellModule::CalculateEndValidity ( )

virtual

CalculateEndValidity - Calculates validity end of time ticket and stores it in DataStorage.

Returns: true if no error occured, otherwise false

◆ CheckValidity()

virtual bool EM::TicketIssueLogic::ETimeTicketSellModule::CheckValidity	(	unsigned long	validityBeginDate,
		unsigned long	validityEndDate
	)

virtual

Function checks if given date isn't too far in future of too far in tha past (according to tariff properties in input data)

Parameters

validityBeginDate	- validity begin date
validityEndDate	- validity end date

Returns: true if given date is OK, otherwise false

◆ CorrectValidity()

virtual bool EM::TicketIssueLogic::ETimeTicketSellModule::CorrectValidity ( )

virtual

CorrectValidity corrects already values (validity from and validity to) stored in dataStorage according to properties of actual tariff (PlatnPredZacPlCL and PlatnPoSkoncPlCL) and saves it back into DataStorage.

Returns: true if no error occured, otherwise false

◆ FillAdditionalDataCalculatePrice()

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

virtual

Function set to inputDataCalculatePrice time ticket validity.

Parameters

inputDataCalculatePrice - input data to calculate price

Implements EM::TicketIssueLogic::ECalculatePriceModuleInterface.

◆ FillTimeTicket()

virtual FillTimeTicketResult EM::TicketIssueLogic::ETimeTicketSellModule::FillTimeTicket ( unsigned char index )

virtual

FillTimeTicket - sets all time ticket data to facade @list what is set to facade:

tariff
time validity
zones
time ticket number (counter)
price and price unit
time ticket status
network
company number
urban transport ident. number
Parameters

index - index of time ticket in collection to be modified

◆ GetAvailableTimeTicketIndex()

virtual bool EM::TicketIssueLogic::ETimeTicketSellModule::GetAvailableTimeTicketIndex ( unsigned char & index )

virtual

Finds first time ticket that is invalid (it means that it's status is set as not valid) or no longer valid.

Parameters

index - found index, that is available for new time ticket

Returns: true when some index was found, otherwise false (no space on card)

◆ GetTimeTicketIndexByTariffTicketNumber()

virtual bool EM::TicketIssueLogic::ETimeTicketSellModule::GetTimeTicketIndexByTariffTicketNumber	(	unsigned short	tariffTicketNumber,
		char &	correspondingTTIndex
	)

virtual

GetTimeTicketIndexByTariffTicketNumber - function return time ticket index with entered tariff ticket number and oldest end validity of ticket on index ( multiple indexes could have same tariff ticket number )

Parameters

tariffTicketNumber	- tariff ticket number
correspondingTTIndex	- output paramterer for found time ticket index

Returns: true if corresponding time ticket index found for entered tariff ticket number else return false

◆ Init()

virtual EIssueLogicDefines::ReturnValues EM::TicketIssueLogic::ETimeTicketSellModule::Init ( )

virtual

init module input data ( for example other module )

Init

Returns: enum result value

Reimplemented from EM::TicketIssueLogic::ETicketIssueModule.

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

src/appcore/ticketissuelogic/modules/ETimeTicketSellModule.h

Public Types

Public Member Functions

Member Enumeration Documentation

◆ FillTimeTicketResult

Constructor & Destructor Documentation

◆ ETimeTicketSellModule()

◆ ~ETimeTicketSellModule()

Member Function Documentation

◆ AutoBeginValidity()

◆ CalculateEndValidity()

◆ CheckValidity()

◆ CorrectValidity()

◆ FillAdditionalDataCalculatePrice()

◆ FillTimeTicket()

◆ GetAvailableTimeTicketIndex()

◆ GetTimeTicketIndexByTariffTicketNumber()

◆ Init()