HF::Core::Scheduling::Event::IClient Struct Reference

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

#include <event_scheduling.h>

Inheritance diagram for HF::Core::Scheduling::Event::IClient:

Collaboration diagram for HF::Core::Scheduling::Event::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, Interval &time, uint8_t pid)
	Send a HAN-FUN message containing a Scheduling::DEFINE_EVENT_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

Event Scheduling Service : Client side implementation.

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

Definition at line 202 of file event_scheduling.h.

Member Function Documentation

activate_scheduler()

virtual void HF::Core::Scheduling::Event::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]	addr	the network address to send the message to.
[in]	enabled	enable/disable scheduler.

Definition at line 219 of file event_scheduling.h.

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

               {
                  Scheduling::IClient::activate_scheduler(addr, ITF, enabled);
               }

Here is the call graph for this function:

define_event()

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

virtual

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

Parameters

[in]	addr	the network address to send the message to.
[in]	id	the ID for the event entry.
[in]	status	the event entry status.
[in]	time	the interval to set the event entry to.
[in]	pid	the batch program to call on event.

delete_event()

virtual void HF::Core::Scheduling::Event::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]	addr	the network address to send the message to.
[in]	id	entry ID to delete.

Definition at line 272 of file event_scheduling.h.

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

               {
                  Scheduling::IClient::delete_event(addr, ITF, id);
               }

Here is the call graph for this function:

---

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

• event_scheduling.h