Message.h

Go to the documentation of this file.

//////////////////////////////////////////////////////////////////////////////////////////////////
/*! \file Message.h
*  \brief Interface to the Message class.
*  \author $Author: simpliciter $
*  \version $Revision: 1.2 $
*  \date    $Date: 2003/06/12 19:48:35 $
*//////////////////////////////////////////////////////////////////////////////////////////////////
/*!  
*/
//////////////////////////////////////////////////////////////////////////////////////////////////

#ifndef __SSSL_MESSAGE_H__
#define __SSSL_MESSAGE_H__
#include <string>
#include <vector>
using namespace std;

/** \brief Encapsulation of messages with commands and data to be passed between spacecraft.
*
* The message class is used to wrap up message destinations, senders, commands, and parameters.
* The class facilitates the serialization (converting to a string) and parsing (converting from a string) of 
* messages that are passed over some communications link.
* \par Example:
\code
vector<double> parms;
parms.push_back(4);
parms.push_back(3);
parms.push_back(2);
Message testMsg("TYPHON", "THECLA", "SetWheelSpeeds", parms);
\endcode
The message is @em to TYPHON and @em from THECLA. These values should be stored in a table of hosts. The command, 
@em SetWheelSpeeds is the text string of the command, and @em parms is the vector of double values that are 
sent with the message.
*/
class Message 
{
public:
    // Constructors/Deconstructors
    /** @brief Creates a message with the specified destination, sender, command and parameters. */
    Message(string dest, string sender, string command, vector<double> params) : m_Destination(dest), m_Sender(sender), m_Command(command), m_Parameters(params.begin(), params.end()) {}
    
    /** @brief Creates a message object from a serialized (string) message. */
    Message(string _incomingMsg)                { Parse(_incomingMsg); }
    
    virtual ~Message() {};
    
    // Facilitators
    /** @brief Parses a serialized (string) incoming message, and fills out the Message object fields. */
    void Parse(string _incomingMsg);

    /** @brief Converts the message object into a serialized string of data in ASCII format. */
    string Serialize() const;
    
    // Inspectors
    /** @brief Returns the current destination of the message. */
    string GetDestination() const               {return m_Destination;};
    
    /** @brief Returns the current sender of the message. */
    string GetSender() const                    {return m_Sender;};
    
    /** @brief Returns the current command to be sent with the message. */
    string GetCommand() const                   {return m_Command;};
    
    /** @brief Returns a specific parameter value from a message. */
    double GetParameter(int paramNumber) const  {return m_Parameters[paramNumber];};
    
    /** @brief Returns the entire parameter list of the message. */
    vector<double> GetParameters() const        {return m_Parameters;};
    
    // Mutators
    /** @brief Set a new destination for the message. */
    void SetDestination(const string& newDestination)   {m_Destination = newDestination;};
    
    /** @brief Change the command of the message. */
    void SetCommand(const string& newCommand)           {m_Command = newCommand;};
    
protected:
    // Data Members
    string m_Destination;       /**< Message destination referring to the device's name */
    string m_Sender;            /**< Message sender referring to the device's name */
    string m_Command;           /**< String naming the command in the body of the message */
    vector<double> m_Parameters;/**< variable length vector of command parameters */
private:

};

#endif


// Do not change the comments below - they will be added automatically by CVS
/*****************************************************************************
*       $Log: Message.h,v $
*       Revision 1.2  2003/06/12 19:48:35  simpliciter
*       Fixed doxygen syntax.
*       
*       Revision 1.1.1.1  2003/06/06 18:44:15  simpliciter
*       Initial submission.
*       
*
******************************************************************************/

---