element.h

/*
 Copyright (C) AC SOFTWARE SP. Z O.O.
 
 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 as published by the Free Software Foundation; either version 2
 of the License, or (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/
 
#ifndef SRC_SUPLA_ELEMENT_H_
#define SRC_SUPLA_ELEMENT_H_
 
#include <stdint.h>
#include <supla-common/proto.h>
 
class SuplaDeviceClass;
 
namespace Supla {
 
class Channel;
namespace Protocol {
class SuplaSrpc;
}  // namespace Protocol
 
enum class ElementMode : uint8_t {
  Registered,
  Detached,
};

class Element {
 public:
  explicit Element(ElementMode mode = ElementMode::Registered);
  virtual ~Element();
  static Element *begin();

  static Element *last();

  static Element *getElementByChannelNumber(int channelNumber);

  static Element *getOwnerOfSubDeviceId(int subDeviceId);

  static bool IsAnyUpdatePending();

  static void NotifyElementsAboutConfigChange(uint64_t fieldBit);

  static bool IsInvalidPtrSet();

  static void ClearInvalidPtr();

  Element *next();

  virtual void onLoadConfig(SuplaDeviceClass *sdc);

  virtual void purgeConfig();

  virtual void onLoadState();

  virtual void onInit();

  virtual void onSaveState();

  virtual bool isStateStorageMigrationNeeded() const;

  virtual void onRegistered(Supla::Protocol::SuplaSrpc *suplaSrpc = nullptr);

  virtual void iterateAlways();

  virtual bool iterateConnected();
  virtual bool iterateConnected(void *ptr);

  virtual void onTimer();

  virtual void onFastTimer();

  virtual void onSoftReset();

  virtual void onDeviceConfigChange(uint64_t fieldBit);

  virtual int32_t handleNewValueFromServer(TSD_SuplaChannelNewValue *newValue);

  virtual void fillSuplaChannelNewValue(TSD_SuplaChannelNewValue *value);

  virtual bool getRemainingCountdownTimerSec(uint32_t *remainingSec) const;
 
  // Handles "get channel state" request from server
  // channelState is prefilled with network and device status informations
  virtual void handleGetChannelState(TDSC_ChannelState *channelState);

  virtual int handleCalcfgFromServer(TSD_DeviceCalCfgRequest *request);

  virtual uint32_t getCalcfgPendingTimeoutMs(
      TSD_DeviceCalCfgRequest *request) const;
 
  // Returns SUPLA_RESULTCODE_
  virtual uint8_t handleChannelConfig(TSD_ChannelConfig *newChannelConfig,
                                      bool local = false);

  virtual uint8_t handleWeeklySchedule(TSD_ChannelConfig *newWeeklySchedule,
                                       bool altSchedule = false,
                                       bool local = false);
 
  // handleSetChannelConfigResult should handle both standard channel config
  // and weekly schedule config
  virtual void handleSetChannelConfigResult(
      TSDS_SetChannelConfigResult *result);

  virtual void handleChannelConfigFinished();

  int getChannelNumber() const;

  int getSecondaryChannelNumber() const;

  virtual bool isOwnerOfSubDeviceId(int subDeviceId) const;

  virtual const Channel *getChannel() const;
  virtual Channel *getChannel();

  virtual const Channel *getSecondaryChannel() const;
  virtual Channel *getSecondaryChannel();

  const Channel *getChannelByChannelNumber(int channelNumber) const;
  Channel *getChannelByChannelNumber(int channelNumber);

  virtual void generateKey(char *output, const char *key) const;

  Element &disableChannelState();

  bool isChannelStateEnabled() const;

  virtual bool isAnyUpdatePending() const;

  void setInitialCaption(const char *caption, bool secondaryChannel = false);

  bool setDefaultFunction(uint32_t defaultFunction);

  bool setFunction(uint32_t newFunction);

  virtual bool setRuntimeFunction(uint32_t newFunction);

  virtual void onFunctionChange(uint32_t currentFunction, uint32_t newFunction);
 
 protected:
  static Element *firstPtr;
  static bool invalidatePtr;
  bool registeredElement = true;
  Element *nextPtr = nullptr;
};
 
};  // namespace Supla
 
#endif  // SRC_SUPLA_ELEMENT_H_