OnixS C++ B3 BOE Binary Order Entry 1.3.0
API Documentation
Loading...
Searching...
No Matches
SessionSchedule Class Reference

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() [1/2]

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() [2/2]

SessionSchedule ( const SessionSchedule & other)

Member Function Documentation

◆ logonTime() [1/2]

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.

◆ logonTime() [2/2]

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

Sets the logon time.

Definition at line 193 of file SessionSchedule.h.

◆ logoutTime() [1/2]

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.

◆ logoutTime() [2/2]

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

Sets the logout time.

Definition at line 206 of file SessionSchedule.h.

◆ operator=()

SessionSchedule & operator= ( const SessionSchedule & other)

◆ resetDay()

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.

◆ SessionStateChanger

friend class SessionStateChanger
friend

Definition at line 178 of file SessionSchedule.h.