CLAM::ReadingRegion< WritingRegion > Class Template Reference

#include <ReadingRegion.hxx>

List of all members.

Public Member Functions
	ReadingRegion ()
	~ReadingRegion ()
void	LinkAndNotifySizeToStream (ProperStream &stream)
ProperStream &	Stream ()
bool	CanConsume ()
	Condition of overlap between reading and writing regions.
void	Consume ()
	This method must be called when the data of the reading-region has been already readen (consumed) and we want to advance the region position for further readings (consumes).
void	LinkProducerRegion (Region &writing)
ProperToken &	operator[] (int offset)
Region *	ProducerRegion ()
void	RemoveProducer ()
ReadingRegionsIterator	BeginReaders ()
ReadingRegionsIterator	EndReaders ()

---

Detailed Description

template<class WritingRegion>
class CLAM::ReadingRegion< WritingRegion >

Definition at line 32 of file ReadingRegion.hxx.

---

Constructor & Destructor Documentation

template<class WritingRegion >

CLAM::ReadingRegion< WritingRegion >::ReadingRegion

(

)

[inline]

Definition at line 74 of file ReadingRegion.hxx.

template<class WritingRegion >

CLAM::ReadingRegion< WritingRegion >::~ReadingRegion

(

)

[inline]

Definition at line 80 of file ReadingRegion.hxx.

References CLAM::Region::RemoveRegion().

---

Member Function Documentation

template<class WritingRegion >

ReadingRegion< WritingRegion >::ReadingRegionsIterator CLAM::ReadingRegion< WritingRegion >::BeginReaders

(

)

[inline, virtual]

Implements CLAM::Region.

Definition at line 150 of file ReadingRegion.hxx.

template<class WritingRegion >

bool CLAM::ReadingRegion< WritingRegion >::CanConsume

(

)

[inline]

Condition of overlap between reading and writing regions.

Returns true if are not overlapping so it can consume

Definition at line 100 of file ReadingRegion.hxx.

References CLAM::Region::Pos(), CLAM::ReadingRegion< WritingRegion >::ProducerRegion(), and CLAM::Region::Size().

Referenced by CLAM::InPort< Token >::CanConsume(), CLAM::ReadingRegion< WritingRegion >::Consume(), and CLAM::ReadingRegion< WritingRegion >::operator[]().

template<class WritingRegion >

void CLAM::ReadingRegion< WritingRegion >::Consume

(

)

[inline]

This method must be called when the data of the reading-region has been already readen (consumed) and we want to advance the region position for further readings (consumes).

Definition at line 108 of file ReadingRegion.hxx.

References CLAM::ReadingRegion< WritingRegion >::CanConsume(), CLAM_DEBUG_ASSERT, CLAM::Region::Hop(), and CLAM::Region::Pos().

Referenced by CLAM::InPort< Token >::Consume().

template<class WritingRegion >

ReadingRegion< WritingRegion >::ReadingRegionsIterator CLAM::ReadingRegion< WritingRegion >::EndReaders

(

)

[inline, virtual]

Implements CLAM::Region.

Definition at line 156 of file ReadingRegion.hxx.

template<class WritingRegion >

void CLAM::ReadingRegion< WritingRegion >::LinkAndNotifySizeToStream

(

ProperStream &

stream

)

[inline]

Definition at line 87 of file ReadingRegion.hxx.

Referenced by CLAM::WritingRegion< Token, DataStructure >::LinkRegions().

template<class WritingRegion >

void CLAM::ReadingRegion< WritingRegion >::LinkProducerRegion

(

Region &

writing

)

[inline]

Definition at line 116 of file ReadingRegion.hxx.

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

Referenced by CLAM::WritingRegion< Token, DataStructure >::LinkRegions().

template<class WritingRegion >

ReadingRegion< WritingRegion >::ProperToken & CLAM::ReadingRegion< WritingRegion >::operator[]

(

int

offset

)

[inline]

Definition at line 125 of file ReadingRegion.hxx.

References CLAM::Region::BeginDistance(), CLAM::ReadingRegion< WritingRegion >::CanConsume(), CLAM_DEBUG_ASSERT, and CLAM::Region::Size().

template<class WritingRegion >

Region * CLAM::ReadingRegion< WritingRegion >::ProducerRegion

(

)

[inline, virtual]

Implements CLAM::Region.

Definition at line 137 of file ReadingRegion.hxx.

Referenced by CLAM::ReadingRegion< WritingRegion >::CanConsume(), and CLAM::InPort< Token >::UnAttachRegion().

template<class WritingRegion >

void CLAM::ReadingRegion< WritingRegion >::RemoveProducer

(

)

[inline, virtual]

Reimplemented from CLAM::Region.

Definition at line 143 of file ReadingRegion.hxx.

template<class WritingRegion >

ReadingRegion< WritingRegion >::ProperStream & CLAM::ReadingRegion< WritingRegion >::Stream

(

)

[inline]

Definition at line 94 of file ReadingRegion.hxx.

---

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

• ReadingRegion.hxx