ZeusBase-Library: IMapMessage.hpp Source File

Go to the documentation of this file.
00001 /*****************************************************************************
00002  * Copyright (C) 2011 by Benjamin Hadorn (b_hadorn@bluewin.ch)
00003  *****************************************************************************
00004  * Project    : Zeus Base Library
00005  * Module     : IMapMessage
00006  * Package    : Zeus.ZeusBase.Messaging.Interfaces
00007  * Author     : Benjamin Hadorn
00008  * Date       : 27.12.2011
00009  * System     : Zeus-Framework
00010  *****************************************************************************
00011  * Licence:                                                                  *
00012  *   This library is free software; you can redistribute it and/or modify    *
00013  *   it under the terms of the GNU Lesser General Public License as          *
00014  *   published by the Free Software Foundation; either version               *
00015  *   2.1 of the License, or (at your option) any later version.              *
00016  *                                                                           *
00017  *   This library is distributed in the hope that it will be useful,         *
00018  *   but WITHOUT ANY WARRANTY; without even the implied warranty of          *
00019  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
00020  *   GNU Lesser General Public License for more details.                     *
00021  *                                                                           *
00022  *   You should have received a copy of the GNU Lesser General Public        *
00023  *   License along with this library; if not, write to the Free Software     *
00024  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA    *
00025  *****************************************************************************/
00026 
00027 /*****************************************************************************
00028  * Changes:
00029  *  27.12.2011 bha: created zeus 2.0
00030  *****************************************************************************/
00031 
00032 #ifndef IMapMessageHPP
00033 #define IMapMessageHPP
00034 
00035 #include <zeusbase/Messaging/Interfaces/IMessage.hpp>
00036 
00037 BEGIN_NAMESPACE_Zeus
00038 
00039 
00040 // {A59CC58B-8BB7-4a7f-B6E3-969A9215AA38}
00041 #define INTERFACE_IMapMessage      TIID(0xa59cc58b, 0x8bb7, 0x4a7f, 0xb6, 0xe3, 0x96, 0x9a, 0x92, 0x15, 0xaa, 0x38)
00042 
00043 /***************************************************************************/
00046 /***************************************************************************/
00047 class IMapMessage : public IMessage
00048 {
00049   HIDE_ASSIGNMENT_OPERATOR(IMapMessage)
00050   
00051   public:
00052     /**************************************************************************/
00059     /**************************************************************************/
00060     virtual Retval MQUALIFIER getString(const IString& rName, IString& rValue) const = 0;
00061 
00062     /**************************************************************************/
00070     /**************************************************************************/
00071     virtual Retval MQUALIFIER getInt(const IString& rName, Int& rValue, Int iDefaultVal = 0) const = 0;
00072 
00073     /**************************************************************************/
00081     /**************************************************************************/
00082     virtual Retval MQUALIFIER getFloat(const IString& rName, Float& rValue, Float fDefaultVal = 0.0) const = 0;
00083 
00084     /**************************************************************************/
00092     /**************************************************************************/
00093     virtual Retval MQUALIFIER getUint(const IString& rName, Uint& rValue, Uint uiDefaultVal = 0) const = 0;
00094 
00095     /**************************************************************************/
00103     /**************************************************************************/
00104     virtual Retval MQUALIFIER getBool(const IString& rName, bool& rValue, bool bDefaultVal = false) const = 0;
00105 
00106     /**************************************************************************/
00111     /**************************************************************************/
00112     virtual void MQUALIFIER setString(const IString& rName, const IString& rValue) = 0;
00113 
00114     /**************************************************************************/
00119     /**************************************************************************/
00120     virtual void MQUALIFIER setInt(const IString& rName, Int iValue) = 0;
00121 
00122     /**************************************************************************/
00127     /**************************************************************************/
00128     virtual void MQUALIFIER setFloat(const IString& rName, Float fValue) = 0;
00129 
00130     /**************************************************************************/
00135     /**************************************************************************/
00136     virtual void MQUALIFIER setUint(const IString& rName, Uint uiValue) = 0;
00137 
00138     /**************************************************************************/
00143     /**************************************************************************/
00144     virtual void MQUALIFIER setBool(const IString& rName, bool bValue) = 0;
00145 };
00146 
00147 END_NAMESPACE_Zeus
00148 
00149 #endif