B2BITS FIX Antenna C++  2.29.0
Public Member Functions | List of all members
System::Schedule Class Referenceabstract

Schedule abstract class that provides access to events generator and serves as callback sink for scheduler. More...

#include <B2BITS_Scheduler.h>

+ Inheritance diagram for System::Schedule:
+ Collaboration diagram for System::Schedule:

Public Member Functions

std::string getScheduleId () const
 Returns Schedule id. More...
 
ScheduleTimelinePtr getScheduleTimeline () const
 Returns smart pointer to events generator. More...
 
virtual void onTimeEvent (const SchedulerTimeEvent &hitEvent, const Engine::TZTimeHelper::UTCTimestamp &timestamp)=0
 Callback routine that is called by scheduler when scheduled event has occurred. More...
 
 Schedule (const std::string &scheduleId, const ScheduleTimelinePtr &timelinePtr)
 Constructor. More...
 
- Public Member Functions inherited from Utils::ReferenceCounter
virtual bool addRef () const throw ()
 Increments reference counter. More...
 
virtual long getNRef () const throw ()
 Returns the current value of the reference counter. More...
 
 ReferenceCounter () throw ()
 Constructor. More...
 
virtual long release () const throw ()
 Decrements reference counter. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Utils::ReferenceCounter
long decrement () const throw ()
 Decrements counter and returns new counter value. More...
 
long increment () const throw ()
 Increments counter and returns new counter value. More...
 
virtual ~ReferenceCounter ()
 Destructor. More...
 

Detailed Description

Schedule abstract class that provides access to events generator and serves as callback sink for scheduler.

Constructor & Destructor Documentation

◆ Schedule()

System::Schedule::Schedule ( const std::string &  scheduleId,
const ScheduleTimelinePtr timelinePtr 
)
inline

Constructor.

Parameters
scheduleId- schedule id.
timelinePtr- events generator instance pointer.

Member Function Documentation

◆ getScheduleId()

std::string System::Schedule::getScheduleId ( ) const
inline

Returns Schedule id.

◆ getScheduleTimeline()

ScheduleTimelinePtr System::Schedule::getScheduleTimeline ( ) const
inline

Returns smart pointer to events generator.

◆ onTimeEvent()

virtual void System::Schedule::onTimeEvent ( const SchedulerTimeEvent hitEvent,
const Engine::TZTimeHelper::UTCTimestamp timestamp 
)
pure virtual

Callback routine that is called by scheduler when scheduled event has occurred.

Parameters
hitEvent- the event occurred.
timestamp- actual UTC timestamp when the event has occurred. This ussualy equals to hitEvent.eventTime_ except cases when scheduler wasn't able to execute event on time. This is event's actual execution timestamp.

Implemented in Engine::SessionsSchedule.