Multi receiver interface, gather multiple CoreReceiver. More...

#include "core_multi_receivers.h"

Inheritance diagram for hh::core::CoreMultiReceivers< Inputs >:

Collaboration diagram for hh::core::CoreMultiReceivers< Inputs >:

Public Member Functions
	CoreMultiReceivers (std::string_view const &name, NodeType const type, size_t const numberThreads)
	CoreMultiReceivers constructor. More...

	~CoreMultiReceivers () override
	CoreMultiReceivers destructor.

virtual bool	receiversEmpty ()=0
	Test if all receivers are empty. More...

virtual size_t	totalQueueSize ()
	Compute all receivers queue size. More...

void	removeForAllSenders (CoreNode *coreNode)
	Remove all coreNode's senders from this. More...

Public Member Functions inherited from hh::core::CoreSlot
	CoreSlot (std::string_view const &name, NodeType const type, size_t const numberThreads)
	Core slot constructor. More...

	~CoreSlot () override
	Core Slot destructor.

virtual void	addNotifier (CoreNotifier *notifier)=0
	Interface to add a CoreNotifier to this slot. More...

virtual void	removeNotifier (CoreNotifier *notifier)=0
	Interface to remove a CoreNotifier from this slot. More...

virtual bool	hasNotifierConnected ()=0
	Test if notifiers are connected to this slot. More...

virtual size_t	numberInputNodes () const =0
	Return the number of notifiers connected to this slot. More...

virtual void	wakeUp ()=0
	Interface to define what the node do when it receive a signal.

virtual bool	waitForNotification ()=0
	Interface to define how the node wait for a signal, and return if the node is terminated. More...

Public Member Functions inherited from hh::core::CoreNode
	CoreNode ()=delete
	Deleted default constructor.

	CoreNode (std::string_view const &name, NodeType const type, size_t numberThreads)
	Core node only constructor. More...

virtual	~CoreNode ()
	Default virtual destructor.

virtual std::shared_ptr< CoreNode >	clone ()=0
	Virtual constructor for copy. More...

virtual std::string	id () const
	Unique Id accessor. More...

virtual std::vector< std::pair< std::string, std::string > >	ids () const
	Input node ids [nodeId, nodeIdCluster] accessor. More...

std::string_view const &	name () const
	Node name accessor. More...

NodeType	type () const
	Node type accessor. More...

bool	isInside () const
	Node inside property accessor. More...

bool	hasBeenRegistered () const
	Node registration property accessor. More...

CoreNode *	coreClusterNode () const
	Main cluster core node link to this node accessor. More...

int	threadId () const
	Thread id accessor. More...

size_t	numberThreads () const
	Number of threads associated accessor. More...

CoreNode *	belongingNode () const
	Belonging node accessor. More...

std::shared_ptr< std::multimap< CoreNode *, std::shared_ptr< CoreNode > > > const &	insideNodes () const
	Inside node accessor. More...

std::shared_ptr< std::multimap< CoreNode *, std::shared_ptr< CoreNode > > > &	insideNodes ()
	Inside nodes accessor. More...

std::chrono::duration< uint64_t, std::micro > const &	executionTime () const
	Execution time accessor. More...

std::chrono::duration< uint64_t, std::micro > const &	waitTime () const
	Wait time accessor. More...

std::chrono::duration< uint64_t, std::micro > const &	memoryWaitTime () const
	Memory wait time accessor. More...

bool	isInCluster () const
	In cluster property accessor. More...

bool	isActive () const
	Is active property accessor. More...

bool	isCudaRelated () const
	Is related to CUDA, used to have a green background on the dot file. More...

virtual int	graphId ()
	Graph id accessor. More...

virtual int	deviceId ()
	Device id accessor. More...

virtual std::chrono::duration< uint64_t, std::micro >	maxExecutionTime () const
	Maximum execution time accessor. More...

virtual std::chrono::duration< uint64_t, std::micro >	minExecutionTime () const
	Minimum execution time accessor. More...

virtual std::chrono::duration< uint64_t, std::micro >	maxWaitTime () const
	Maximum waiting time accessor. More...

virtual std::chrono::duration< uint64_t, std::micro >	minWaitTime () const
	Minimum waiting time accessor. More...

std::chrono::time_point< std::chrono::high_resolution_clock > const &	creationTimeStamp () const
	Creation timestamp accessor. More...

std::chrono::time_point< std::chrono::high_resolution_clock > const &	startExecutionTimeStamp () const
	Execution start timestamp accessor. More...

std::chrono::duration< uint64_t, std::micro > const &	creationDuration () const
	Creation duration accessor. More...

