device.h

Go to the documentation of this file.

// =============================================================================
// =============================================================================

#ifndef HF_DEVICE_H
#define HF_DEVICE_H

#include "hanfun/common.h"
#include "hanfun/transport.h"

namespace HF
{
   // Forward declaration of the core namespace.
   namespace Core
   {
      namespace DeviceInformation
      {
         struct Server;

      }  // namespace DeviceInformation

      namespace AttributeReporting
      {
         struct IServer;

      }  // namespace AttributeReporting

      namespace GroupTable
      {
         class IServer;

      }  // namespace GroupTable

      namespace Time
      {
         class Server;

      }  // namespace Time

      namespace BatchProgramManagement
      {
         class IServer;
      }  // namespace BatchProgramManagement

      namespace Scheduling
      {
         namespace Event
         {
            struct IServer;

         } // namespace Event

         namespace Weekly
         {
            struct IServer;

         } // namespace Weekly

      }  // namespace Scheduling

   }  // namespace Core

   // Forward declaration of the units namespace.
   namespace Units
   {
      // Forward declaration of the Unit's interface.
      struct IUnit;

   }  // namespace Units

   // Forward declaration of the protocol namespace.
   namespace Protocol
   {
      // Forward declaration of the protocol packet structure.
      struct Packet;

   }  // namespace Protocol

   struct IDevice: public Transport::Endpoint
   {
      struct IUnits: public Common::SimpleList<Units::IUnit *>
      {
         IUnits::size_type size() const
         {
            return distance(begin(), end());
         }
      };

      struct IUnit0
      {
         virtual Core::DeviceInformation::Server *device_info() const = 0;

         virtual Core::DeviceInformation::Server *device_info() = 0;

         virtual Core::AttributeReporting::IServer *attribute_reporting() const = 0;

         virtual Core::AttributeReporting::IServer *attribute_reporting() = 0;

#if HF_GROUP_SUPPORT

         virtual HF::Core::GroupTable::IServer *group_table() = 0;

         virtual HF::Core::GroupTable::IServer *group_table() const = 0;
#endif

#if HF_TIME_SUPPORT

         virtual HF::Core::Time::Server *time() = 0;

         virtual HF::Core::Time::Server *time() const = 0;
#endif

#if HF_BATCH_PROGRAM_SUPPORT

         virtual HF::Core::BatchProgramManagement::IServer *batch_program() = 0;

         virtual HF::Core::BatchProgramManagement::IServer *batch_program() const = 0;
#endif

#if HF_EVENT_SCHEDULING_SUPPORT

         virtual HF::Core::Scheduling::Event::IServer *event_scheduling() = 0;

         virtual HF::Core::Scheduling::Event::IServer *event_scheduling() const = 0;
#endif

#if HF_WEEKLY_SCHEDULING_SUPPORT

         virtual HF::Core::Scheduling::Weekly::IServer *weekly_scheduling() = 0;

         virtual HF::Core::Scheduling::Weekly::IServer *weekly_scheduling() const = 0;
#endif

      };

      virtual uint16_t address() const = 0;

      virtual const IUnits &units() const = 0;

      virtual Units::IUnit *unit(uint8_t id) const = 0;

      virtual IUnit0 *unit0() const = 0;

      virtual void add(Units::IUnit *unit) = 0;

      virtual void remove(Units::IUnit *unit) = 0;

      virtual void send(Protocol::Packet &packet) = 0;

      virtual void periodic(uint32_t time) = 0;
   };

}  // namespace HF

#endif /* DEVICE_H_ */