eoGPChannelInfo.h

Go to the documentation of this file.

/******************************************************************************
 DISCLAIMER

 THIS SOFTWARE PRODUCT ("SOFTWARE") IS PROPRIETARY TO ENOCEAN GMBH, OBERHACHING,
 GERMANY (THE "OWNER") AND IS PROTECTED BY COPYRIGHT AND INTERNATIONAL TREATIES OR
 PROTECTED AS TRADE SECRET OR AS OTHER INTELLECTUAL PROPERTY RIGHT. ALL RIGHTS, TITLE AND
 INTEREST IN AND TO THE SOFTWARE, INCLUDING ANY COPYRIGHT, TRADE SECRET OR ANY OTHER
 INTELLECTUAL PROPERTY EMBODIED IN THE SOFTWARE, AND ANY RIGHTS TO REPRODUCE,
 DISTRIBUTE, MODIFY, DISPLAY OR OTHERWISE USE THE SOFTWARE SHALL EXCLUSIVELY VEST IN THE
 OWNER. ANY UNAUTHORIZED REPRODUCTION, DISTRIBUTION, MODIFICATION, DISPLAY OR OTHER
 USE OF THE SOFTWARE WITHOUT THE EXPLICIT PERMISSION OF OWNER IS PROHIBITED AND WILL
 CONSTITUTE AN INFRINGEMENT OF THE OWNER'S RIGHT AND MAY BE SUBJECT TO CIVIL OR
 CRIMINAL SANCTION.

 THIS SOFTWARE IS PROVIDED BY THE OWNER "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN PARTICULAR, THE OWNER DOES NOT WARRANT
 THAT THE SOFTWARE SHALL BE ERROR FREE AND WORKS WITHOUT INTERRUPTION.

 IN NO EVENT SHALL THE OWNER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 ******************************************************************************/

#ifndef EOGPCHANNELINFO_H_
#define EOGPCHANNELINFO_H_
#include "eoChannelInfo.h"
#include "eoApiDef.h"
#include "eoISerialize.h"
typedef enum
{
  GP_TEACHIN_INFO = 0, 
  GP_DATA,      
  GP_FLAG,      
  GP_ENUMERATION 
} GP_CHANNELTYPE;
typedef enum
{
  GP_RES_RES = 0,
  GP_RES_1BIT = 1,
  GP_RES_2BIT = 2,
  GP_RES_3BIT = 3,
  GP_RES_4BIT = 4,
  GP_RES_5BIT = 5,
  GP_RES_6BIT = 6,
  GP_RES_8BIT = 8,
  GP_RES_10BIT = 10,
  GP_RES_12BIT = 12,
  GP_RES_16BIT = 16,
  GP_RES_20BIT = 20,
  GP_RES_24BIT = 24,
  GP_RES_32BIT = 32
} GP_RESOLUTION;
typedef enum
{
  GP_SCAL_RES = 0,
  GP_SCAL_1,
  GP_SCAL_10,
  GP_SCAL_100,
  GP_SCAL_1000,
  GP_SCAL_10000,
  GP_SCAL_100000,
  GP_SCAL_1000000,
  GP_SCAL_10000000,
  GP_SCAL_0_1,
  GP_SCAL_0_01,
  GP_SCAL_0_001,
  GP_SCAL_0_000001,
  GP_SCAL_0_000000001
} GP_SCALING;

class eoGPChannelInfo: public eoChannelInfo, public eoISerialize
{

  //uint16_t u2ChannelType;
  //uint16_t u8SignalType:8; == signal type
  //uint16_t u2ValueType:2; // = valueFormat
private:
  void CalculateMin();
  void CalculateMax();
  GP_RESOLUTION res; //:4;

  GP_SCALING scaleMin; //:4;
  GP_SCALING scaleMax; //:4;

  int8_t engMax;
  int8_t engMin;
  uint8_t rejected;
  uint8_t u8Subindex;
public:
  uint16_t bitoffs;

  eoGPChannelInfo();
  eoGPChannelInfo(CHANNEL_TYPE type, GP_RESOLUTION resolution, int8_t engMaximum, int8_t engMinimum, GP_SCALING scaleMaximum, GP_SCALING scaleMinimum);

  GP_CHANNELTYPE GetGPChannelType() const;

  static GP_CHANNELTYPE GetGPChannelType(CHANNEL_TYPE type);

  GP_RESOLUTION GetResolution() const;
  //eoReturn SetResolution(GP_RESOLUTION resolution);

  int8_t GetEngMax() const;
  eoReturn Scale(int8_t engMaximum);

  int8_t GetEngMin() const;
  //eoReturn SetEngMin(int8_t engMinimum);

  GP_SCALING GetScaleMax() const;
  //eoReturn SetScaleMax(GP_SCALING scaleMaximum);

  GP_SCALING GetScaleMin() const;

  void SetRejected(uint8_t rejected);

  uint8_t GetRejected();

  static float ScaleToFloat(GP_SCALING scale);
  uint8_t Serialize(eoArchive &a);

  virtual uint8_t GetSubIndex()
  {
    return u8Subindex;
  }

  uint8_t SetSubIndex(uint8_t u8Subindex)
  {
    return this->u8Subindex = u8Subindex;
  }
};

#endif /* EOGPCHANNELINFO_H_ */