Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

SH::ShChannel< T > Class Template Reference

The client interface to a single-channel typed data stream. More...

#include <ShChannel.hpp>

Collaboration diagram for SH::ShChannel< T >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef T::ValueType ValueType

Public Member Functions

 ShChannel ()
 Construct a channel without any associated memory.

 ShChannel (const ShMemoryPtr &memory, int count)
 Construct a channel with count elements in memory.

void memory (const ShMemoryPtr &memory, int count)
 Set this channel to use count elements in memory.

int count () const
 Return the number of elements in this channel.

ShPointer< const ShMemorymemory () const
 Return this channel's memory.

ShMemoryPtr memory ()
 Return this channel's memory.

operator() ()
 Fetch the current element from this stream.

const T operator() () const
 Fetch the current element from this stream.

ShChannelNodePtr node ()
 Return the node internally wrapped by this channel object.

const ShChannelNodePtr node () const
 Return the node internally wrapped by this channel object.

ShChanneloperator= (const ShProgram &program)
 Execute fully bound single-output stream program and place result in channel.


Detailed Description

template<typename T>
class SH::ShChannel< T >

The client interface to a single-channel typed data stream.

Really this hides an ShChannelNode which is the true representation of the channel. The template argument is the element type stored.

Todo:
copy constructor, operator=(), etc.

Definition at line 41 of file ShChannel.hpp.


Member Function Documentation

template<typename T>
const T SH::ShChannel< T >::operator()  )  const
 

Fetch the current element from this stream.

This is only useful in stream programs

Definition at line 107 of file ShChannelImpl.hpp.

References SH::SH_OP_FETCH.

template<typename T>
T SH::ShChannel< T >::operator()  ) 
 

Fetch the current element from this stream.

This is only useful in stream programs

Definition at line 93 of file ShChannelImpl.hpp.

References SH::SH_OP_FETCH.


The documentation for this class was generated from the following files:
Generated on Mon Oct 18 14:17:54 2004 for Sh by doxygen 1.3.7