Fawkes API  Fawkes Development Version
PlayerPositionMapper Class Reference

Position mapper for player integration. More...

#include "position_mapper.h"

Inheritance diagram for PlayerPositionMapper:

Public Member Functions

 PlayerPositionMapper (std::string varname, fawkes::ObjectPositionInterface *interface, PlayerCc::Position2dProxy *proxy)
 Constructor. More...
 
virtual void sync_fawkes_to_player ()
 Sync Fawkes interface to Player proxy. More...
 
virtual void sync_player_to_fawkes ()
 Sync Player proxy to Fawkes interface. More...
 
- Public Member Functions inherited from PlayerProxyFawkesInterfaceMapper
 PlayerProxyFawkesInterfaceMapper (std::string varname)
 Constructor. More...
 
virtual ~PlayerProxyFawkesInterfaceMapper ()
 Virtual empty destructor. More...
 
std::string varname () const
 Get variable name. More...
 

Detailed Description

Position mapper for player integration.

This class is used to map a Player position2d proxy to a Fawkes ObjectPositionInterface.

Author
Tim Niemueller

Definition at line 36 of file position_mapper.h.

Constructor & Destructor Documentation

◆ PlayerPositionMapper()

PlayerPositionMapper::PlayerPositionMapper ( std::string  varname,
fawkes::ObjectPositionInterface interface,
PlayerCc::Position2dProxy *  proxy 
)

Constructor.

Parameters
varnamevariable name
interfaceFawkes interface instance
proxyPlayer proxy instance

Definition at line 40 of file position_mapper.cpp.

Member Function Documentation

◆ sync_fawkes_to_player()

void PlayerPositionMapper::sync_fawkes_to_player ( )
virtual

Sync Fawkes interface to Player proxy.

This method should be implemented to copy any outstanding data from the Fawkes interface (messages) to the Player interface. This method will be called in the ACT_EXEC hook of the BlockedTimingAspect (cf. MainLoop).

Implements PlayerProxyFawkesInterfaceMapper.

Definition at line 65 of file position_mapper.cpp.

◆ sync_player_to_fawkes()

void PlayerPositionMapper::sync_player_to_fawkes ( )
virtual

Sync Player proxy to Fawkes interface.

This method should be implemented to copy any outstanding data from the Player proxy to the Fawkes interface. This method will be called in the ACT_EXEC hook of the BlockedTimingAspect (cf. MainLoop).

Implements PlayerProxyFawkesInterfaceMapper.

Definition at line 51 of file position_mapper.cpp.

References fawkes::ObjectPositionInterface::set_relative_x(), fawkes::ObjectPositionInterface::set_relative_y(), fawkes::ObjectPositionInterface::set_relative_z(), and fawkes::Interface::write().


The documentation for this class was generated from the following files: