Sender interface, send data to CoreReceiver. More...

#include "core_sender.h"

Inheritance diagram for hh::core::CoreSender< Output >:

Collaboration diagram for hh::core::CoreSender< Output >:

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

	~CoreSender () override
	CoreSender destructor.

virtual void	addReceiver (CoreReceiver< Output > *receiver)=0
	Interface to add a CoreReceiver to this CoreSender. More...

virtual void	removeReceiver (CoreReceiver< Output > *receiver)=0
	Interface to remove a CoreReceiver from this CoreSender. More...

virtual void	sendAndNotify (std::shared_ptr< Output > data)=0
	Interface to send and notify a data to all connected CoreReceiver. More...

virtual std::set< CoreSender< Output > * >	getSenders ()=0
	Get inner CoreSender represented by this one in the case of outer graph for example. More...

void	duplicateEdge (CoreNode duplicateNode, std::map< CoreNode , std::shared_ptr< CoreNode >> &correspondenceMap) override
	Duplicate all the edges from this to it's copy duplicateNode. More...

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

	CoreNotifier (std::string_view const &name, NodeType const type, size_t const numberThreads)
	Notifier constructor. More...

	~CoreNotifier () override
	Notifier destructor.

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

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

virtual void	notifyAllTerminated ()=0
	Notify all slot that the node is terminated.

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 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...

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 Output>
class hh::core::CoreSender< Output >

Sender interface, send data to CoreReceiver.

Template Parameters

Output Data type sent to CoreReceiver

Definition at line 35 of file core_sender.h.

Constructor & Destructor Documentation

◆ CoreSender()

template<class Output>

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

inline

CoreSender constructor.

Parameters

name	Node name
type	Node type
numberThreads	Node number of threads

Definition at line 42 of file core_sender.h.

Member Function Documentation

◆ addReceiver()

template<class Output>

virtual void hh::core::CoreSender< Output >::addReceiver ( CoreReceiver< Output > * receiver )

pure virtual

Interface to add a CoreReceiver to this CoreSender.

Parameters

receiver CoreReceiver to add to this CoreSender

Implemented in hh::core::CoreGraph< GraphOutput, GraphInputs >, hh::core::CoreExecutionPipeline< GraphOutput, GraphInputs >, hh::core::CoreExecutionPipeline< GraphOutput, GraphInputs... >, hh::core::CoreQueueSender< NodeOutput >, hh::core::CoreQueueSender< GraphOutput >, hh::core::CoreQueueSender< GraphInputs >, and hh::core::CoreQueueSender< TaskOutput >.

Here is the caller graph for this function:

◆ duplicateEdge()

template<class Output>

void hh::core::CoreSender< Output >::duplicateEdge	(	CoreNode *	duplicateNode,
		std::map< CoreNode *, std::shared_ptr< CoreNode >> &	correspondenceMap
	)

inlineoverridevirtual

Duplicate all the edges from this to it's copy duplicateNode.

Parameters

duplicateNode	Node to connect
correspondenceMap	Correspondence map from base node to copy

Implements hh::core::CoreNode.

Reimplemented in hh::core::CoreQueueSender< GraphOutput >, hh::core::CoreQueueSender< GraphInputs >, and hh::core::CoreQueueSender< TaskOutput >.

Definition at line 69 of file core_sender.h.

◆ getSenders()

template<class Output>

virtual std::set<CoreSender<Output> *> hh::core::CoreSender< Output >::getSenders ( )

pure virtual

Get inner CoreSender represented by this one in the case of outer graph for example.

Returns: Inner CoreSender represented by this one

Implemented in hh::core::CoreGraph< GraphOutput, GraphInputs >, hh::core::CoreExecutionPipeline< GraphOutput, GraphInputs >, hh::core::CoreExecutionPipeline< GraphOutput, GraphInputs... >, hh::core::CoreQueueSender< NodeOutput >, hh::core::CoreQueueSender< GraphOutput >, hh::core::CoreQueueSender< GraphInputs >, and hh::core::CoreQueueSender< TaskOutput >.

Here is the caller graph for this function:

◆ removeReceiver()

template<class Output>

virtual void hh::core::CoreSender< Output >::removeReceiver ( CoreReceiver< Output > * receiver )

pure virtual

Interface to remove a CoreReceiver from this CoreSender.

Parameters

receiver Receiver to CoreReceiver from this CoreSender

Implemented in hh::core::CoreGraph< GraphOutput, GraphInputs >, hh::core::CoreQueueSender< NodeOutput >, hh::core::CoreQueueSender< GraphOutput >, hh::core::CoreQueueSender< GraphInputs >, and hh::core::CoreQueueSender< TaskOutput >.

Here is the caller graph for this function:

◆ sendAndNotify()

template<class Output>

virtual void hh::core::CoreSender< Output >::sendAndNotify ( std::shared_ptr< Output > data )

pure virtual

Interface to send and notify a data to all connected CoreReceiver.

Parameters

data	data to send

Implemented in hh::core::CoreQueueSender< NodeOutput >, hh::core::CoreQueueSender< GraphOutput >, hh::core::CoreQueueSender< GraphInputs >, and hh::core::CoreQueueSender< TaskOutput >.

Here is the caller graph for this function:

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

/home/tjb3/work/hedgehog-nist/hedgehog/core/io/base/sender/core_sender.h

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Output> class hh::core::CoreSender< Output >

Constructor & Destructor Documentation

◆ CoreSender()

Member Function Documentation

◆ addReceiver()

◆ duplicateEdge()

◆ getSenders()

◆ removeReceiver()

◆ sendAndNotify()

template<class Output>
class hh::core::CoreSender< Output >