AssociationsIterator Class Reference

This reference page is linked to from the following overview topics: Meta Data.

---

Search for all occurrences

---

Detailed Description

Class handling iteration over Channels in an Associations object.

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

For technical reasons this class lives outside the Associations 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( Associations::iterator iterator = myMetadata.begin(); iterator != myMetadata.end(); ++iterator ) { processChannel( *iterator ); }

#include <adskDataAssociationsIterator.h>

List of all members.

Static Public Member Functions
static bool	Debug (const AssociationsIterator *me, Debug::Print &request)
	Answer a Print request for an AssociationsIterator object.
static bool	Debug (const AssociationsIterator *me, Debug::Footprint &request)
	Answer a footprint request for an AssociationsIterator object.
Protected Member Functions
AssociationsIteratorImpl &	impl ()
	Get the implementation class.
AssociationsIteratorImpl const &	impl () const
	Get the implementation class in const form.

---

Member Function Documentation

AssociationsIteratorImpl & impl

(

)

[protected]

Search for all occurrences

Get the implementation class.

Returns:

Reference to this class's implementation object

AssociationsIteratorImpl const & impl

(

)

const [protected]

Search for all occurrences

Get the implementation class in const form.

Returns:

Const reference to this class's implementation object

bool Debug	(	const AssociationsIterator *	me,
		Debug::Print &	request
	)		[static]

Search for all occurrences

Answer a Print request for an AssociationsIterator object.

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

Parameters:

[in]	me	Pointer to object to debug, NULL means class static
[out]	request	Print request object

Returns:

True if the request was successfully processed.

bool Debug	(	const AssociationsIterator *	me,
		Debug::Footprint &	request
	)		[static]

Search for all occurrences

Answer a footprint request for an AssociationsIterator 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]	me	Pointer to object to footprint, NULL means class static
[out]	request	Footprint object to populate

Returns:

True if the request was successfully processed. The Footprint object will have all information added to it.