BionxControl/bcdatavalue.h

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

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

 Using:

 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

 mhs_can_drv.c 3.00
 © 2011 - 2015 by MHS-Elektronik GmbH & Co. KG, Germany
 Demlehner Klaus, info@mhs-elektronik.de
 @see www.mhs-elektronik.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 BCDATAVALUE_H
#define BCDATAVALUE_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). Sin 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 ... )
    -
*/



class BCAbstractTransmitter
{

public:

  virtual uint32_t readRawByte( uint32_t deviceID, uint8_t registerID  ) const = 0;
  virtual void     writeRawByte( uint32_t deviceID, uint8_t registerID , uint8_t value_ ) const = 0;
};


class BCValueType;

class BCDataValue
{

public:

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

  //const BCValueType& valueType;
  //BCValueTypeCRef valueType;
  const BCValueType* valueType{};
  BCDevice::ID       deviceID{BCDevice::ID::Invalid};
  BC::ID             registerID{BC::ID::Invalid};
  int                rowInModel{-1};
  QString            label;
  mutable QString    visibleValue;
  QVariant           defaultValue;

  bool               inSync{false};
  bool               readOnly{false};

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



};
Q_DECLARE_METATYPE(BCDataValue*)


using BCDataList = QVector<BCDataValue>;




// 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 // BCDATAVALUE_H