B2BITS FIX Antenna C++  2.29.0
Public Member Functions | Public Attributes | List of all members
Engine::CronSessionsScheduleParameters Struct Reference

Cron expression based schedule events generator implementation parameters holder class. More...

#include <B2BITS_SessionsScheduler.h>

+ Collaboration diagram for Engine::CronSessionsScheduleParameters:

Public Member Functions

 CronSessionsScheduleParameters (const std::string &tradePeriodBeginArg=std::string(), const std::string &tradePeriodEndArg=std::string(), const std::string &dayOffsArg=std::string(), const std::string &timezoneArg=std::string(), bool lateExecutionArg=false, const TimezoneConverterPtr &pTimezoneConverterArg=TimezoneConverterPtr())
 

Public Attributes

std::string dayOffs
 Cron expression of day offs. More...
 
bool lateExecution
 Flag that determines whatever to do late trade begin event execution or not. More...
 
TimezoneConverterPtr pTimezoneConverter
 
Timezone converter pointer More...
 
std::string timezone
 Timezone name as accepted by instance of TimezoneConverter passed with pTimezoneConverter below. More...
 
std::string tradePeriodBegin
 Cron expression of trade period begin events. More...
 
std::string tradePeriodEnd
 Cron expression of trade period end events. More...
 

Detailed Description

Cron expression based schedule events generator implementation parameters holder class.

Constructor & Destructor Documentation

◆ CronSessionsScheduleParameters()

Engine::CronSessionsScheduleParameters::CronSessionsScheduleParameters ( const std::string &  tradePeriodBeginArg = std::string(),
const std::string &  tradePeriodEndArg = std::string(),
const std::string &  dayOffsArg = std::string(),
const std::string &  timezoneArg = std::string(),
bool  lateExecutionArg = false,
const TimezoneConverterPtr pTimezoneConverterArg = TimezoneConverterPtr() 
)
inline

Member Data Documentation

◆ dayOffs

std::string Engine::CronSessionsScheduleParameters::dayOffs

Cron expression of day offs.

Events that match dayOffs expression have dontNotify_ flag set to true.

See also
System::SchedulerTimeEvent

◆ lateExecution

bool Engine::CronSessionsScheduleParameters::lateExecution

Flag that determines whatever to do late trade begin event execution or not.

If this flag is true generator checks if start(first call to getNextEvent()) is made inside trade period (between trade period begin and trade period end events) and generates trade period begin event if so with eventTime_ set to current time. This forces scheduler to execute this event immediately. If this flag is false no such check is made at start.

◆ pTimezoneConverter

TimezoneConverterPtr Engine::CronSessionsScheduleParameters::pTimezoneConverter


Timezone converter pointer

See also
Engine::TimezoneConverter. engine.properties configured instance can be obtained with FixEngine::singleton()->getProperties()->getTimezoneConverter() call. If this parameter represents empty pointer no conversion can be made. So all times are in UTC in this case.

◆ timezone

std::string Engine::CronSessionsScheduleParameters::timezone

Timezone name as accepted by instance of TimezoneConverter passed with pTimezoneConverter below.

◆ tradePeriodBegin

std::string Engine::CronSessionsScheduleParameters::tradePeriodBegin

Cron expression of trade period begin events.

◆ tradePeriodEnd

std::string Engine::CronSessionsScheduleParameters::tradePeriodEnd

Cron expression of trade period end events.