csp::common::Id< DATA_TYPE > Class Template Reference

Inheritance diagram for csp::common::Id< DATA_TYPE >:

List of all members.

---

Detailed Description

template<typename DATA_TYPE>
class csp::common::Id< DATA_TYPE >

A process that forever forwards an item of data to another channel.

This process forever reads a value from its input channel, then writes it on its output channel.

It can be used for various purposes, including connecting two channels together. Be aware that two channels connected by an Id process is not semantically equivalent to a single channel, because the Id process inherently introduces buffering (the writer of the first channel can complete the communication without the reader of the second channel having done anything, because of the Id process in the middle). To avoid this behaviour, look at the ExtId process.

To use this process, you will need to include <cppcsp/common/basic.h>

DATA_TYPE Requirements

DATA_TYPE must have a default constructor, and must meet the requirements of the channels it is being used with.

Public Member Functions
	Id (const Chanin< DATA_TYPE > &_in, const Chanout< DATA_TYPE > &_out)
	Constructs the Id process.
Protected Member Functions
void	run ()
	You must implement this function to provide the code for your process.

---

Constructor & Destructor Documentation

template<typename DATA_TYPE>

csp::common::Id< DATA_TYPE >::Id	(	const Chanin< DATA_TYPE > &	_in,
		const Chanout< DATA_TYPE > &	_out
	)			[inline]

Constructs the Id process.

Parameters:

	_in	The input channel
	_out	The output channel

---

Member Function Documentation

template<typename DATA_TYPE>

void csp::common::Id< DATA_TYPE >::run

(

)

[inline, protected, virtual]

You must implement this function to provide the code for your process.

When the run method finishes, the process will terminate.

You should not let an uncaught exception cause the end of this function. If it derives from std::exception, it will be caught (although this behaviour should not be relied upon) but otherwise undefined behaviour will result.

Implements csp::ThreadCSProcess.

---