EnOcean Link  1.14.0.0
Middleware to Connect EnOcean easily to other Projects
eoEEProfile.h
Go to the documentation of this file.
1 /******************************************************************************
2  DISCLAIMER
3 
4  THIS SOFTWARE PRODUCT ("SOFTWARE") IS PROPRIETARY TO ENOCEAN GMBH, OBERHACHING,
5  GERMANY (THE "OWNER") AND IS PROTECTED BY COPYRIGHT AND INTERNATIONAL TREATIES OR
6  PROTECTED AS TRADE SECRET OR AS OTHER INTELLECTUAL PROPERTY RIGHT. ALL RIGHTS, TITLE AND
7  INTEREST IN AND TO THE SOFTWARE, INCLUDING ANY COPYRIGHT, TRADE SECRET OR ANY OTHER
8  INTELLECTUAL PROPERTY EMBODIED IN THE SOFTWARE, AND ANY RIGHTS TO REPRODUCE,
9  DISTRIBUTE, MODIFY, DISPLAY OR OTHERWISE USE THE SOFTWARE SHALL EXCLUSIVELY VEST IN THE
10  OWNER. ANY UNAUTHORIZED REPRODUCTION, DISTRIBUTION, MODIFICATION, DISPLAY OR OTHER
11  USE OF THE SOFTWARE WITHOUT THE EXPLICIT PERMISSION OF OWNER IS PROHIBITED AND WILL
12  CONSTITUTE AN INFRINGEMENT OF THE OWNER'S RIGHT AND MAY BE SUBJECT TO CIVIL OR
13  CRIMINAL SANCTION.
14 
15  THIS SOFTWARE IS PROVIDED BY THE OWNER "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
16  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
17  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN PARTICULAR, THE OWNER DOES NOT WARRANT
18  THAT THE SOFTWARE SHALL BE ERROR FREE AND WORKS WITHOUT INTERRUPTION.
19 
20  IN NO EVENT SHALL THE OWNER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  ******************************************************************************/
27 
34 #ifndef EO_EEPROFILE_H_
35 #define EO_EEPROFILE_H_
36 
37 #include "eoProfile.h"
38 
50 class eoEEProfile: public eoProfile
51 {
52 public:
57  eoEEProfile(uint16_t size = 4);
58  virtual ~eoEEProfile();
59  virtual eoReturn GetValue(CHANNEL_TYPE type, float &value);
60  virtual eoReturn GetValue(CHANNEL_TYPE type, uint8_t &value);
61  virtual eoReturn GetValue(CHANNEL_TYPE type, uint32_t& value);
62 
63 
64  virtual eoReturn GetValue(CHANNEL_TYPE type, uint8_t &value, uint8_t subFlag);
65  virtual eoReturn GetValue(CHANNEL_TYPE type, uint32_t &value, uint8_t subFlag);
66  virtual eoReturn GetValue(CHANNEL_TYPE type, uint64_t &value, uint8_t subFlag);
67  virtual eoReturn GetValue(CHANNEL_TYPE type, float &value, uint8_t subFlag);
68 
69  virtual eoReturn SetValue(CHANNEL_TYPE type, float value);
70  virtual eoReturn SetValue(CHANNEL_TYPE type, uint8_t value);
71  virtual eoReturn SetValue(CHANNEL_TYPE type, uint32_t value);
72 
73  virtual eoReturn SetValue(CHANNEL_TYPE type, float value, uint8_t subFlag);
74  virtual eoReturn SetValue(CHANNEL_TYPE type, uint8_t value, uint8_t subFlag);
75  virtual eoReturn SetValue(CHANNEL_TYPE type, uint32_t value, uint8_t subFlag);
76  virtual eoReturn SetValue(CHANNEL_TYPE type, uint64_t value, uint8_t subFlag);
77 
78 
79  virtual eoChannelInfo* GetChannel(CHANNEL_TYPE type, uint8_t subType);
80  virtual eoChannelInfo* GetChannel(CHANNEL_TYPE type);
81  virtual eoChannelInfo* GetChannel(uint8_t channelNumber);
82  virtual eoReturn GetSubTypeChannel(CHANNEL_TYPE type, std::vector<eoEEPChannelInfo*>& vector);
83 
84  virtual uint8_t GetChannelCount() const;
85 
86 protected:
90  uint8_t channelCount;
91  static void CopyItemToChannel(eoEEPChannelInfo &channel, EEP_ITEM const * item);
92 
93 };
98 #endif /* EOEEPROFILE_H_ */
uint8_t type
Type.
Definition: eoProfile.h:69
virtual eoChannelInfo * GetChannel(CHANNEL_TYPE type, uint8_t subType)
base class for EEProfile parsing
Definition: eoEEProfile.h:50
virtual eoReturn GetValue(CHANNEL_TYPE type, float &value)
Gets the Value as Floating Point.
Abstract class for channel information. Abstract class for channel information. From this class speci...
Definition: eoChannelInfo.h:77
eoReturn
contains all the return values from different functions
Definition: eoApiDef.h:40
Specific class for EEP channel information. Class used to describe the EEP channels. It has the EEP_ITEM to describe the EEP channel values and the subtype - index.
Definition: eoChannelInfo.h:110
virtual eoReturn SetValue(CHANNEL_TYPE type, float value)
Sets the Value using a Floating Point.
virtual eoReturn GetSubTypeChannel(CHANNEL_TYPE type, std::vector< eoEEPChannelInfo *> &vector)
CHANNEL_TYPE
Definition: eoChannelEnums.h:169
base class for Profile parsing
Definition: eoProfile.h:61
eoEEPChannelInfo * channel
ChannelInfo list for direct Access to channels.
Definition: eoEEProfile.h:88
uint8_t channelCount
Number of channels.
Definition: eoEEProfile.h:90
Definition: eoChannelInfo.h:49
eoEEProfile(uint16_t size=4)
virtual uint8_t GetChannelCount() const