Leosac::Tools::ISchedule Class Reference

#include <ISchedule.hpp>

Inheritance diagram for Leosac::Tools::ISchedule:

Collaboration diagram for Leosac::Tools::ISchedule:

Public Member Functions
virtual	~ISchedule ()=default
virtual ScheduleId	id () const =0
virtual const std::string &	name () const =0
	Retrieve the name of the schedule. More...
virtual void	name (const std::string &)=0
virtual const std::string &	description () const =0
virtual void	description (const std::string &)=0
virtual bool	is_in_schedule (const std::chrono::system_clock::time_point &tp) const =0
	Check whether or not the given time point can be found in the schedule. More...
virtual void	add_timeframe (const SingleTimeFrame &tf)=0
	Add the given timeframe to this schedule;. More...
virtual void	clear_timeframes ()=0
	Remove all the timeframes from this schedule. More...
virtual std::vector< SingleTimeFrame >	timeframes () const =0
	Retrieves the list of timesframes that compose this schedule. More...
virtual void	add_mapping (const Tools::ScheduleMappingPtr &map)=0
virtual void	clear_mapping ()=0
virtual std::vector< Tools::ScheduleMappingPtr >	mapping () const =0
virtual size_t	odb_version () const =0

Detailed Description

Definition at line 38 of file ISchedule.hpp.

Constructor & Destructor Documentation

~ISchedule()

virtual Leosac::Tools::ISchedule::~ISchedule ( )

virtualdefault

Member Function Documentation

add_mapping()

virtual void Leosac::Tools::ISchedule::add_mapping ( const Tools::ScheduleMappingPtr &  map )

pure virtual

Implemented in Leosac::Tools::Schedule.

add_timeframe()

virtual void Leosac::Tools::ISchedule::add_timeframe ( const SingleTimeFrame &  tf )

pure virtual

Add the given timeframe to this schedule;.

Implemented in Leosac::Tools::Schedule.

clear_mapping()

virtual void Leosac::Tools::ISchedule::clear_mapping ( )

pure virtual

Implemented in Leosac::Tools::Schedule.

clear_timeframes()

virtual void Leosac::Tools::ISchedule::clear_timeframes ( )

pure virtual

Remove all the timeframes from this schedule.

Implemented in Leosac::Tools::Schedule.

description() [1/2]

virtual const std::string& Leosac::Tools::ISchedule::description ( ) const

pure virtual

Implemented in Leosac::Tools::Schedule.

description() [2/2]

virtual void Leosac::Tools::ISchedule::description ( const std::string &  )

pure virtual

Implemented in Leosac::Tools::Schedule.

id()

virtual ScheduleId Leosac::Tools::ISchedule::id ( ) const

pure virtual

Implemented in Leosac::Tools::Schedule.

is_in_schedule()

virtual bool Leosac::Tools::ISchedule::is_in_schedule ( const std::chrono::system_clock::time_point &  tp ) const

pure virtual

Check whether or not the given time point can be found in the schedule.

Implemented in Leosac::Tools::Schedule.

mapping()

virtual std::vector<Tools::ScheduleMappingPtr> Leosac::Tools::ISchedule::mapping ( ) const

pure virtual

Implemented in Leosac::Tools::Schedule.

name() [1/2]

virtual const std::string& Leosac::Tools::ISchedule::name ( ) const

pure virtual

Retrieve the name of the schedule.

Implemented in Leosac::Tools::Schedule.

name() [2/2]

virtual void Leosac::Tools::ISchedule::name ( const std::string &  )

pure virtual

Implemented in Leosac::Tools::Schedule.

odb_version()

virtual size_t Leosac::Tools::ISchedule::odb_version ( ) const

pure virtual

Implemented in Leosac::Tools::Schedule.

timeframes()

virtual std::vector<SingleTimeFrame> Leosac::Tools::ISchedule::timeframes ( ) const

pure virtual

Retrieves the list of timesframes that compose this schedule.

Implemented in Leosac::Tools::Schedule.

---

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

• src/tools/ISchedule.hpp