HAN-FUN API  1.5.3
This project provides the common implementation of ULE Alliance's HAN-FUN application protocol.
HF::Core::Scheduling::Weekly::Server< _Entries > Struct Template Reference

Scheduling Service : Server side implementation. More...

#include <weekly_scheduling.h>

+ Inheritance diagram for HF::Core::Scheduling::Weekly::Server< _Entries >:
+ Collaboration diagram for HF::Core::Scheduling::Weekly::Server< _Entries >:

Public Member Functions

 Server (Unit0 &unit)
 Constructor. More...
 
_Entries & entries () const
 Get a reference to the current object implementing the persistence API, for the device information. More...
 
- Public Member Functions inherited from HF::Core::Scheduling::Weekly::IServer
virtual Common::Result define_event (const Protocol::Packet &packet, Scheduling::Entry< Day > &msg)
 Callback that is called when a Scheduling::DEFINE_EVENT_CMD, is received. More...
 
virtual Common::Result update_event_status (const Protocol::Packet &packet, const UpdateStatus &msg)
 Callback that is called when a Scheduling::UPDATE_STATUS_CMD, is received. More...
 
virtual Common::Result get_event_entry (const Protocol::Packet &packet, const GetEntry &msg)
 Callback that is called when a Scheduling::GET_ENTRY_CMD, is received. More...
 
virtual Common::Result delete_event (const Protocol::Packet &packet, const DeleteEvent &msg)
 Callback that is called when a Scheduling::DELETE_CMD, is received. More...
 
virtual Common::Result delete_all_events (const Protocol::Packet &packet)
 Callback that is called when a Scheduling::DELETE_ALL_CMD, is received. More...
 
 IServer (Unit0 &unit)
 Constructor.
 
virtual ~IServer ()
 Destructor.
 
Common::Pointer< Entryentry (const uint8_t id) const
 Get the Weekly Scheduling entry given by id. More...
 
uint8_t next_id () const
 Return next available id for event. More...
 
- Public Member Functions inherited from HF::Core::Service< _ITF, _Parent >
uint16_t uid () const
 This method returns the interface UID. More...
 

Additional Inherited Members

- Protected Member Functions inherited from HF::Core::Scheduling::Base< _ITF, _Parent >
 Base (Unit0 &unit)
 Constructor.
 
- Protected Member Functions inherited from HF::Core::Service< _ITF, _Parent >
 Service (Unit0 &unit)
 Constructor. More...
 
bool check_uid (uint16_t uid) const
 Check if the given uid value matches the service's UID value. More...
 

Detailed Description

template<typename _Entries>
struct HF::Core::Scheduling::Weekly::Server< _Entries >

Scheduling Service : Server side implementation.

This class provides the server side of the Scheduling interface.

Definition at line 502 of file weekly_scheduling.h.

Constructor & Destructor Documentation

◆ Server()

template<typename _Entries >
HF::Core::Scheduling::Weekly::Server< _Entries >::Server ( Unit0 unit)
inline

Constructor.

Parameters
[in]unitreference to the unit containing this service.

Definition at line 518 of file weekly_scheduling.h.

518  : IServer(unit)
519  {}

Member Function Documentation

◆ entries()

template<typename _Entries >
_Entries& HF::Core::Scheduling::Weekly::Server< _Entries >::entries ( ) const
inlinevirtual

Get a reference to the current object implementing the persistence API, for the device information.

Returns
reference to the current object for the persistence API.

Implements HF::Core::Scheduling::Weekly::IServer.

Definition at line 525 of file weekly_scheduling.h.

526  {
527  return const_cast<_Entries &>(_entries);
528  }

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