jaus++/2.0/include/jaus/core/liveness/queryheartbeatpulse.h

Go to the documentation of this file.

#ifndef __JAUS_CORE_LIVENESS_QUERY_HEARTBEAT_PULSE__H
#define __JAUS_CORE_LIVENESS_QUERY_HEARTBEAT_PULSE__H

#include "jaus/core/corecodes.h"
#include "jaus/core/message.h"

namespace JAUS
{
    class QueryHeartbeatPulse : public Message
    {
    public:
        QueryHeartbeatPulse(const Address& dest = Address(), 
                            const Address& src = Address()) : Message(QUERY_HEARTBEAT_PULSE, dest, src)
        {
        }
        QueryHeartbeatPulse(const QueryHeartbeatPulse& message) : Message(QUERY_HEARTBEAT_PULSE)
        {
            *this = message;
        }
        ~QueryHeartbeatPulse() {}
        // Return true if a command message, otherwise false.
        virtual bool IsCommand() const { return false; }
        // Writes message payload data to the packet at the current write position.
        virtual int WriteMessageBody(Packet& packet) const { return 0; }
        // Reads message payload data from the packets current read position.
        virtual int ReadMessageBody(const Packet& packet) { return 0; }
        // Make a copy of the message and returns pointer to it.
        virtual Message* Clone() const { return new QueryHeartbeatPulse(*this); }
        // Gets the presence vector data for the message.
        virtual UInt GetPresenceVector() const { return 0; }
        // Get the size of the message presence vector. 0 value indicates no presence vector.
        virtual UInt GetPresenceVectorSize() const { return 0; }
        // Get the mask associated with presence vector.  Indicates what bits are used.
        virtual UInt GetPresenceVectorMask() const { return 0; }
        // Gets the response type to the associated message, 0 if message is a response type.
        virtual UShort GetMessageCodeOfResponse() const { return REPORT_HEARTBEAT_PULSE; }
        // Gets the name of the message in human readable format (for logging, etc.)
        virtual std::string GetMessageName() const { return "Query Heartbeat Pulse"; }
        // Clears only message body information.
        virtual void ClearMessageBody() {}
        // Return true if payload is greater than maxPaylodSize (payload == message data only).
        virtual bool IsLargeDataSet(const unsigned int maxPayloadSize) const { return false; }
        QueryHeartbeatPulse& operator=(const QueryHeartbeatPulse& message)
        {
            CopyHeaderData(&message);
            return *this;
        }
    };
}

#endif
/*  End of File */