Receiver Interface, receive one data type from CoreSender. More...

#include "core_receiver.h"

Inheritance diagram for hh::core::CoreReceiver< Input >:

Collaboration diagram for hh::core::CoreReceiver< Input >:

Public Member Functions
	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< Input > *sender)=0
	Interface to add a CoreSender to the receiver. More...

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

virtual void	receive (std::shared_ptr< Input > 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< Input > * >	receivers ()=0
	Accessor to all receivers connected to this receiver. 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...

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 Input>
class hh::core::CoreReceiver< Input >

Receiver Interface, receive one data type from CoreSender.

Template Parameters

Input Type of data received by the CoreReceiver

Definition at line 44 of file core_receiver.h.

Constructor & Destructor Documentation

◆ CoreReceiver()

template<class Input>

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

inline

Constructor with node name, node type and number of threads for the node.

Parameters

name	Node name
type	Node type
numberThreads	Cluster number of threads

Definition at line 50 of file core_receiver.h.

Member Function Documentation

◆ addSender()

template<class Input>

virtual void hh::core::CoreReceiver< Input >::addSender ( CoreSender< Input > * sender )

pure virtual

Interface to add a CoreSender to the receiver.

Parameters

sender CoreSender to add to this receiver

Implemented in hh::core::CoreQueueReceiver< NodeInput >, hh::core::CoreQueueReceiver< NodeInputs >, hh::core::CoreGraphReceiver< GraphInput >, and hh::core::CoreGraphReceiver< GraphInputs >.

Here is the caller graph for this function:

◆ queueSize()

template<class Input>

virtual size_t hh::core::CoreReceiver< Input >::queueSize ( )

inlinevirtual

Interface to get the number of element to be treated by this node for this type, by default return 0.

Returns: Get the number of element to be treated by this node for this type

Reimplemented in hh::core::CoreQueueReceiver< NodeInput >, and hh::core::CoreQueueReceiver< NodeInputs >.

Definition at line 76 of file core_receiver.h.

◆ receive()

template<class Input>

virtual void hh::core::CoreReceiver< Input >::receive ( std::shared_ptr< Input > data )

pure virtual

Interface to receive a data.

Parameters

data	Data received by this receiver

Implemented in hh::core::CoreQueueReceiver< NodeInput >, hh::core::CoreQueueReceiver< NodeInputs >, hh::core::CoreGraphReceiver< GraphInput >, and hh::core::CoreGraphReceiver< GraphInputs >.

Here is the caller graph for this function:

◆ receiverEmpty()

template<class Input>

virtual bool hh::core::CoreReceiver< Input >::receiverEmpty ( )

pure virtual

Accessor to test emptiness on the receiver.

Returns: True if the receiver has no data, Else false

Implemented in hh::core::CoreQueueReceiver< NodeInput >, hh::core::CoreQueueReceiver< NodeInputs >, hh::core::CoreGraphReceiver< GraphInput >, and hh::core::CoreGraphReceiver< GraphInputs >.

Here is the caller graph for this function:

◆ receivers()

template<class Input>

virtual std::set<CoreReceiver<Input> *> hh::core::CoreReceiver< Input >::receivers ( )

pure virtual

Accessor to all receivers connected to this receiver.

Returns: All receivers connected to this receiver

Implemented in hh::core::CoreQueueReceiver< NodeInput >, hh::core::CoreQueueReceiver< NodeInputs >, hh::core::CoreGraphReceiver< GraphInput >, and hh::core::CoreGraphReceiver< GraphInputs >.

Here is the caller graph for this function:

◆ removeSender()

template<class Input>

virtual void hh::core::CoreReceiver< Input >::removeSender ( CoreSender< Input > * sender )

pure virtual

Interface to remove a CoreSender from the receiver.

Parameters

sender CoreSender to remove from this receiver

Implemented in hh::core::CoreQueueReceiver< NodeInput >, hh::core::CoreQueueReceiver< NodeInputs >, hh::core::CoreGraphReceiver< GraphInput >, and hh::core::CoreGraphReceiver< GraphInputs >.

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/receiver/core_receiver.h

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Input> class hh::core::CoreReceiver< Input >

Constructor & Destructor Documentation

◆ CoreReceiver()

Member Function Documentation

◆ addSender()

◆ queueSize()

◆ receive()

◆ receiverEmpty()

◆ receivers()

◆ removeSender()

template<class Input>
class hh::core::CoreReceiver< Input >