Walks over a container as if it were circular. The container must have the following members defined: More...

Inheritance diagram for ConstCirculator< ContainerType >:

Collaboration diagram for ConstCirculator< ContainerType >:

Public Types
typedef ContainerType::value_type	value_type
	Type of values ContainerType contains. More...

typedef ContainerType::size_type	size_type
	The type that can represent the size of ContainerType. More...

typedef ContainerType::difference_type	difference_type
	The type that can represent the difference between any two. More...

typedef ContainerType::const_iterator	const_iterator
	Random access iterator for traversing ContainerType. More...

typedef ContainerType::const_reference	const_reference
	Type that can be used for storing into. More...

Public Types inherited from CirculatorBase
enum	direction { none, clockwise, anticlockwise }
	Direction type enumeration. More...

Public Member Functions
	ConstCirculator ()
	Construct null. More...

	ConstCirculator (const ContainerType &container)
	Construct from a container. More...

	ConstCirculator (const const_iterator &begin, const const_iterator &end)
	Construct from two iterators. More...

	ConstCirculator (const ConstCirculator< ContainerType > &)
	Copy constructor. More...

	~ConstCirculator ()
	Destructor. More...

size_type	size () const
	Return the range of the iterator. More...

bool	circulate (const CirculatorBase::direction dir=CirculatorBase::direction::none)
	Circulate around the list in the given direction. More...

void	setFulcrumToIterator ()
	Set the fulcrum to the current position of the iterator. More...

void	setIteratorToFulcrum ()
	Set the iterator to the current position of the fulcrum. More...

difference_type	nRotations () const
	Return the distance between the iterator and the fulcrum. This is. More...

const_reference	next () const
	Dereference the next iterator and return. More...

const_reference	prev () const
	Dereference the previous iterator and return. More...

void	operator= (const ConstCirculator< ContainerType > &)
	Assignment operator for circulators that operate on the same. More...

ConstCirculator< ContainerType > &	operator++ ()
	Prefix increment. Increments the iterator. More...

ConstCirculator< ContainerType >	operator++ (int)
	Postfix increment. Increments the iterator. More...

ConstCirculator< ContainerType > &	operator-- ()
	Prefix decrement. Decrements the iterator. More...

ConstCirculator< ContainerType >	operator-- (int)
	Postfix decrement. Decrements the iterator. More...

bool	operator== (const ConstCirculator< ContainerType > &c) const
	Check for equality of this iterator with another iterator that. More...

bool	operator!= (const ConstCirculator< ContainerType > &c) const
	Check for inequality of this iterator with another iterator that. More...

const_reference	operator* () const
	Dereference the iterator and return. More...

const_reference	operator() () const
	Dereference the iterator and return. More...

difference_type	operator- (const ConstCirculator< ContainerType > &c) const
	Return the difference between this iterator and another iterator. More...

Public Member Functions inherited from CirculatorBase
	CirculatorBase ()
	Construct null. More...

Protected Attributes
ContainerType::const_iterator	begin_
	Iterator pointing to the beginning of the container. More...

ContainerType::const_iterator	end_
	Iterator pointing to the end of the container. More...

ContainerType::const_iterator	iter_
	Iterator. More...

ContainerType::const_iterator	fulcrum_
	Iterator holding the location of the fulcrum (start and end) of. More...

Detailed Description

template<class ContainerType>
class Foam::ConstCirculator< ContainerType >

Walks over a container as if it were circular. The container must have the following members defined:

- value_type

size_type
difference_type
const_iterator
const_reference

Examples:

face f(identity(5));
// Construct circulator from the face
ConstCirculator<face> circ(f);
// First check that the circulator has a size to iterate over.
// Then circulate around the list starting and finishing at the fulcrum.
if (circ.size()) do
{
    Info<< "Iterate forwards over face : " << circ() << endl;
} while (circ.circulate(CirculatorBase::direction::clockwise));

