summaryrefslogtreecommitdiff
path: root/maximus/phy/inc/IPhy.h
diff options
context:
space:
mode:
authorburet2007-08-10 13:21:24 +0000
committerburet2007-08-10 13:21:24 +0000
commit07f140541150f150d5e07e6657d9a249357f8c2c (patch)
tree93cf4dd11bf375ad48d54c97cc18f250af4b9ad4 /maximus/phy/inc/IPhy.h
parent48874eb3c77a15b6608384aa4447d92cdb3ae82a (diff)
Development of Maximus user interface + unitary tests
git-svn-id: svn+ssh://pessac/svn/cesar/trunk@587 017c9cb6-072f-447c-8318-d5b54f68fe89
Diffstat (limited to 'maximus/phy/inc/IPhy.h')
-rw-r--r--maximus/phy/inc/IPhy.h121
1 files changed, 121 insertions, 0 deletions
diff --git a/maximus/phy/inc/IPhy.h b/maximus/phy/inc/IPhy.h
new file mode 100644
index 0000000000..7ad68b4d66
--- /dev/null
+++ b/maximus/phy/inc/IPhy.h
@@ -0,0 +1,121 @@
+/************************************************************************
+ IPhy.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/common/interfaces/IPhy.h
+**************************************************************************/
+
+#ifndef IPHY_H
+#define IPHY_H
+
+#include <string>
+
+#include "phy_types.h"
+#include "sci_types.h"
+
+class PhySciMsg;
+
+
+/**
+ * class IPhy
+ */
+
+class IPhy
+{
+
+public:
+
+ // Constructors/Destructors
+ //
+
+ /**
+ * Empty Constructor
+ */
+ IPhy ( ) { }
+
+ /**
+ * Empty Destructor
+ */
+ virtual ~IPhy ( ) { }
+
+ // public methods
+ //
+
+ /**
+ * @return PhySciMsg *
+ */
+ virtual PhySciMsg * createMsg ( ) = 0;
+
+ /**
+ * @return bool
+ * @param phy_sci_msg
+ */
+ virtual bool sendMsg ( PhySciMsg * phy_sci_msg_to_send ) const = 0;
+
+ /**
+ * @return bool
+ * @param station1_id
+ * @param station2_id
+ * @param link_quality
+ */
+ virtual bool checkLinkQuality ( const Sci_Msg_Station_Id station1_id, const Sci_Msg_Station_Id station2_id, Phy_Link_Quality & link_quality ) const = 0;
+
+ /**
+ * @return bool
+ * @param station1_id
+ * @param station2_id
+ * @param link_quality
+ */
+ virtual bool manageLinkQuality ( const Sci_Msg_Station_Id station1_id, const Sci_Msg_Station_Id station2_id, const Phy_Link_Quality link_quality ) = 0;
+
+ /**
+ * @return bool
+ * @param destination_station_id
+ * @param type
+ * @param mpdu_format
+ * @param pb_nb
+ * @param tonemap_index
+ * @param flags
+ * @param nek
+ * @param pb_measurement
+ * @param pb_header
+ * @param p_data
+ */
+ virtual bool sendAvData ( const Sci_Msg_Station_Id destination_station_id,
+ const Phy_Type type,
+ const Phy_Mpdu_Format mpdu_format,
+ const Phy_Nb_Of_Pbs pb_nb,
+ const Phy_Tonemap_Index tonemap_index,
+ const Phy_Flags flags,
+ const uint32_t nek[4],
+ const uint32_t pb_measurement[PHY_PB_MAX_NB],
+ const uint32_t pb_header[PHY_PB_MAX_NB],
+ const unsigned char * p_data ) const = 0;
+
+};
+
+
+#endif // IPHY_H