#include <hold_command_mapping.hpp>

Inheritance diagram for tap::control::HoldCommandMapping:

Collaboration diagram for tap::control::HoldCommandMapping:

[legend]

Public Member Functions
	HoldCommandMapping (Drivers drivers, const std::vector< Command > cmds, const RemoteMapState &rms)

	~HoldCommandMapping () override=default

void	executeCommandMapping (const RemoteMapState &currState) override

Public Member Functions inherited from tap::control::CommandMapping
	CommandMapping (Drivers drivers, const std::vector< Command > cmds, const RemoteMapState &rms)

virtual	~CommandMapping ()=default

virtual bool	mappingSubset (const RemoteMapState &mapState)

const RemoteMapState &	getAssociatedRemoteMapState () const

const std::vector< Command * > &	getAssociatedCommands () const

Additional Inherited Members
Static Public Member Functions inherited from tap::control::CommandMapping
static bool	negKeysSubset (const RemoteMapState &state1, const RemoteMapState &state2)

Protected Member Functions inherited from tap::control::CommandMapping
void	addCommands ()

void	removeCommands ()

bool	noCommandsScheduled () const

Protected Attributes inherited from tap::control::CommandMapping
const RemoteMapState	mapState

std::vector< Command * >	mappedCommands

Drivers *	drivers

Detailed Description

A CommandMapping that adds Commands when the contained mapping is a subset of the remote mapping and removes the Commands when the mapping is no longer a subset.

Additionally, When neg keys are being used and the mapping's neg keys are a subset of the remote map state, the Commands are removed.

Constructor & Destructor Documentation

◆ HoldCommandMapping()

tap::control::HoldCommandMapping::HoldCommandMapping	(	Drivers *	drivers,
		const std::vector< Command * >	cmds,
		const RemoteMapState &	rms
	)

inline

Constructor must take the set of Commands and the RemoteMapState.

◆ ~HoldCommandMapping()

tap::control::HoldCommandMapping::~HoldCommandMapping ( )

overridedefault

Default destructor.

Member Function Documentation

◆ executeCommandMapping()

void tap::control::HoldCommandMapping::executeCommandMapping ( const RemoteMapState & currState )

overridevirtual

Using currState, determines whether or not to add or remove Commands from the main scheduler. Up the the implementer to determine what the criteria for adding and removing Commands should be.

Parameters

[in] currState The current state of the remote.

Implements tap::control::CommandMapping.

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

fang-mcb-project/taproot/src/tap/control/hold_command_mapping.hpp
fang-mcb-project/taproot/src/tap/control/hold_command_mapping.cpp