eoGenericProfile.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.
 ******************************************************************************/


#if !defined(EO_GENERIC_PROFILE_H)
#define EO_GENERIC_PROFILE_H
#include "eoGPChannelInfo.h"
#include "eoProfile.h"
#include <vector>
#define GP_MANUFACTURER_LEN 11
#define GP_PURPOSE_LEN 2
#define GP_DATA_DIRECTION_LEN 1

#define GP_MANUFACTURER_OFF 0
#define GP_PURPOSE_OFF 12
#define GP_DATA_DIRECTION_OFF 11

typedef enum
{
  GP_TEACH_IN = 0, GP_TEACH_OUT, GP_TEACH_IN_OUT, RESP_NA
} GP_HEADER_PURPOSE;
typedef enum
{
  UNIDIRECTIONAL = 0, BIDIRECTIONAL
} GP_DATA_DIRECTION;
class eoGenericProfile: public eoProfile
{
public:
  eoGenericProfile();
  eoGenericProfile(uint16_t msgLength);

  GP_HEADER_PURPOSE purpose;
  GP_DATA_DIRECTION dataDirection;

  virtual ~eoGenericProfile();
  void AllowTeachIN();
  bool operator==(const eoGenericProfile &othProfile) const;
  bool operator!=(const eoGenericProfile &othProfile) const;

  eoReturn CreateTeachIN(eoMessage &msg);
  eoReturn Create(eoMessage &m,std::vector<int> channelNumbers);
  eoReturn ParseSelData(const eoMessage &msg);
  eoReturn ParseTeachIN(const eoMessage &msg);
  eoReturn Parse(const eoMessage &msg);
  eoReturn GetValue(uint8_t u8ChannelNumber, float &value);
  eoReturn GetValue(uint8_t u8ChannelNumber, uint8_t &value);
  eoReturn GetValue(uint8_t u8ChannelNumber, uint32_t &value);
  eoReturn GetValue(CHANNEL_TYPE type, float &value);
  eoReturn GetValue(CHANNEL_TYPE type, uint8_t &value);
  eoReturn GetValue(CHANNEL_TYPE type, uint32_t &value);
  eoReturn GetValue(CHANNEL_TYPE type, uint8_t &value, uint8_t subFlag);
  eoReturn GetValue(CHANNEL_TYPE type, uint32_t &value, uint8_t subFlag);
  eoReturn GetValue(CHANNEL_TYPE type, float &value, uint8_t subFlag);

  //Using channelnummber

  eoReturn SetValue(uint8_t u8ChannelNumber, float value);
  eoReturn SetValue(uint8_t u8ChannelNumber, uint8_t value);
  eoReturn SetValue(uint8_t u8ChannelNumber, uint32_t value);
  eoReturn SetValue(CHANNEL_TYPE type, uint32_t value);
  eoReturn SetValue(CHANNEL_TYPE type, float value);
  eoReturn SetValue(CHANNEL_TYPE type, uint8_t value);
  eoReturn SetValue(CHANNEL_TYPE type, uint8_t value, uint8_t subFlag);
  eoReturn SetValue(CHANNEL_TYPE type, uint32_t value, uint8_t subFlag);
  eoReturn SetValue(CHANNEL_TYPE type, float value, uint8_t subFlag);

  eoReturn SetType(uint8_t type);
  //eoReturn AddChannel(eoGPChannelInfo myChannel);
  eoReturn AddChannel(CHANNEL_TYPE type, GP_RESOLUTION resolution, int8_t engMaximum, int8_t engMinimum, GP_SCALING scaleMaximum, GP_SCALING scaleMinimum, VALUE_TYPE valueType);
  eoReturn AddChannelOut(CHANNEL_TYPE type, GP_RESOLUTION resolution, int8_t engMaximum, int8_t engMinimum, GP_SCALING scaleMaximum, GP_SCALING scaleMinimum, VALUE_TYPE valueType);
  eoReturn AddChannel(CHANNEL_TYPE type, VALUE_TYPE valueType);
  eoReturn AddChannelOut(CHANNEL_TYPE type, VALUE_TYPE valueType);
  eoReturn AddChannel(CHANNEL_TYPE type, GP_RESOLUTION resolution, VALUE_TYPE valueType);
  eoReturn AddChannelOut(CHANNEL_TYPE type, GP_RESOLUTION resolution, VALUE_TYPE valueType);
  eoChannelInfo* GetChannel(CHANNEL_TYPE type);
  eoChannelInfo* GetChannel(uint8_t channelNumber);
  eoChannelInfo* GetChannelOut(CHANNEL_TYPE type);
  eoChannelInfo* GetChannelOut(uint8_t channelNumber);
  eoChannelInfo* GetChannel(CHANNEL_TYPE type, uint8_t subType);
  eoChannelInfo* GetChannelOut(CHANNEL_TYPE type, uint8_t subType);
  uint8_t GetChannelCount() const;
  uint8_t GetChannelCountOut() const;
  void ClearChannels();
  void ClearChannelsOut();
  /*
   * Clears Channel Information and internal buffer
   */
  void ClearValues();

  uint8_t Serialize(eoArchive &a);
  uint32_t GetProductId();
  void SetProductId(const uint32_t prodId);

  virtual eoReturn Create(eoMessage &msg);

private:
  static uint8_t GetGPSignal(CHANNEL_TYPE eoChannel);
  eoReturn CreateChannels(const eoMessage &msg);
  std::vector<eoGPChannelInfo> gpChannels;
  std::vector<eoGPChannelInfo> gpChannelsOut;
  uint16_t curBitOffset;
  uint16_t curBitOffsetOut;

  bool parseTeachIn;
  uint32_t productId;

};
#endif // !defined(EA_4EAE7E47_D018_4877_903B_B66D2DDE6E02__INCLUDED_)