BionxControl/bcvalue.h

/***************************************************************************

  BionxControl
  Copyright © 2025 christoph holzheuer
  christoph.holzheuer@gmail.com

  Using:

  mhs_can_drv.c
  © 2011 - 2023 by MHS-Elektronik GmbH & Co. KG, Germany
  Klaus Demlehner, klaus@mhs-elektronik.de
  @see www.mhs-elektronik.de

  Based on Bionx data type descriptions from:

  BigXionFlasher USB V 0.2.4 rev. 97
  © 2011-2013 by Thomas Koenig <info@bigxionflasher.org>
  @see www.bigxionflasher.org

  Bionx Bike Info
  © 2018 Thorsten Schmidt (tschmidt@ts-soft.de)
  @see www.ts-soft.de

  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 3 of the License, or
  (at your option) any later version.
  @see https://github.com/bikemike/bionx-bikeinfo

 ***************************************************************************/


#ifndef BCVALUE_H
#define BCVALUE_H

#include <QObject>
#include <QString>
#include <QList>
#include <QVariant>

#include <bc.h>


/*
  Werte haben verschiedene Längen (1,2 und 4 Byte) und werder auf unterschiedliche Art und Weise
  ausgelesen und geschrieben (Siehe BCValueTypeWord). Sie können also Wert-Typen zugeordnet werden. Ein Werttyp
  lässet über eine ID identifizieren, die mit der phyikalische Einheit des Wertes überschneiden kann,
  aber nicht muss: : Km/h, kWh, BCValueTypeWord ... bilden eigene Typen, SoC, Assistence Level sind auch eigene Typen,
  Teilen sich jedoch die Einheit '%'.

  Das ist natürlich annalog zu den ItemTypes:
  - ein Value hat einen ValueType, der bestimmt folgendes:
    - long or short or quad
    - unit (mm, km/h, odo ... )
    -
*/


/**
 * @brief BCAbstractTransmitter ist das abstrakte Basisinterface für die eigentliche
 * Datenübertragung auf Treiberebene.
 */

class BCAbstractTransmitter
{

public:

  virtual uint8_t readByte ( uint32_t deviceID, uint8_t registerID ) const = 0;
  virtual void    writeByte( uint32_t deviceID, uint8_t registerID, uint8_t value_ ) const = 0;
};


class BCValueType;

class BCValue
{

public:

  enum class OpID : uint8_t
  {
    ReadValue,
    WriteValue,
  };

  enum class State : uint8_t
  {
    NoState  = 0x0,
    ReadOnly = 0x1,
    Locked   = 0x2,
    Failed   = 0x4,
    InSync   = 0x8,
    OK       = 0x10
  };
  Q_DECLARE_FLAGS(States, State )

  BCValue( const BCValueType* valueType_, BCDevice::ID deviceID_, BC::ID registerID_ );
  
  QString readRawValueX( const BCAbstractTransmitter& transmitter ) const;
  void    writeRawValueX( const BCAbstractTransmitter& transmitter ) const;
  // void reset()

// später vielleicht
//protected:

  mutable States     state{BCValue::State::NoState};
  //const BCValueType& valueType;
  //BCValueTypeCRef valueType;
  const BCValueType* valueType{};
  BCDevice::ID       deviceID{BCDevice::ID::Invalid};
  BC::ID             registerID{BC::ID::Invalid};
  int                indexRow{-1};
  QString            label;
  // ??
  mutable QString    visibleValue;
  QVariant           defaultValue;
  //??
  bool               inSync{false};
  bool               readOnly{false};

  //mutable std::optional<uint32_t> rawValue;

};
Q_DECLARE_OPERATORS_FOR_FLAGS(BCValue::States)
Q_DECLARE_METATYPE(const BCValue*)
//Q_DECLARE_METATYPE(const BCValue&)

//using BCValueList = QList<BCValue>;

class BCValueList : public QList<BCValue>
{

public:

  BCValueList()
  {
    qDebug() << "BC Construct: " << this;
  }

  BCValueList(const BCValueList& other)
    : QList<BCValue>(other)
  {
    qDebug() << "BC: Copy from: " << &other << "to" << this;
  }

  BCValueList(BCValueList&& other) noexcept
    : QList<BCValue>( other )
  {
    qDebug() << "Move from: " << &other << "to" << this;
  }

  // Copy Assignment Operator
  BCValueList& operator=(const BCValueList& other)
  {
    qDebug() << "BC copy assignment: " << this;
    QList<BCValue>::operator=( other );
    return *this;
  }

  // Move Assignment Operator
  BCValueList& operator=(BCValueList&& other) noexcept
  {
    qDebug() << "BC move assignment: " << this;
    QList<BCValue>::operator=( other );
    return *this;
  }

  ~BCValueList()
  {
    qDebug() << "Destruct: " << this;
  }

};
Q_DECLARE_METATYPE(BCValueList)


// abbreviations:
//   SOC = State Of Charge
//   LMD = Last Measured Discharge
//   NIP = ?

/*

Needed ?
#include <type_traits>

template <typename E>
constexpr auto to_u(E e) noexcept {
 return static_cast<std::underlying_type_t<E>>(e);
}
*/




#endif // BCVALUE_H