summaryrefslogtreecommitdiff
path: root/cesar/maximus/channel/inc/ChannelMapping.h
blob: 99a353bc4aefdba4b3f811445961fcb5e8aac081 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
/************************************************************************
                        ChannelMapping.h - Copyright buret

Here you can write a license for your code, some comments or any other
information you want to have in your generated code. To to this simply
configure the "headings" directory in uml to point to a directory
where you have your heading files.

or you can just replace the contents of this file with your own.
If you want to do this, this file is located at

/usr/share/apps/umbrello/headings/heading.h

-->Code Generators searches for heading files based on the file extension
   i.e. it will look for a file name ending in ".h" to include in C++ header
   files, and for a file name ending in ".java" to include in all generated
   java code.
   If you name the file "heading.<extension>", Code Generator will always
   choose this file even if there are other files with the same extension in the
   directory. If you name the file something else, it must be the only one with that
   extension in the directory to guarantee that Code Generator will choose it.

you can use variables in your heading files which are replaced at generation
time. possible variables are : author, date, time, filename and filepath.
just write %variable_name%

This file was generated on %date% at %time%
The original location of this file is /home/buret/eclipse/maximus/channel/inc/ChannelMapping.h
**************************************************************************/

#ifndef CHANNEL_MAPPING_H
#define CHANNEL_MAPPING_H

#include "ChannelPoint.h"

#include "channel_types.h" // for 'Channel_Mod'


/**
  * class ChannelMapping
  */

class ChannelMapping
{

public:

  // public attributes
  //  

private:

  // private attributes
  //

  ChannelPoint mPoint;
  unsigned short int mCode;
  static unsigned short int mNbOfBitsArray[MAXIMUS_CHANNEL_MOD_NB];
  static short int mMappingArray[MAXIMUS_CHANNEL_VALUE_MAX_NB][MAXIMUS_CHANNEL_MOD_NB];

protected:
  
  // protected attributes
  //  
  
public:

  // Constructors/Destructors
  //  

  /**
   * Empty Constructor
   */
  ChannelMapping ( );

  /**
   * Constructors
   */
  ChannelMapping ( const unsigned short int code );
  ChannelMapping ( const ChannelPoint & point );

  /**
   * Empty Destructor
   */
  virtual ~ChannelMapping ( );

  // public methods
  //  

  /**
   * Computes the code from the already set I and Q coordinates.
   * @param  modulation  the used modulation
   * @return bool
   */
  unsigned short int computeCode ( const Channel_Mod modulation );

  /**
   * Computes the I and Q coordinates from an already set code.
   * @param  modulation  the used modulation
   * @return bool
   */
  const ChannelPoint & computePoint ( const Channel_Mod modulation );

  /**
   * Retrieve the integer (except for QAM8) I and Q coordinates from the already set I and Q coordinates.
   * @param  modulation  the used modulation
   * @return bool
   */
  const ChannelPoint retrievePoint ( const Channel_Mod modulation );

  // public attribute accessor methods
  //  

  // private attribute accessor methods
  //  

  /**
   * Sets the code.
   * @param  modulation  the used modulation
   * @param  mpdu_payload_length  the length of the MPDU payload
   * @param  p_mpdu_payload  pointer to the MPDU payload
   * @param  mpdu_index  indicates  the current index of the MPDU payload (in bits)
   * @return bool (and update mpdu_index)
   */
  bool setCode ( const Channel_Mod modulation,
                 const unsigned long mpdu_payload_length,
                 const unsigned char * p_mpdu_payload,
                 unsigned int & mpdu_index );

  /**
   * Sets the code.
   * @param  code  the new value of mCode
   * @return bool
   */
  bool setCode ( const unsigned short int code );

  /**
   * Gets the code.
   * @return mCode
   */
  unsigned short int getCode ( ) const;

  /**
   * Sets the coordinates.
   * @param  point  the new value of mPoint
   * @return bool
   */
  bool setPoint ( const ChannelPoint & point );

  /**
   * Gets the Channel Point.
   * @return mPoint
   */
  ChannelPoint & getPoint ( );

  /**
   * Sets the I coordinate.
   * @param  i  the new value of mPoint.I
   * @return bool
   */
  bool setI ( const float i );

  /**
   * Gets the I coordinate.
   * @return mPoint.I
   */
  float getI ( );

  /**
   * Sets the Q coordinate.
   * @param  q  mPoint.Q
   * @return bool
   */
  bool setQ ( const float q );

  /**
   * Gets the Q coordinate.
   * @return mPoint.Q
   */
  float getQ ( );

  /**
   * Gets number of bits coded depending on the channel modulation.
   * @param  channel_mod  channel modulation
   * @return number of bits
   */
  static unsigned short int getNbOfBitsArray ( enum Channel_Mod channel_mod );

  // protected attribute accessor methods
  //  

private:

  // private methods
  //  

protected:

  // protected methods
  //  

};


#endif /* CHANNEL_MAPPING_H */