face f(identity(5));
ConstCirculator<face> circClockwise(f);
ConstCirculator<face> circAnticlockwise(f);
if (circClockwise.size() && circAnticlockwise.size()) do
{
    Info<< "Iterate forward over face :" << circClockwise() << endl;
    Info<< "Iterate backward over face:" << circAnticlockwise() << endl;
}
while
(
    circClockwise.circulate(CirculatorBase::direction::clockwise),
    circAnticlockwise.circulate
    (
        CirculatorBase::direction::anticlockwise
    )
);

Source files

Definition at line 94 of file ConstCirculator.H.

Member Typedef Documentation

◆ value_type

typedef ContainerType::value_type value_type

Type of values ContainerType contains.

Definition at line 123 of file ConstCirculator.H.

◆ size_type

typedef ContainerType::size_type size_type

The type that can represent the size of ContainerType.

Definition at line 126 of file ConstCirculator.H.

◆ difference_type

typedef ContainerType::difference_type difference_type

The type that can represent the difference between any two.

iterator objects.

Definition at line 130 of file ConstCirculator.H.

◆ const_iterator

typedef ContainerType::const_iterator const_iterator

Random access iterator for traversing ContainerType.

Definition at line 133 of file ConstCirculator.H.

◆ const_reference

typedef ContainerType::const_reference const_reference

Type that can be used for storing into.

const ContainerType::value_type objects.

Definition at line 137 of file ConstCirculator.H.

Constructor & Destructor Documentation

◆ ConstCirculator() [1/4]

ConstCirculator ( )

inline

Construct null.

Definition at line 29 of file ConstCirculatorI.H.

Referenced by ConstCirculator< ContainerType >::ConstCirculator().

Here is the caller graph for this function:

◆ ConstCirculator() [2/4]

ConstCirculator ( const ContainerType & container )

inlineexplicit

Construct from a container.

Definition at line 41 of file ConstCirculatorI.H.

References ConstCirculator< ContainerType >::ConstCirculator().

Here is the call graph for this function:

◆ ConstCirculator() [3/4]

ConstCirculator	(	const const_iterator &	begin,
		const const_iterator &	end
	)

inline

Construct from two iterators.

Definition at line 55 of file ConstCirculatorI.H.

References ConstCirculator< ContainerType >::ConstCirculator().

Here is the call graph for this function:

◆ ConstCirculator() [4/4]

ConstCirculator ( const ConstCirculator< ContainerType > & rhs )

inline

Copy constructor.

Definition at line 70 of file ConstCirculatorI.H.

◆ ~ConstCirculator()

~ConstCirculator ( )

Destructor.

Definition at line 85 of file ConstCirculatorI.H.

Member Function Documentation

◆ size()

Foam::ConstCirculator< ContainerType >::size_type size ( ) const

inline

Return the range of the iterator.

Definition at line 93 of file ConstCirculatorI.H.

References ConstCirculator< ContainerType >::begin_, ConstCirculator< ContainerType >::circulate(), and ConstCirculator< ContainerType >::end_.

Here is the call graph for this function:

◆ circulate()

bool circulate ( const CirculatorBase::direction dir = CirculatorBase::direction::none )

inline

Circulate around the list in the given direction.

Definition at line 101 of file ConstCirculatorI.H.

References CirculatorBase::anticlockwise, CirculatorBase::clockwise, ConstCirculator< ContainerType >::fulcrum_, ConstCirculator< ContainerType >::iter_, ConstCirculator< ContainerType >::operator++(), and ConstCirculator< ContainerType >::operator--().

Referenced by face::compare(), and ConstCirculator< ContainerType >::size().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFulcrumToIterator()

void setFulcrumToIterator ( )

inline

Set the fulcrum to the current position of the iterator.

Definition at line 119 of file ConstCirculatorI.H.

References ConstCirculator< ContainerType >::fulcrum_, and ConstCirculator< ContainerType >::iter_.

Referenced by face::compare().

Here is the caller graph for this function:

◆ setIteratorToFulcrum()

void setIteratorToFulcrum ( )

inline

Set the iterator to the current position of the fulcrum.

