Fawkes API  Fawkes Development Version
PlayerProxyFawkesInterfaceMapper Class Referenceabstract

Player proxy to Fawkes interface mapper interface. More...

#include "mapper.h"

Inheritance diagram for PlayerProxyFawkesInterfaceMapper:

Public Member Functions

 PlayerProxyFawkesInterfaceMapper (std::string varname)
 Constructor. More...
 
virtual ~PlayerProxyFawkesInterfaceMapper ()
 Virtual empty destructor. More...
 
std::string varname () const
 Get variable name. More...
 
virtual void sync_fawkes_to_player ()=0
 Sync Fawkes interface to Player proxy. More...
 
virtual void sync_player_to_fawkes ()=0
 Sync Player proxy to Fawkes interface. More...
 

Detailed Description

Player proxy to Fawkes interface mapper interface.

This interface defines an interface to map a Player proxy to a Fawkes interface.

Author
Tim Niemueller

Definition at line 28 of file mapper.h.

Constructor & Destructor Documentation

◆ PlayerProxyFawkesInterfaceMapper()

PlayerProxyFawkesInterfaceMapper::PlayerProxyFawkesInterfaceMapper ( std::string  varname)

Constructor.

Parameters
varnamevariable name

Definition at line 47 of file mapper.cpp.

References varname().

◆ ~PlayerProxyFawkesInterfaceMapper()

PlayerProxyFawkesInterfaceMapper::~PlayerProxyFawkesInterfaceMapper ( )
virtual

Virtual empty destructor.

Definition at line 54 of file mapper.cpp.

Member Function Documentation

◆ sync_fawkes_to_player()

PlayerProxyFawkesInterfaceMapper::sync_fawkes_to_player ( )
pure 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).

Implemented in PlayerLaserMapper, PlayerMotorPositionMapper, and PlayerPositionMapper.

◆ sync_player_to_fawkes()

PlayerProxyFawkesInterfaceMapper::sync_player_to_fawkes ( )
pure 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).

Implemented in PlayerLaserMapper, PlayerMotorPositionMapper, and PlayerPositionMapper.

◆ varname()

std::string PlayerProxyFawkesInterfaceMapper::varname ( ) const

Get variable name.

Returns
variable name

Definition at line 63 of file mapper.cpp.

Referenced by PlayerProxyFawkesInterfaceMapper().


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