Implementation of the execute method for the StateManager. More...

#include "state_manager.h"

Inheritance diagram for hh::behavior::StateManagerExecuteDefinition< StateInput, StateOutput, StateInputs >:

Collaboration diagram for hh::behavior::StateManagerExecuteDefinition< StateInput, StateOutput, StateInputs >:

Public Member Functions
	StateManagerExecuteDefinition ()=delete
	Deleted default constructor.

	StateManagerExecuteDefinition (std::shared_ptr< AbstractState< StateOutput, StateInputs... >> const &state)
	Constructor for an AbstractStateManager with name, state, and automaticStart as mandatory parameters. More...

virtual	~StateManagerExecuteDefinition ()=default
	Default StateManagerExecute destructor.

void	execute (std::shared_ptr< StateInput > input) final
	Default execute method definition. More...

Public Member Functions inherited from hh::behavior::BaseStateManager< StateOutput, StateInputs... >
	BaseStateManager ()
	DEfault constructor, set the base property for a state manager.

Public Member Functions inherited from hh::AbstractTask< StateOutput, StateInputs... >
	AbstractTask ()
	AbstractTask default constructor. More...

	AbstractTask (std::string_view const &name)
	Create a task with a custom name. More...

	AbstractTask (std::string_view const &name, size_t numberThreads)
	Create a task with a custom name and the task's cluster size. More...

	AbstractTask (std::string_view const &name, size_t numberThreads, bool automaticStart)
	Create a task with a custom name, the task's cluster size, and the automatic start. More...

	AbstractTask (std::string_view const name, size_t numberThreads, core::NodeType nodeType, bool automaticStart)
	Internal constructor needed to create nodes that derive from AbstractTask. More...

	AbstractTask (AbstractTask< StateOutput, TaskInputs ... > *rhs)
	Copy constructor. More...

virtual	~AbstractTask ()=default
	Default destructor.

void	addResult (std::shared_ptr< StateOutput > output)
	Add an output data. More...

std::string_view	name ()
	Task's name accessor. More...

size_t	numberThreads ()
	Task's number of threads accessor. More...

bool	automaticStart ()
	Task's automatic start accessor. More...

core::NodeType	nodeType ()
	Task's node type accessor. More...

int	deviceId ()
	Task's device ID accessor. More...

int	graphId ()
	Task's graph ID accessor. More...

std::shared_ptr< core::CoreNode >	core () final
	Task's core accessor. More...

std::shared_ptr< AbstractMemoryManager< StateOutput > > const &	memoryManager () const
	Task's memory manager accessor. More...

virtual std::shared_ptr< AbstractTask< StateOutput, TaskInputs... > >	copy ()
	Default copy overload, fail if cluster need to be copied. More...

virtual void	initialize ()
	Initialize method called before AbstractTask::Execute loop.

virtual void	shutdown ()
	Shutdown method called after AbstractTask::Execute loop, when AbstractTask::canTerminate evaluates to true.

void	connectMemoryManager (std::shared_ptr< AbstractMemoryManager< StateOutput >> mm)
	Connect a memory manager to the task. More...

std::shared_ptr< StateOutput >	getManagedMemory ()
	Memory manager accessor. More...

bool	canTerminate () override
	Method called to test the task;s termination, by default, the test is: no input nodes connected and, no data waiting to be treated. More...

Public Member Functions inherited from hh::behavior::Node
virtual std::string	extraPrintingInformation () const
	Adds node information to print in the dot file. More...

Public Member Functions inherited from hh::behavior::Execute< TaskInputs >
virtual void	execute (std::shared_ptr< TaskInputs >)=0
	Virtual declaration of execute function for a data of type Input.

Private Attributes
std::shared_ptr< AbstractState< StateOutput, StateInputs... > >	es_
	State used in execute definition.

Additional Inherited Members
Public Types inherited from hh::behavior::MultiReceivers< TaskInputs... >
using	inputs_t = std::tuple< Inputs... >
	Tuple with the list of input types.

Public Types inherited from hh::behavior::Sender< StateOutput >
using	output_t = StateOutput
	Output Type.

Detailed Description

template<class StateInput, class StateOutput, class ... StateInputs>
class hh::behavior::StateManagerExecuteDefinition< StateInput, StateOutput, StateInputs >

Implementation of the execute method for the StateManager.

The default order of execution is:

The StateManager will acquire data,
The StateManager will lock the AbstractState (with AbstractState::stateMutex_),
The StateManager will send the data to the possessed AbstractState,
The compatible Execute::execute is called with the data,
During the call of Execute::execute, if the method AbstractState::push is invoked the "result data" is stored in a ready list AbstractState::readyList_,
When the Execute::execute has returned, the waiting list is emptied as output of the AbstractStateManager,
The StateManager will unlock the AbstractState (with AbstractState::stateMutex_).
Attention
Should not be used directly, use StateManager instead.

Template Parameters

StateInput State input type for definition of Execute::execute

StateOutput State output type

StateInputs State input types

Definition at line 66 of file state_manager.h.

Constructor & Destructor Documentation

◆ StateManagerExecuteDefinition()

template<class StateInput, class StateOutput, class ... StateInputs>

hh::behavior::StateManagerExecuteDefinition< StateInput, StateOutput, StateInputs >::StateManagerExecuteDefinition ( std::shared_ptr< AbstractState< StateOutput, StateInputs... >> const & state )

inlineexplicit

Constructor for an AbstractStateManager with name, state, and automaticStart as mandatory parameters.

Parameters

state State to manage

Definition at line 74 of file state_manager.h.

Member Function Documentation

◆ execute()

template<class StateInput, class StateOutput, class ... StateInputs>

void hh::behavior::StateManagerExecuteDefinition< StateInput, StateOutput, StateInputs >::execute ( std::shared_ptr< StateInput > input )

inlinefinal

Default execute method definition.

Parameters

input Data of type StateInput to be send to the managed state

Definition at line 82 of file state_manager.h.

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

/home/tjb3/work/hedgehog-nist/hedgehog/api/state_manager/state_manager.h

StateInput	State input type for definition of Execute::execute
StateOutput	State output type
StateInputs	State input types

Public Member Functions

Private Attributes