Definition at line 126 of file ConstCirculatorI.H.

References ConstCirculator< ContainerType >::fulcrum_, and ConstCirculator< ContainerType >::iter_.

Referenced by face::compare().

Here is the caller graph for this function:

◆ nRotations()

Foam::ConstCirculator< ContainerType >::difference_type nRotations ( ) const

inline

Return the distance between the iterator and the fulcrum. This is.

equivalent to the number of rotations of the circulator.

Definition at line 134 of file ConstCirculatorI.H.

References ConstCirculator< ContainerType >::fulcrum_, and ConstCirculator< ContainerType >::iter_.

◆ next()

Foam::ConstCirculator< ContainerType >::const_reference next ( ) const

inline

Dereference the next iterator and return.

Definition at line 142 of file ConstCirculatorI.H.

References ConstCirculator< ContainerType >::begin_, ConstCirculator< ContainerType >::end_, and ConstCirculator< ContainerType >::iter_.

◆ prev()

Foam::ConstCirculator< ContainerType >::const_reference prev ( ) const

inline

Dereference the previous iterator and return.

Definition at line 155 of file ConstCirculatorI.H.

References ConstCirculator< ContainerType >::begin_, ConstCirculator< ContainerType >::end_, and ConstCirculator< ContainerType >::iter_.

◆ operator=()

void operator= ( const ConstCirculator< ContainerType > & rhs )

inline

Assignment operator for circulators that operate on the same.

container type

Definition at line 170 of file ConstCirculatorI.H.

References Foam::abort(), ConstCirculator< ContainerType >::begin_, ConstCirculator< ContainerType >::end_, Foam::FatalError, FatalErrorInFunction, ConstCirculator< ContainerType >::fulcrum_, and ConstCirculator< ContainerType >::iter_.

Here is the call graph for this function:

◆ operator++() [1/2]

Foam::ConstCirculator< ContainerType > & operator++ ( )

inline

Prefix increment. Increments the iterator.

Sets the iterator to the beginning of the container if it reaches the end

Definition at line 191 of file ConstCirculatorI.H.

References ConstCirculator< ContainerType >::begin_, ConstCirculator< ContainerType >::end_, and ConstCirculator< ContainerType >::iter_.

Referenced by ConstCirculator< ContainerType >::circulate().

Here is the caller graph for this function:

◆ operator++() [2/2]

Foam::ConstCirculator< ContainerType > operator++ ( int )

inline

Postfix increment. Increments the iterator.

Sets the iterator to the beginning of the container if it reaches the end

Definition at line 205 of file ConstCirculatorI.H.

◆ operator--() [1/2]

Foam::ConstCirculator< ContainerType > & operator-- ( )

inline

Prefix decrement. Decrements the iterator.

Sets the iterator to the end of the container if it reaches the beginning

Definition at line 215 of file ConstCirculatorI.H.

References ConstCirculator< ContainerType >::begin_, ConstCirculator< ContainerType >::end_, and ConstCirculator< ContainerType >::iter_.

Referenced by ConstCirculator< ContainerType >::circulate().

Here is the caller graph for this function:

◆ operator--() [2/2]

Foam::ConstCirculator< ContainerType > operator-- ( int )

inline

Postfix decrement. Decrements the iterator.

Sets the iterator to the end of the container if it reaches the beginning

Definition at line 229 of file ConstCirculatorI.H.

◆ operator==()

bool operator== ( const ConstCirculator< ContainerType > & c ) const

inline

Check for equality of this iterator with another iterator that.

operate on the same container type

Definition at line 239 of file ConstCirculatorI.H.

References ConstCirculator< ContainerType >::begin_, Foam::constant::universal::c, ConstCirculator< ContainerType >::end_, ConstCirculator< ContainerType >::fulcrum_, and ConstCirculator< ContainerType >::iter_.

◆ operator!=()

bool operator!= ( const ConstCirculator< ContainerType > & c ) const

inline

Check for inequality of this iterator with another iterator that.

operate on the same container type

