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

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

List of all members.

---

Detailed Description

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

A process that reads a value from its input channel, increments it, and writes it to the process's output channel.

The increment is done using the prefix ++ operator. This process is included because of its occam history, and its use in the commstime benchmark. However, you may also find a use for it.

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 support the prefix increment operator (++), and also must meet the requirements of the channels it is being used with.

Public Member Functions
	Successor (const Chanin< DATA_TYPE > &_in, const Chanout< DATA_TYPE > &_out)
	Constructs the Successor 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::Successor< DATA_TYPE >::Successor	(	const Chanin< DATA_TYPE > &	_in,
		const Chanout< DATA_TYPE > &	_out
	)			[inline]

Constructs the Successor process.

Parameters:

	_in	The input channel
	_out	The output channel

---

Member Function Documentation

template<typename DATA_TYPE>

void csp::common::Successor< 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.

---