/************************************************************************ ClockSciMsg.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.", 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/networkclock/inc/ClockSciMsg.h **************************************************************************/ #ifndef CLOCKSCIMSG_H #define CLOCKSCIMSG_H #include "SciMsg.h" #include "networkclock_types.h" class INetworkClock; /** * class ClockSciMsg */ class ClockSciMsg : public SciMsg { public: // public attributes // private: // private attributes // // Get from specialized SCI msg header // Network_Clock_Type mSpecializedSciMsgType; Network_Clock_Id mSpecializedSciMsgId; Network_Clock_Tick mSpecializedSciMsgTick; // Specialized SCI message header // Network_Clock_Header mSpecializedSciMsgHeader; INetworkClock * mpNetworkClockProcessor; protected: // protected attributes // public: // Constructors/Destructors // /** * Constructor */ ClockSciMsg ( INetworkClock * p_network_clock_processor ); /** * Empty Destructor */ virtual ~ClockSciMsg ( ); // public methods // /** * @return SciMsg * */ SciMsg * create ( ) const; /** * @return bool */ bool dispatchMsg ( ); /** * @return bool */ bool identifySpecializedSciMsgHeader ( ); /** * @return bool */ bool checkCompatibility ( ) const; void displaySpecializedSciMsgHeader ( ) const; /** * Display the specialized SCI message type. */ void displaySpecializedSciMsgType ( int log_level ) const; // public attribute accessor methods // // private attribute accessor methods // /** * @return mSpecializedSciMsgType */ Network_Clock_Type getSpecializedSciMsgType ( ) const; /** * @return bool * @param type the new value of mSpecializedSciMsgType */ bool setSpecializedSciMsgType ( const Network_Clock_Type type ); /** * @return mSpecializedSciMsgId */ Network_Clock_Id getSpecializedSciMsgId ( ) const; /** * @return bool * @param id the new value of mSpecializedSciMsgId */ bool setSpecializedSciMsgId ( const Network_Clock_Id id ); /** * @return mSpecializedSciMsgTick */ Network_Clock_Tick getSpecializedSciMsgTick ( ) const; /** * @return bool * @param tick the new value of mSpecializedSciMsgTick */ bool setSpecializedSciMsgTick ( const Network_Clock_Tick tick ); /** * Set the value of mSpecializedSciMsgHeader.id * @return bool */ bool setId ( const Network_Clock_Id id ); /** * Set the value of mSpecializedSciMsgHeader.tick_high * @return bool */ bool setTickHigh ( const uint32_t tick_high ); /** * Set the value of mSpecializedSciMsgHeader.tick_low * @return bool */ bool setTickLow ( const uint32_t tick_low ); /** * Get the value of mSpecializedSciMsgHeader * @return the value of mSpecializedSciMsgHeader into a void pointer */ void * returnSpecializedSciMsgHeader ( ) const; /** * @return mSpecializedSciMsgHeader */ const Network_Clock_Header & getSpecializedSciMsgHeader ( ) const; /** * @return bool * @param specialized_sci_msg_header */ bool setSpecializedSciMsgHeader ( const Network_Clock_Header & specialized_sci_msg_header ); // protected attribute accessor methods // private: // private methods // void initAttributes ( ) ; protected: // protected methods // }; #endif // CLOCKSCIMSG_H