eoProfile.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 __EOPROFILE_INCLUDED_
#define __EOPROFILE_INCLUDED_

#include "eoApiDef.h"
#include "eoChannelInfo.h"
#include "eoHalTypes.h"
#include "eoMessage.h"
#include "eoISerialize.h"
#include "eoArchive.h"
#include "eoGPChannelInfo.h"
#include <vector>

class eoProfile: public eoISerialize
{
public:
  uint8_t rorg;
  uint8_t func;
  uint8_t type;
  uint16_t manufacturer;

  eoProfile(uint16_t size = 0);
  virtual ~eoProfile();

  virtual bool operator==(const eoProfile &othProfile) const;

  virtual bool operator!=(const eoProfile &othProfile) const;

  virtual bool IsSecDData(const eoMessage &message);
  virtual void ClearValues();
  //virtual int LearnIn(uint8_t rorg, uint8_t func, uint8_t type);
  //virtual void LearnIn(Message m, Device d);
  virtual eoReturn Create(eoMessage &m);
  virtual eoReturn CreateTeachIN(eoMessage &m);
  virtual eoReturn Parse(const eoMessage &msg);
  //virtual uint8_t GetValue(uint8_t chanNumb,uint16_t &type, float &value);//?
  virtual eoReturn GetValue(CHANNEL_TYPE type, float &value);

  virtual eoReturn GetValue(CHANNEL_TYPE type, float &value, uint8_t subFlag);
  virtual eoReturn GetValue(CHANNEL_TYPE type, uint8_t &value, uint8_t subFlag);
  virtual eoReturn GetValue(CHANNEL_TYPE type, uint32_t& value, uint8_t subFlag);
  virtual eoReturn GetValue(CHANNEL_TYPE type, uint64_t& value, uint8_t subFlag);
  virtual eoReturn SetValue(CHANNEL_TYPE type, float value, uint8_t subFlag);

  virtual eoReturn SetValue(CHANNEL_TYPE type, uint64_t value, uint8_t subFlag);
  virtual eoReturn GetValue(CHANNEL_TYPE type, uint8_t &value);

  virtual eoReturn GetValue(CHANNEL_TYPE type, uint32_t& value);
  //virtual eoReturn GetValue(CHANNEL_TYPE type, uint64_t& value);
  virtual eoReturn SetValue(CHANNEL_TYPE type, uint8_t value, uint8_t subFlag);

  virtual eoReturn SetValue(CHANNEL_TYPE type, uint32_t value, uint8_t subFlag);
 
  virtual eoReturn SetValue(CHANNEL_TYPE type, float value);
  virtual eoReturn SetValue(CHANNEL_TYPE type, uint8_t value);
  //Set value
  virtual eoReturn SetValue(CHANNEL_TYPE type, uint32_t value);
  //virtual eoReturn SetValue(CHANNEL_TYPE type, uint64_t value);
  virtual eoChannelInfo* GetChannel(CHANNEL_TYPE type, uint8_t subType);

  virtual eoChannelInfo* GetChannel(CHANNEL_TYPE type);

  virtual eoChannelInfo* GetChannel(uint8_t channelNumber);

  virtual eoReturn GetSubTypeChannel(CHANNEL_TYPE type, std::vector<eoEEPChannelInfo*>& vector);

  virtual eoReturn SetType(uint8_t type);

  virtual uint8_t Serialize(eoArchive &a);
  virtual uint8_t GetChannelCount() const;

  eoReturn SetManufacturer (uint16_t manufacturerID);

private:

  static uint16_t BitIdxToByte(const uint16_t &bitIdx); 
protected:
  //char profileString[10];
  eoMessage msg;
  static float ScaleFromRAW(uint32_t rawValue, uint32_t rangeMin, uint32_t rangeMax, double scaleMin, double scaleMax);
  static uint32_t ScaleToRAW(float value, uint32_t rangeMin, uint32_t rangeMax, double scaleMin, double scaleMax);

  const static uint8_t maskArray[8];
  static eoReturn GetRawValue(const eoMessage &msg, uint32_t &value, uint16_t offset, uint8_t size);

  static eoReturn SetRawValue(eoMessage &msg, uint32_t value, uint16_t offset, uint8_t size);

};
//static eoProfile emptyProfile = eoProfile(0);
#endif // __EOPROFILE_INCLUDED_