summaryrefslogtreecommitdiff
path: root/cesar/maximus/phy/inc/PhySciMsgPre.h
diff options
context:
space:
mode:
Diffstat (limited to 'cesar/maximus/phy/inc/PhySciMsgPre.h')
-rw-r--r--cesar/maximus/phy/inc/PhySciMsgPre.h116
1 files changed, 116 insertions, 0 deletions
diff --git a/cesar/maximus/phy/inc/PhySciMsgPre.h b/cesar/maximus/phy/inc/PhySciMsgPre.h
new file mode 100644
index 0000000000..5cdce244c1
--- /dev/null
+++ b/cesar/maximus/phy/inc/PhySciMsgPre.h
@@ -0,0 +1,116 @@
+/************************************************************************
+ PhySciMsgPre.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/phy/inc/PhySciMsgPre.h
+**************************************************************************/
+
+#ifndef PHYSCIMSGPRE_H
+#define PHYSCIMSGPRE_H
+
+#include "PhySciMsg.h"
+
+
+/**
+ * class PhySciMsgPre
+ */
+
+class PhySciMsgPre : public PhySciMsg
+{
+
+public:
+
+ // public attributes
+ //
+
+private:
+
+ // private attributes
+ //
+
+protected:
+
+ // protected attributes
+ //
+
+public:
+
+ // Constructors/Destructors
+ //
+
+ /**
+ * Constructor
+ * Creates a PHY message of type PREAMBLE.
+ * @param p_phy_processor a pointer to the PHY interface
+ */
+ PhySciMsgPre ( IPhy * p_phy_processor );
+
+ /**
+ * Empty Destructor
+ */
+ virtual ~PhySciMsgPre ( );
+
+ // public methods
+ //
+
+ /**
+ * Sets the PHY SCI message class attributes before transmission,
+ * and fills specialized SCI msg data length and specialized SCI msg data
+ * for a PHY SCI message of type PREAMBLE.
+ * @param clock_id ID of the Network Clock event received message
+ * @return bool
+ */
+ bool prepare ( Network_Clock_Id clock_id );
+
+ // public attribute accessor methods
+ //
+
+ // private attribute accessor methods
+ //
+
+ // protected attribute accessor methods
+ //
+
+private:
+
+ // private methods
+ //
+
+ /**
+ * Initializes the PHY SCI message class attributes.
+ * Fills PHY SCI message type.
+ */
+ void initAttributes ( );
+
+protected:
+
+ // protected methods
+ //
+
+};
+
+
+#endif // PHYSCIMSGPRE_H