CLAM::CLAM::StreamImpl< Token, PhantomBuffer > Class Template Reference

#include <StreamImpl.hxx>

List of all members.

---

Detailed Description

template<typename Token>
class CLAM::CLAM::StreamImpl< Token, PhantomBuffer >

Definition at line 139 of file StreamImpl.hxx.

Public Member Functions
void	NewWritingRegionSize (Region &writer)
void	NewReadingRegionSize (Region &reader)
void	WriterHasAdvanced (Region &writer)
	Notifies the stream impl that the writing region have just produced.
void	ReaderHasAdvanced (Region &reader)
Token &	Read (int physicalIndex, int size)
Token &	operator[] (int physicalIndex)
int	LogicalSize () const
int	PhantomSize ()
	This method appears only in the PhantomBuffer specialization template.
bool	ExistsCircularOverlap (int rear, int writingHead) const

---

Member Function Documentation

template<typename Token>

void CLAM::CLAM::StreamImpl< Token, PhantomBuffer >::NewWritingRegionSize

(

Region &

writer

)

[inline]

Definition at line 171 of file StreamImpl.hxx.

References CLAM_DEBUG_ASSERT, CLAM::Region::ProducerRegion(), and CLAM::Region::Size().

template<typename Token>

void CLAM::CLAM::StreamImpl< Token, PhantomBuffer >::NewReadingRegionSize

(

Region &

reader

)

[inline]

Definition at line 179 of file StreamImpl.hxx.

References CLAM_DEBUG_ASSERT, and CLAM::Region::ProducerRegion().

template<typename Token>

void CLAM::CLAM::StreamImpl< Token, PhantomBuffer >::WriterHasAdvanced

(

Region &

writer

)

[inline]

Notifies the stream impl that the writing region have just produced.

Definition at line 248 of file StreamImpl.hxx.

References CLAM::Region::BeginDistance(), and CLAM::Region::Size().

template<typename Token>

void CLAM::CLAM::StreamImpl< Token, PhantomBuffer >::ReaderHasAdvanced

(

Region &

reader

)

[inline]

Definition at line 255 of file StreamImpl.hxx.

template<typename Token>

Token & CLAM::CLAM::StreamImpl< Token, PhantomBuffer >::Read	(	int	physicalIndex,
		int	size
	)			[inline]

Definition at line 261 of file StreamImpl.hxx.

template<typename Token>

Token & CLAM::CLAM::StreamImpl< Token, PhantomBuffer >::operator[]

(

int

physicalIndex

)

[inline]

Definition at line 267 of file StreamImpl.hxx.

References CLAM_DEBUG_ASSERT, CLAM::StreamImpl< Token, DataStructure >::LogicalSize(), and CLAM::StreamImpl< Token, DataStructure >::Read().

template<typename Token>

int CLAM::CLAM::StreamImpl< Token, PhantomBuffer >::LogicalSize

(

)

const [inline]

Definition at line 274 of file StreamImpl.hxx.

template<typename Token>

int CLAM::CLAM::StreamImpl< Token, PhantomBuffer >::PhantomSize

(

)

[inline]

This method appears only in the PhantomBuffer specialization template.

Most useful for testing purposes.

Definition at line 280 of file StreamImpl.hxx.

template<typename Token>

bool CLAM::CLAM::StreamImpl< Token, PhantomBuffer >::ExistsCircularOverlap	(	int	rear,
		int	writingHead
	)			const [inline]

Definition at line 286 of file StreamImpl.hxx.

References CLAM::StreamImpl< Token, DataStructure >::LogicalSize().

---

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

• StreamImpl.hxx