Definition at line 255 of file ConstCirculatorI.H.

References Foam::constant::universal::c.

◆ operator*()

Foam::ConstCirculator< ContainerType >::const_reference operator* ( ) const

inline

Dereference the iterator and return.

Definition at line 265 of file ConstCirculatorI.H.

References ConstCirculator< ContainerType >::iter_.

Referenced by ConstCirculator< ContainerType >::operator()().

Here is the caller graph for this function:

◆ operator()()

Foam::ConstCirculator< ContainerType >::const_reference operator() ( ) const

inline

Dereference the iterator and return.

Definition at line 273 of file ConstCirculatorI.H.

References ConstCirculator< ContainerType >::operator*().

Here is the call graph for this function:

◆ operator-()

Foam::ConstCirculator< ContainerType >::difference_type operator- ( const ConstCirculator< ContainerType > & c ) const

inline

Return the difference between this iterator and another iterator.

that operate on the same container type

Definition at line 282 of file ConstCirculatorI.H.

References Foam::constant::universal::c, and ConstCirculator< ContainerType >::iter_.

Member Data Documentation

◆ begin_

ContainerType::const_iterator begin_

protected

Iterator pointing to the beginning of the container.

Definition at line 104 of file ConstCirculator.H.

Referenced by ConstCirculator< ContainerType >::next(), ConstCirculator< ContainerType >::operator++(), ConstCirculator< ContainerType >::operator--(), ConstCirculator< ContainerType >::operator=(), ConstCirculator< ContainerType >::operator==(), ConstCirculator< ContainerType >::prev(), and ConstCirculator< ContainerType >::size().

◆ end_

ContainerType::const_iterator end_

protected

Iterator pointing to the end of the container.

Definition at line 107 of file ConstCirculator.H.

Referenced by ConstCirculator< ContainerType >::next(), ConstCirculator< ContainerType >::operator++(), ConstCirculator< ContainerType >::operator--(), ConstCirculator< ContainerType >::operator=(), ConstCirculator< ContainerType >::operator==(), ConstCirculator< ContainerType >::prev(), and ConstCirculator< ContainerType >::size().

◆ iter_

ContainerType::const_iterator iter_

protected

Iterator.

Definition at line 110 of file ConstCirculator.H.

◆ fulcrum_

ContainerType::const_iterator fulcrum_

protected

Iterator holding the location of the fulcrum (start and end) of.

the container. Used to decide when the iterator should stop circulating over the container

Definition at line 115 of file ConstCirculator.H.

Referenced by ConstCirculator< ContainerType >::circulate(), ConstCirculator< ContainerType >::nRotations(), ConstCirculator< ContainerType >::operator=(), ConstCirculator< ContainerType >::operator==(), ConstCirculator< ContainerType >::setFulcrumToIterator(), and ConstCirculator< ContainerType >::setIteratorToFulcrum().

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

src/OpenFOAM/containers/Circulators/ConstCirculator/ConstCirculator.H
src/OpenFOAM/containers/Circulators/ConstCirculator/ConstCirculatorI.H

Public Types

Public Member Functions

Protected Attributes

Detailed Description

template<class ContainerType> class Foam::ConstCirculator< ContainerType >

Member Typedef Documentation

◆ value_type

◆ size_type

◆ difference_type

◆ const_iterator

◆ const_reference

Constructor & Destructor Documentation

◆ ConstCirculator() [1/4]

◆ ConstCirculator() [2/4]

◆ ConstCirculator() [3/4]

◆ ConstCirculator() [4/4]

◆ ~ConstCirculator()

Member Function Documentation

◆ size()

◆ circulate()

◆ setFulcrumToIterator()

◆ setIteratorToFulcrum()

◆ nRotations()

◆ next()

◆ prev()

◆ operator=()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator==()

◆ operator!=()

◆ operator*()

◆ operator()()

◆ operator-()

Member Data Documentation

◆ begin_

◆ end_

◆ iter_

◆ fulcrum_

template<class ContainerType>
class Foam::ConstCirculator< ContainerType >