tap::control::SequentialCommand< COMMANDS > Class Template Reference

#include <sequential_command.hpp>

Inheritance diagram for tap::control::SequentialCommand< COMMANDS >:

Collaboration diagram for tap::control::SequentialCommand< COMMANDS >:

Public Member Functions
	SequentialCommand (std::array< Command *, COMMANDS > commands)
const char *	getName () const override
bool	isReady () override
void	initialize () override
void	execute () override
void	end (bool interrupted) override
bool	isFinished () const override
Public Member Functions inherited from tap::control::Command
	Command ()
virtual	~Command ()
mockable subsystem_scheduler_bitmap_t	getRequirementsBitwise () const
int	getGlobalIdentifier () const
mockable void	addSubsystemRequirement (Subsystem *requirement)

Additional Inherited Members
Protected Attributes inherited from tap::control::Command
command_scheduler_bitmap_t	commandRequirementsBitwise = 0

Detailed Description

template<size_t COMMANDS>
class tap::control::SequentialCommand< COMMANDS >

A generic extendable class for implementing a command. Each command is attached to a subsystem. To create a new command, extend the Command class and instantiate the virtual functions in this class. See example_command.hpp for example of this.

Constructor & Destructor Documentation

SequentialCommand()

template<size_t COMMANDS>

tap::control::SequentialCommand< COMMANDS >::SequentialCommand ( std::array< Command *, COMMANDS >  commands )

inline

Member Function Documentation

end()

template<size_t COMMANDS>

void tap::control::SequentialCommand< COMMANDS >::end ( bool  interrupted )

inlineoverridevirtual

The action to take when the command ends. Called when either the command finishes normally, or when it interrupted/canceled.

Parameters

[in]

interrupted

whether the command was interrupted/canceled.

Implements tap::control::Command.

execute()

template<size_t COMMANDS>

void tap::control::SequentialCommand< COMMANDS >::execute ( )

inlineoverridevirtual

The main body of a command. Called repeatedly while the command is scheduled by a CommandScheduler.

Implements tap::control::Command.

getName()

template<size_t COMMANDS>

const char * tap::control::SequentialCommand< COMMANDS >::getName ( ) const

inlineoverridevirtual

Returns

the name of the command, to be implemented by derived classes.

Implements tap::control::Command.

initialize()

template<size_t COMMANDS>

void tap::control::SequentialCommand< COMMANDS >::initialize ( )

inlineoverridevirtual

The initial subroutine of a command. Called once when the command is initially scheduled by a CommandScheduler.

Note that command instances are re-used: a single command could be initialized, run, finished, then later initialized again. Ensure that initialize() resets any state stored in the command!

Implements tap::control::Command.

isFinished()

template<size_t COMMANDS>

bool tap::control::SequentialCommand< COMMANDS >::isFinished ( ) const

inlineoverridevirtual

Whether the command has finished. Once a Command finishes, the scheduler will call the end() function and un-schedule it. If a Command is naturally finished (i.e. isFinished() == true), then the CommandScheduler will pass in false to end(). If, for example, another Command is added that in turn stops the Command from executing, then the CommandScheduler will pass in true to end().

Returns

whether the command has finished.

Implements tap::control::Command.

isReady()

template<size_t COMMANDS>

bool tap::control::SequentialCommand< COMMANDS >::isReady ( )

inlineoverridevirtual

A check called right before a command is scheduled to determine whether or not a command should be scheduled. If return is true then the command is scheduled, if false then the command is not scheduled.

Not forced to be overridden, returns true by default.

Reimplemented from tap::control::Command.

---

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

• fang-mcb-project/taproot/src/tap/control/sequential_command.hpp