ChannelIterator Class Reference

ChannelIterator Class Reference
+ Related help topics:

#include <adskDataChannelIterator.h>

Class Description

Class handling iteration over Streams in a Channel object.

The Stream list is sorted by name so this iterator class will walk in that order.

For technical reasons this class lives outside the Channel class though really it is part of it. A typedef is set up inside that class so that you can use it like a standard iterator:

for( Channel::iterator iterator = myChannel.begin(); iterator != myChannel.end(); ++iterator ) { processStream( *iterator ); }

Static Public Member Functions

static bool Debug (const ChannelIterator *me, Debug::Print &request)
 Answer a Print request for an ChannelIterator object. More...
 
static bool Debug (const ChannelIterator *me, Debug::Footprint &request)
 Answer a footprint request for an ChannelIterator object. More...
 

Protected Member Functions

ChannelIteratorImpl const & impl () const
 Get the implementation class in const form. More...
 
ChannelIteratorImpl & impl ()
 Get the implementation class. More...
 

Member Function Documentation

ChannelIteratorImpl const & impl ( ) const
protected

Get the implementation class in const form.

Returns
Const reference to this class's implementation object
ChannelIteratorImpl & impl ( )
protected

Get the implementation class.

Returns
Reference to this class's implementation object
bool Debug ( const ChannelIterator me,
Debug::Print request 
)
static

Answer a Print request for an ChannelIterator object.

Use the request object to dump all information on the "me" object or all static class information if "me" is NULL.

Parameters
[in]mePointer to object to debug, NULL means class static
[out]requestPrint request object
Returns
True if the request was successfully processed.
bool Debug ( const ChannelIterator me,
Debug::Footprint request 
)
static

Answer a footprint request for an ChannelIterator object.

Populate the Footprint request with the information on all data stored within this class if "me" is NULL, otherwise the information stored in the object pointed at by "me".

Parameters
[in]mePointer to object to footprint, NULL means class static
[out]requestFootprint object to populate
Returns
True if the request was successfully processed. The Footprint object will have all information added to it.

The documentation for this class was generated from the following files:
  • adskDataChannelIterator.h
  • adskDataChannelIterator.cpp