OnixS C++ B3 BOE Binary Order Entry  1.2.0
API Documentation
SessionSchedule Class Reference

#include <OnixS/B3/BOE/scheduling/SessionSchedule.h>

Public Member Functions

 SessionSchedule (DayOfWeek::Enum firstDay, DayOfWeek::Enum lastDay, TimeOfDay logonTime, TimeOfDay logoutTime)
 
 SessionSchedule (const SessionSchedule &other)
 
TimeOfDay logonTime (DayOfWeek::Enum day) const noexcept
 
SessionSchedulelogonTime (DayOfWeek::Enum day, TimeOfDay time) noexcept
 
TimeOfDay logoutTime (DayOfWeek::Enum day) const noexcept
 
SessionSchedulelogoutTime (DayOfWeek::Enum day, TimeOfDay time) noexcept
 
DayOfWeek::Enum resetDay () const noexcept
 
SessionScheduleoperator= (const SessionSchedule &other)
 

Friends

class SessionStateChanger
 

Detailed Description

Definition at line 138 of file SessionSchedule.h.

Constructor & Destructor Documentation

SessionSchedule ( DayOfWeek::Enum  firstDay,
DayOfWeek::Enum  lastDay,
TimeOfDay  logonTime,
TimeOfDay  logoutTime 
)

Constructor.

Parameters
firstDaythe first day of the week.
lastDaythe last day of the week.
logonTimethe logon time.
logoutTimethe logout time.
SessionSchedule ( const SessionSchedule other)

Member Function Documentation

TimeOfDay logonTime ( DayOfWeek::Enum  day) const
inlinenoexcept
Returns
the logon time.

If the logon is not performed on the given day, returns the result of TimeOfDay::bad().

Definition at line 187 of file SessionSchedule.h.

SessionSchedule & logonTime ( DayOfWeek::Enum  day,
TimeOfDay  time 
)
inlinenoexcept

Sets the logon time.

Definition at line 193 of file SessionSchedule.h.

TimeOfDay logoutTime ( DayOfWeek::Enum  day) const
inlinenoexcept
Returns
the logout time.

If the logout is not performed on the given day, returns the result of TimeOfDay::bad().

Definition at line 200 of file SessionSchedule.h.

SessionSchedule & logoutTime ( DayOfWeek::Enum  day,
TimeOfDay  time 
)
inlinenoexcept

Sets the logout time.

Definition at line 206 of file SessionSchedule.h.

SessionSchedule& operator= ( const SessionSchedule other)
DayOfWeek::Enum resetDay ( ) const
inlinenoexcept
Returns
the day of the week on which the session is reset.

Definition at line 213 of file SessionSchedule.h.

Friends And Related Function Documentation

friend class SessionStateChanger
friend

Definition at line 178 of file SessionSchedule.h.


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