Fawkes API Fawkes Development Version
|
00001 00002 /*************************************************************************** 00003 * mapper.cpp - Player proxy to Fawkes interface mapper 00004 * 00005 * Created: Tue Sep 30 00:50:29 2008 00006 * Copyright 2006-2008 Tim Niemueller [www.niemueller.de] 00007 * 00008 ****************************************************************************/ 00009 00010 /* This program is free software; you can redistribute it and/or modify 00011 * it under the terms of the GNU General Public License as published by 00012 * the Free Software Foundation; either version 2 of the License, or 00013 * (at your option) any later version. 00014 * 00015 * This program is distributed in the hope that it will be useful, 00016 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00017 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00018 * GNU Library General Public License for more details. 00019 * 00020 * Read the full text in the LICENSE.GPL file in the doc directory. 00021 */ 00022 00023 #include "mapper.h" 00024 00025 /** @class PlayerProxyFawkesInterfaceMapper "mapper.h" 00026 * Player proxy to Fawkes interface mapper interface. 00027 * This interface defines an interface to map a Player proxy to a Fawkes 00028 * interface. 00029 * @author Tim Niemueller 00030 * 00031 * @fn PlayerProxyFawkesInterfaceMapper::sync_fawkes_to_player() = 0 00032 * Sync Fawkes interface to Player proxy. 00033 * This method should be implemented to copy any outstanding data from the 00034 * Fawkes interface (messages) to the Player interface. This method will be 00035 * called in the ACT_EXEC hook of the BlockedTimingAspect (cf. MainLoop). 00036 * 00037 * @fn PlayerProxyFawkesInterfaceMapper::sync_player_to_fawkes() = 0 00038 * Sync Player proxy to Fawkes interface. 00039 * This method should be implemented to copy any outstanding data from the 00040 * Player proxy to the Fawkes interface. This method will be called in the 00041 * ACT_EXEC hook of the BlockedTimingAspect (cf. MainLoop). 00042 */ 00043 00044 /** Constructor. 00045 * @param varname variable name 00046 */ 00047 PlayerProxyFawkesInterfaceMapper::PlayerProxyFawkesInterfaceMapper(std::string varname) 00048 { 00049 __varname = varname; 00050 } 00051 00052 00053 /** Virtual empty destructor. */ 00054 PlayerProxyFawkesInterfaceMapper::~PlayerProxyFawkesInterfaceMapper() 00055 { 00056 } 00057 00058 00059 /** Get variable name 00060 * @return variable name 00061 */ 00062 std::string 00063 PlayerProxyFawkesInterfaceMapper::varname() const 00064 { 00065 return __varname; 00066 }