MlpMessage.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2009, Czech Technical University in Prague
 * All rights reserved.
 *
 * Authors/Contact:
 *
 * Petr Vlacil
 * (vlacipet@fel.cvut.cz)
 * R&D Centre (RDC) for Mobile Applications
 * Dept of Telecommunications Engineering
 * Faculty of Electrical Engineering
 * Czech Technical University in Prague
 * Technicka 2, 166 27 Prague 6, Czech Republic
 *
 * Redistribution and use in source and binary forms, with or 
 * without modification, are permitted provided that the following 
 * conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of the Czech Technical University in Prague nor
 *    the names of its contributors may be used to endorse or promote 
 *    products derived from this software without specific prior
 *    written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */


#ifndef MLP_MESSAGE_H
#define MLP_MESSAGE_H


/** 
 * \file
 * \brief  MlpErrorHandler header file
 *
 * This file contains  MlpErrorHandler class declaration.
 *
 * \author Petr Vláčil
 */


//--------------------------------------------------------------------------
//  Standard libraries
//--------------------------------------------------------------------------
#include <string>

//--------------------------------------------------------------------------
//  MLP-Lib-Cpp library files
//--------------------------------------------------------------------------
#include <libmlp-cpp/MlpHdr.hpp>
#include <libmlp-cpp/MlpSubscriberList.hpp>
#include <libmlp-cpp/MlpPositionList.hpp>


/**
 * \brief MlpMessage 
 *
 * This class implements MLP message. It holds some message parameters and
 * pointers to message header, subscriber list or position list.
 */
class MlpMessage {
    protected:
        /** */
        std::string _msgBody;
        /** Session ID */
        std::string _sessionId;
        /** Message version */
        std::string _msgVersion;
        /** Message type */
        int _msgType;
        /** Service version */
        std::string _serviceVersion;
        /** Service type */
        int _serviceType;
        /** Service response type */
        int _serviceResType;
        /** request ID */
        std::string _reqId;

        /** Result in case of message does not contain position. */
        std::string _result;
        /** Result id in case of error. */
        std::string _resId;
        /** add Info in case of error. */
        std::string _addInfo;

        /** Pointer to MlpHdr */
        MlpHdr* _hdr;
        /** Pointer to MlpSubscriberList */
        MlpSubscriberList* _subscriberList;
        /** Pointer to MlpPoistionList */
        MlpPositionList* _positionList;

    public:
        /** Constructor */
        MlpMessage ();
        /** Destructor */
        ~MlpMessage ();

        /** Setter for session id */
        void setSessionId ( std::string sessionId );
        /** Getter for session id */
        std::string getSessionId ();

        /** Setter for message version */
        void setMsgVer ( std::string ver );
        /** Getter for message version*/
        std::string getMsgVer ();

        /** Setter for message type */
        void setMsgType ( int type );
        /** Getter for message type */
        int getMsgType ();

        /** Setter for service version */
        void setServiceVer ( std::string ver );
        /** Getter for service version */
        std::string getServiceVer ();

        /** Setter for service type */
        void setServiceType ( int type );
        /** Getter for service type */
        int getServiceType ();

        /** Setter for service response type */
        void setServiceResType ( int responseType);
        /** Getter for service response type */
        int getServiceResType ();

        /** Setter for request id */
        void setReqId ( std::string reqId );
        /** Getter for request id */
        std::string getReqId ();

        /** Set result in case of error. */
        void setResult ( std::string result );
        /** Get result in case of error. */
        std::string getResult ();

        /** Set result id in case of error. */
        void setResId ( std::string resId ) ;
        /** Get result id in case of error. */
        std::string getResId ();

        /** Add Info in case of error. */
        void setAddInfo ( std::string addInfo );
        /** Get Info in case of error. */
        std::string getAddInfo ();

        
        /** Create MlpHdr */
        MlpHdr* createHdr ();
        /** Getter for MlpHdr pointer */
        MlpHdr* getMlpHdr ();

        /** Generate MlpSubscriberList */
        MlpSubscriberList* createSubscriberList ();
        /** Getter for MlpSubscriberList */
        MlpSubscriberList* getSubscriberList ();

        /** Generate MlpPositionList */
        MlpPositionList* createPositionList ();
        /** Getter for MlpPositionList */
        MlpPositionList* getPositionList ();


        /** Convert message to XML string */
        std::string toString ();

};

#endif

---