std::chrono::duration< uint64_t, std::micro > const &	executionDuration () const
	Execution duration accessor. More...

std::chrono::duration< uint64_t, std::micro >	meanExecTimeCluster () const
	Compute and return the mean execution time for all tasks in the node cluster. More...

std::chrono::duration< uint64_t, std::micro >	meanWaitTimeCluster () const
	Compute and return the mean wait time for all tasks in the node cluster. More...

std::chrono::duration< uint64_t, std::micro >	meanMemoryWaitTimeCluster () const
	Compute and return the mean memory wait time for all tasks in the node cluster. More...

uint64_t	stdvExecTimeCluster () const
	Compute and return the standard deviation execution time for all tasks in the node cluster. More...

uint64_t	stdvWaitTimeCluster () const
	Compute and return the standard deviation wait time for all tasks in the node cluster. More...

uint64_t	stdvMemoryWaitTimeCluster () const
	Compute and return the standard deviation memory wait time for all tasks in the node cluster. More...

std::pair< uint64_t, uint64_t >	minmaxWaitTimeCluster () const
	Compute and return the min and max wait time for all tasks in the node cluster. More...

std::pair< uint64_t, uint64_t >	minmaxMemoryWaitTimeCluster () const
	Compute and return the min and max memory wait time for all tasks in the node cluster. More...

std::pair< uint64_t, uint64_t >	minmaxExecTimeCluster () const
	Compute and return the min and max execution time for all tasks in the node cluster. More...

size_t	numberActiveThreadInCluster () const
	Compute and return the number of active nodes in a cluster. More...

virtual std::string	extraPrintingInformation ()
	Extra printing information accessor. More...

void	startExecutionTimeStamp (std::chrono::time_point< std::chrono::high_resolution_clock > const &startExecutionTimeStamp)
	Execution timestamp setter. More...

virtual void	deviceId (int deviceId)
	Device id setter. More...

virtual void	setInside ()
	Set the node as inside, (inside a graph)

void	setInCluster ()
	Set the task as part of a cluster.

void	threadId (uint8_t threadId)
	Set the thread id. More...

void	coreClusterNode (CoreNode *coreClusterNode)
	Set the main cluster node to associate to this node. More...

void	name (std::string_view const &name)
	Name node setter. More...

void	numberThreads (size_t numberThreads)
	Number of threads setter. More...

void	belongingNode (CoreNode *belongingNode)
	Belonging node setter. More...

void	hasBeenRegistered (bool hasBeenRegistered)
	Has been registered property setter. More...

void	isActive (bool isActive)
	Is active property setter. More...

void	isCudaRelated (bool isCudaRelated)
	Is CUDA related property setter. More...

void	isInside (bool isInside)
	Set the node as being inside another one. More...

void	creationDuration (std::chrono::duration< uint64_t, std::micro > const &creationDuration)
	Creation duration setter. More...

void	executionDuration (std::chrono::duration< uint64_t, std::micro > const &executionDuration)
	Execution duration setter. More...

void	incrementWaitForMemoryDuration (std::chrono::duration< uint64_t, std::micro > const &memoryWait)
	Add wait for memory duration to total duration. More...

virtual void	preRun ()
	Method defining what to do before the run.

virtual void	run ()
	Run method, main execution.

virtual void	postRun ()
	Method defining what to do after the run.

virtual void	createCluster (std::shared_ptr< std::multimap< CoreNode *, std::shared_ptr< CoreNode >>> &)
	Define how to create a cluster for the node, by default do nothing.

virtual void	joinThreads ()
	Define what is done when the thread is joined.

virtual void	duplicateEdge (CoreNode duplicateNode, std::map< CoreNode , std::shared_ptr< CoreNode >> &correspondenceMap)=0
	Duplicate all of the edges from this to its copy duplicateNode. More...

virtual behavior::Node *	node ()=0
	User's node accessor. More...

virtual void	visit (AbstractPrinter *printer)=0
	Abstract visit method for printing mechanism. More...

virtual std::set< CoreSlot * >	getSlots ()=0
	Slots accessor for the node. More...

void	removeInsideNode (CoreNode *coreNode)
	Remove a node from the registered inside nodes. More...

void	copyInnerStructure (CoreNode *rhs)
	Copy inner structure from rhs nodes to this. More...

Public Member Functions inherited from hh::core::CoreReceiver< Inputs >
	CoreReceiver (std::string_view const &name, NodeType const type, size_t const numberThreads)
	Constructor with node name, node type and number of threads for the node. More...

	~CoreReceiver () override
	Default destructor.

