ChannelBase< SampleType > Class Template Reference

A single output signal. More...

Inherits SmartPointerContainer< SmartPointerType, enableWeak >.

List of all members.

Public Member Functions
	ChannelBase () throw ()
	Default constructor.
	ChannelBase (Internal *internal) throw ()
	Construct a channel with a specific internal type.
	ChannelBase (UnitType const &unit) throw ()
	Get the first channel from a one-channel unit.
	ChannelBase (UnitBase< SampleType > const &unit) throw ()
	Get the first channel from a one-channel unit.
	ChannelBase (ChannelBase const &copy) throw ()
	Copy constructor.
ChannelBase &	operator= (ChannelBase const &other) throw ()
	Assignment operator.
template<class ValueType >
	ChannelBase (ValueType const &valueInit) throw ()
	Construct a channel that generates a constant.
bool	needsToProcess (ProcessInfo const &info) const throw ()
Static Public Member Functions
static ChannelBase	fromWeak (Weak const &weak) throw ()
	Get a weakly linked copy of this object.

---

Detailed Description

template<class SampleType>
class ChannelBase< SampleType >

A single output signal.

Channel objects may have multiple inputs but only one output. Multiple outputs are achieve by using arrays of Channel objects or a Unit object. True multiple input / multiple output Unit objects are achieved using a proxy system.

---

Constructor & Destructor Documentation

template<class SampleType >

ChannelBase< SampleType >::ChannelBase

(

)

throw () [inline]

Default constructor.

Creates a "null" channel.

template<class SampleType >

ChannelBase< SampleType >::ChannelBase

(

Internal *

internal

)

throw () [inline]

Construct a channel with a specific internal type.

template<class SampleType >

ChannelBase< SampleType >::ChannelBase

(

UnitType const &

unit

)

throw () [inline]

Get the first channel from a one-channel unit.

template<class SampleType >

ChannelBase< SampleType >::ChannelBase

(

UnitBase< SampleType > const &

unit

)

throw () [inline]

Get the first channel from a one-channel unit.

template<class SampleType >

ChannelBase< SampleType >::ChannelBase

(

ChannelBase< SampleType > const &

copy

)

throw () [inline]

Copy constructor.

Note that a deep copy is not made, the copy will refer to exactly the same data.

template<class SampleType >

template<class ValueType >

ChannelBase< SampleType >::ChannelBase

(

ValueType const &

valueInit

)

throw () [inline]

Construct a channel that generates a constant.

---

Member Function Documentation

template<class SampleType >

static ChannelBase ChannelBase< SampleType >::fromWeak

(

Weak const &

weak

)

throw () [inline, static]

Get a weakly linked copy of this object.

This will return a blank/empty/null object of this type if the original has already been deleted.

template<class SampleType >

bool ChannelBase< SampleType >::needsToProcess

(

ProcessInfo const &

info

)

const throw () [inline]

Returns true if this unit needs to process for the given timestamp.

template<class SampleType >

ChannelBase& ChannelBase< SampleType >::operator=

(

ChannelBase< SampleType > const &

other

)

throw () [inline]

Assignment operator.

---

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

• plonk_Channel.h