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

Weekly Scheduling Service : Client side implementation. More...

#include <weekly_scheduling.h>

+ Inheritance diagram for HF::Core::Scheduling::Weekly::IClient:
+ Collaboration diagram for HF::Core::Scheduling::Weekly::IClient:

Public Member Functions

 IClient ()
 Constructor.
 
virtual ~IClient ()
 Destructor.
 
virtual void activate_scheduler (const Protocol::Address &addr, bool enabled)
 Send a HAN-FUN message containing a Scheduling::ACTIVATE_SCHEDULER_CMD, to the given network address. More...
 
virtual void define_event (const Protocol::Address &addr, uint8_t id, uint8_t status, Day &time, uint8_t pid)
 Send a HAN-FUN message containing a Scheduling::DEFINE_CMD, to the given network address. More...
 
virtual void delete_event (const Protocol::Address &addr, uint8_t id)
 Send a HAN-FUN message containing a Scheduling::DELETE_CMD, to the given network address. More...
 
- Public Member Functions inherited from HF::Interfaces::Interface< _uid, Parent >
uint16_t uid () const
 This method returns the interface UID. More...
 

Detailed Description

Weekly Scheduling Service : Client side implementation.

This class provides the client side of the Weekly Scheduling interface.

Definition at line 253 of file weekly_scheduling.h.

Member Function Documentation

◆ activate_scheduler()

virtual void HF::Core::Scheduling::Weekly::IClient::activate_scheduler ( const Protocol::Address addr,
bool  enabled 
)
inlinevirtual

Send a HAN-FUN message containing a Scheduling::ACTIVATE_SCHEDULER_CMD, to the given network address.

Parameters
[in]addrthe network address to send the message to.
[in]enabledenable/disable scheduler.

Definition at line 270 of file weekly_scheduling.h.

References HF::Core::Scheduling::IClient::activate_scheduler().

271  {
272  Scheduling::IClient::activate_scheduler(addr, ITF, enabled);
273  }
void activate_scheduler(const Protocol::Address &addr, const Interface::UID itf_uid, bool enabled=true)
Send a HAN-FUN message containing a Scheduling::ACTIVATE_SCHEDULER_CMD, to the given network address...
+ Here is the call graph for this function:

◆ define_event()

virtual void HF::Core::Scheduling::Weekly::IClient::define_event ( const Protocol::Address addr,
uint8_t  id,
uint8_t  status,
Day time,
uint8_t  pid 
)
virtual

Send a HAN-FUN message containing a Scheduling::DEFINE_CMD, to the given network address.

Parameters
[in]addrthe network address to send the message to.
[in]idthe ID for the event entry.
[in]statusthe event entry status.
[in]timethe time to set the event entry to.
[in]pidthe batch program to call on event.

◆ delete_event()

virtual void HF::Core::Scheduling::Weekly::IClient::delete_event ( const Protocol::Address addr,
uint8_t  id 
)
inlinevirtual

Send a HAN-FUN message containing a Scheduling::DELETE_CMD, to the given network address.

Parameters
[in]addrthe network address to send the message to.
[in]identry ID to delete.

Definition at line 321 of file weekly_scheduling.h.

References HF::Core::Scheduling::IClient::delete_event().

322  {
323  Scheduling::IClient::delete_event(addr, ITF, id);
324  }
void delete_event(const Protocol::Address &addr, const Interface::UID itf_uid, uint8_t id)
Send a HAN-FUN message containing a Scheduling::DELETE_CMD, to the given network address.
+ Here is the call graph for this function:

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