virtual void	addSender (CoreSender< Inputs > *sender)=0
	Interface to add a CoreSender to the receiver. More...

virtual void	removeSender (CoreSender< Inputs > *sender)=0
	Interface to remove a CoreSender from the receiver. More...

virtual void	receive (std::shared_ptr< Inputs > data)=0
	Interface to receive a data. More...

virtual bool	receiverEmpty ()=0
	Accessor to test emptiness on the receiver. More...

virtual size_t	queueSize ()
	Interface to get the number of element to be treated by this node for this type, by default return 0. More...

virtual std::set< CoreReceiver< Inputs > *>	receivers ()=0
	Accessor to all receivers connected to this receiver. More...

Private Member Functions
template<class Input >
void	removeForAllSendersConditional (CoreNode *coreNode)
	Remove all coreNode's senders from this for a specific Input type. More...

Additional Inherited Members
Protected Member Functions inherited from hh::core::CoreNode
void	addUniqueInsideNode (const std::shared_ptr< CoreNode > &coreNode)
	Add a node to the inside nodes. More...

void	incrementWaitDuration (std::chrono::duration< uint64_t, std::micro > const &wait)
	Increment wait duration. More...

void	incrementExecutionDuration (std::chrono::duration< uint64_t, std::micro > const &exec)
	Increment execution duration. More...

Detailed Description

template<class ... Inputs>
class hh::core::CoreMultiReceivers< Inputs >

Multi receiver interface, gather multiple CoreReceiver.

Template Parameters

Inputs Multi receiver's inputs type

Definition at line 40 of file core_multi_receivers.h.

Constructor & Destructor Documentation

◆ CoreMultiReceivers()

template<class ... Inputs>

hh::core::CoreMultiReceivers< Inputs >::CoreMultiReceivers	(	std::string_view const &	name,
		NodeType const	type,
		size_t const	numberThreads
	)

inline

CoreMultiReceivers constructor.

Parameters

name	Node's name
type	Node's type
numberThreads	Node's number of thread

Definition at line 46 of file core_multi_receivers.h.

Member Function Documentation

◆ receiversEmpty()

template<class ... Inputs>

virtual bool hh::core::CoreMultiReceivers< Inputs >::receiversEmpty ( )

pure virtual

Test if all receivers are empty.

Returns: True of all receivers are empty, else false

Implemented in hh::core::CoreQueueMultiReceivers< NodeInputs >, hh::core::CoreQueueMultiReceivers< GraphOutput >, hh::core::CoreQueueMultiReceivers< TaskInputs... >, hh::core::CoreGraphMultiReceivers< GraphInputs >, and hh::core::CoreGraphMultiReceivers< GraphInputs... >.

Here is the caller graph for this function:

◆ removeForAllSenders()

template<class ... Inputs>

void hh::core::CoreMultiReceivers< Inputs >::removeForAllSenders ( CoreNode * coreNode )

inline

Remove all coreNode's senders from this.

Parameters

coreNode CoreNode representing the senders that will be removed from this

Definition at line 64 of file core_multi_receivers.h.

◆ removeForAllSendersConditional()

template<class ... Inputs>

template<class Input >

void hh::core::CoreMultiReceivers< Inputs >::removeForAllSendersConditional ( CoreNode * coreNode )

inlineprivate

Remove all coreNode's senders from this for a specific Input type.

Template Parameters

Input Sender Input's type

Parameters

coreNode CoreNode representing the senders that will be removed from this

Definition at line 73 of file core_multi_receivers.h.

◆ totalQueueSize()

template<class ... Inputs>

virtual size_t hh::core::CoreMultiReceivers< Inputs >::totalQueueSize ( )

inlinevirtual

Compute all receivers queue size.

Returns: All receivers queue size

Reimplemented in hh::core::CoreQueueMultiReceivers< NodeInputs >, hh::core::CoreQueueMultiReceivers< GraphOutput >, and hh::core::CoreQueueMultiReceivers< TaskInputs... >.

Definition at line 60 of file core_multi_receivers.h.

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

/home/tjb3/work/hedgehog-nist/hedgehog/core/io/base/receiver/core_multi_receivers.h

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

template<class ... Inputs> class hh::core::CoreMultiReceivers< Inputs >

Constructor & Destructor Documentation

◆ CoreMultiReceivers()

Member Function Documentation

◆ receiversEmpty()

◆ removeForAllSenders()

◆ removeForAllSendersConditional()

◆ totalQueueSize()

template<class ... Inputs>
class hh::core::CoreMultiReceivers< Inputs >