Fawkes API  Fawkes Development Version
mapper.cpp
1 
2 /***************************************************************************
3  * mapper.cpp - Player proxy to Fawkes interface mapper
4  *
5  * Created: Tue Sep 30 00:50:29 2008
6  * Copyright 2006-2008 Tim Niemueller [www.niemueller.de]
7  *
8  ****************************************************************************/
9 
10 /* This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Library General Public License for more details.
19  *
20  * Read the full text in the LICENSE.GPL file in the doc directory.
21  */
22 
23 #include "mapper.h"
24 
25 /** @class PlayerProxyFawkesInterfaceMapper "mapper.h"
26  * Player proxy to Fawkes interface mapper interface.
27  * This interface defines an interface to map a Player proxy to a Fawkes
28  * interface.
29  * @author Tim Niemueller
30  *
31  * @fn PlayerProxyFawkesInterfaceMapper::sync_fawkes_to_player() = 0
32  * Sync Fawkes interface to Player proxy.
33  * This method should be implemented to copy any outstanding data from the
34  * Fawkes interface (messages) to the Player interface. This method will be
35  * called in the ACT_EXEC hook of the BlockedTimingAspect (cf. MainLoop).
36  *
37  * @fn PlayerProxyFawkesInterfaceMapper::sync_player_to_fawkes() = 0
38  * Sync Player proxy to Fawkes interface.
39  * This method should be implemented to copy any outstanding data from the
40  * Player proxy to the Fawkes interface. This method will be called in the
41  * ACT_EXEC hook of the BlockedTimingAspect (cf. MainLoop).
42  */
43 
44 /** Constructor.
45  * @param varname variable name
46  */
48 {
49  __varname = varname;
50 }
51 
52 
53 /** Virtual empty destructor. */
55 {
56 }
57 
58 
59 /** Get variable name
60  * @return variable name
61  */
62 std::string
64 {
65  return __varname;
66 }
std::string varname() const
Get variable name.
Definition: mapper.cpp:63
PlayerProxyFawkesInterfaceMapper(std::string varname)
Constructor.
Definition: mapper.cpp:47
virtual ~PlayerProxyFawkesInterfaceMapper()
Virtual empty destructor.
Definition: mapper.cpp:54