XMLMessage.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (C) 2011 by Benjamin Hadorn (b_hadorn@bluewin.ch)
 *****************************************************************************
 * Project    : Zeus Base Library
 * Module     : XMLMessage
 * Package    : Zeus.ZeusBase.Messaging
 * Author     : Benjamin Hadorn
 * Date       : 27.12.2011
 * System     : Zeus-Framework
 *****************************************************************************
 * Licence:                                                                  *
 *   This library is free software; you can redistribute it and/or modify    *
 *   it under the terms of the GNU Lesser General Public License as          *
 *   published by the Free Software Foundation; either version               *
 *   2.1 of the License, or (at your option) any later version.              *
 *                                                                           *
 *   This library is distributed in the hope that it will be useful,         *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of          *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
 *   GNU Lesser General Public License for more details.                     *
 *                                                                           *
 *   You should have received a copy of the GNU Lesser General Public        *
 *   License along with this library; if not, write to the Free Software     *
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA    *
 *****************************************************************************/

/*****************************************************************************
 * Changes:
 *  27.12.2011 bha: created zeus 2.0
 *****************************************************************************/

#ifndef XMLMessageH
#define XMLMessageH

#include <zeusbase/Messaging/Interfaces/IXMLMessage.hpp>
#include <zeusbase/Messaging/AbstractMessage.h>


BEGIN_NAMESPACE_Zeus

/***************************************************************************/
/***************************************************************************/
zeusbase_class TXMLMessage : public TAbstractMessage, public IXMLMessage
{
  public:
    TXMLMessage();
    TXMLMessage(const TString& rstrStream);
    TXMLMessage(NAMESPACE_Zeus::IXMLDocument& rDocu);

    //Methods of IXMLMessage;
    virtual Retval MQUALIFIER getXMLDocument(NAMESPACE_Zeus::IXMLDocument*& rpDocument);
    virtual Retval MQUALIFIER getXMLMainNode(NAMESPACE_Zeus::IXMLNode*& rpNode);
    virtual void MQUALIFIER setXMLDocument(NAMESPACE_Zeus::IXMLDocument& rDocument);

    //Methods of IMessage
    virtual void MQUALIFIER clearBody();
    virtual void MQUALIFIER clearProperties()                   { TAbstractMessage::clearProperties(); }
    virtual void MQUALIFIER getInterfaceID(InterfaceID& rIID) const;
    virtual Uint MQUALIFIER getMessageID() const                { return TAbstractMessage::getMessageID(); }
    virtual Uint MQUALIFIER getPriority() const                 { return TAbstractMessage::getPriority(); }
    virtual void MQUALIFIER getSender(TypGUID& rValue) const    { TAbstractMessage::getSender(rValue); }
    virtual void MQUALIFIER getRecipients(IList<TypGUID>& rlstValue) const                   { TAbstractMessage::getRecipients(rlstValue); }
    virtual Retval MQUALIFIER getPropertyValue(const IString& rName, IString& rValue) const  { return TAbstractMessage::getPropertyValue(rName, rValue); }
    virtual Uint64 MQUALIFIER getTimeStamp() const              { return TAbstractMessage::getTimeStamp(); }
    virtual void MQUALIFIER setMessageID(Uint uiValue)          { TAbstractMessage::setMessageID(uiValue); }
    virtual void MQUALIFIER setPropertyValue(const IString& rName, const IString& rValue)    { TAbstractMessage::setPropertyValue(rName, rValue); }
    virtual void MQUALIFIER setPriority(Uint uiValue)                      { TAbstractMessage::setPriority(uiValue); }
    virtual void MQUALIFIER setSender(const TypGUID& rValue)               { TAbstractMessage::setSender(rValue); }
    virtual void MQUALIFIER setRecipient(const TypGUID& rValue)            { TAbstractMessage::setRecipient(rValue); }
    virtual void MQUALIFIER setRecipients(const IList<TypGUID>& rlstValue) { TAbstractMessage::setRecipients(rlstValue); }
    virtual void MQUALIFIER setTimeStamp(const Uint64& rui64Value)         { TAbstractMessage::setTimeStamp(rui64Value); }

    //Methods of ISerializable
    SERIAL_START(TXMLMessage, L"TXMLMessage")
      //Message header
      SERIAL_PARENTCLASS(TAbstractMessage)
      //Message body
      SERIAL_XMLDOCUMENT(m_pXMLDocument)
    SERIAL_END

    //Methods of IZUnknown
    MEMORY_MANAGER_DECL

  protected:
    virtual ~TXMLMessage();

  private:
    NAMESPACE_Zeus::IXMLDocument* m_pXMLDocument;
};

//INLINE METHODS
/***************************************************************************/
/***************************************************************************/
inline void MQUALIFIER TXMLMessage::getInterfaceID(InterfaceID& rIID) const
{
  rIID = INTERFACE_IXMLMessage;
}





END_NAMESPACE_Zeus

#endif