walberla::pe::ConstRigidBodyCastIterator< C > Class Template Reference

#include <RigidBodyCastIterator.h>

Public Types
using	ContainerType = std::vector< std::unique_ptr< RigidBody > >
using	iterator_category = std::forward_iterator_tag
using	value_type = C const
using	pointer = C const *
using	reference = C const &
using	difference_type = std::ptrdiff_t

Public Member Functions
Constructors
	ConstRigidBodyCastIterator ()=default
	ConstRigidBodyCastIterator (const typename ContainerType::const_iterator &begin, const typename ContainerType::const_iterator &end)
	Standard constructor for CastIterator. More...
	ConstRigidBodyCastIterator (const ConstRigidBodyCastIterator< C > &it)=default
	ConstRigidBodyCastIterator (ConstRigidBodyCastIterator< C > &&it)=default
ConstRigidBodyCastIterator &	operator= (const ConstRigidBodyCastIterator< C > &it)=default
ConstRigidBodyCastIterator &	operator= (ConstRigidBodyCastIterator< C > &&it)=default
Operators
ConstRigidBodyCastIterator< C > &	operator++ ()
	Pre-increment operator. More...
ConstRigidBodyCastIterator< C >	operator++ (int)
Access operators
reference	operator* ()
pointer	operator-> ()
Utility functions
pointer	getBodyID ()

Private Attributes
Member variables
ContainerType::const_iterator	cur_
	Pointer to the current memory location. More...
ContainerType::const_iterator	end_
	Pointer to the element one past the last element in the element range. More...

Friends
template<typename C2 >
bool	operator== (const ConstRigidBodyCastIterator< C2 > &lhs, const ConstRigidBodyCastIterator< C2 > &rhs)
template<typename C2 >
bool	operator!= (const ConstRigidBodyCastIterator< C2 > &lhs, const ConstRigidBodyCastIterator< C2 > &rhs)

Member Typedef Documentation

ContainerType

template<typename C >

using walberla::pe::ConstRigidBodyCastIterator< C >::ContainerType = std::vector< std::unique_ptr<RigidBody> >

difference_type

template<typename C >

using walberla::pe::ConstRigidBodyCastIterator< C >::difference_type = std::ptrdiff_t

iterator_category

template<typename C >

using walberla::pe::ConstRigidBodyCastIterator< C >::iterator_category = std::forward_iterator_tag

pointer

template<typename C >

using walberla::pe::ConstRigidBodyCastIterator< C >::pointer = C const *

reference

template<typename C >

using walberla::pe::ConstRigidBodyCastIterator< C >::reference = C const &

value_type

template<typename C >

using walberla::pe::ConstRigidBodyCastIterator< C >::value_type = C const

Constructor & Destructor Documentation

ConstRigidBodyCastIterator() [1/4]

template<typename C >

walberla::pe::ConstRigidBodyCastIterator< C >::ConstRigidBodyCastIterator ( )

inlinedefault

ConstRigidBodyCastIterator() [2/4]

template<typename C >

walberla::pe::ConstRigidBodyCastIterator< C >::ConstRigidBodyCastIterator ( const typename ContainerType::const_iterator &  begin, const typename ContainerType::const_iterator &  end  )

inlineexplicit

Standard constructor for CastIterator.

Parameters

begin	The beginning of the element range.
end	The end of the element range.

ConstRigidBodyCastIterator() [3/4]

template<typename C >

walberla::pe::ConstRigidBodyCastIterator< C >::ConstRigidBodyCastIterator ( const ConstRigidBodyCastIterator< C > &  it )

default

ConstRigidBodyCastIterator() [4/4]

template<typename C >

walberla::pe::ConstRigidBodyCastIterator< C >::ConstRigidBodyCastIterator ( ConstRigidBodyCastIterator< C > &&  it )

default

Member Function Documentation

getBodyID()

template<typename C >

pointer walberla::pe::ConstRigidBodyCastIterator< C >::getBodyID ( )

inline

operator*()

template<typename C >

reference walberla::pe::ConstRigidBodyCastIterator< C >::operator* ( )

inline

operator++() [1/2]

template<typename C >

ConstRigidBodyCastIterator< C > & walberla::pe::ConstRigidBodyCastIterator< C >::operator++

inline

Pre-increment operator.

Returns

Reference to the incremented cast iterator.

operator++() [2/2]

template<typename C >

ConstRigidBodyCastIterator<C> walberla::pe::ConstRigidBodyCastIterator< C >::operator++ ( int  )

inline

operator->()

template<typename C >

pointer walberla::pe::ConstRigidBodyCastIterator< C >::operator-> ( )

inline

operator=() [1/2]

template<typename C >

ConstRigidBodyCastIterator& walberla::pe::ConstRigidBodyCastIterator< C >::operator= ( const ConstRigidBodyCastIterator< C > &  it )

default

operator=() [2/2]

template<typename C >

ConstRigidBodyCastIterator& walberla::pe::ConstRigidBodyCastIterator< C >::operator= ( ConstRigidBodyCastIterator< C > &&  it )

default

Friends And Related Function Documentation

operator!=

template<typename C >

template<typename C2 >

bool operator!= ( const ConstRigidBodyCastIterator< C2 > &  lhs, const ConstRigidBodyCastIterator< C2 > &  rhs  )

friend

operator==

template<typename C >

template<typename C2 >

bool operator== ( const ConstRigidBodyCastIterator< C2 > &  lhs, const ConstRigidBodyCastIterator< C2 > &  rhs  )

friend

Member Data Documentation

cur_

template<typename C >

ContainerType::const_iterator walberla::pe::ConstRigidBodyCastIterator< C >::cur_

private

Pointer to the current memory location.

end_

template<typename C >

ContainerType::const_iterator walberla::pe::ConstRigidBodyCastIterator< C >::end_

private

Pointer to the element one past the last element in the element range.

---

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

• /builds/administration/walberla-website/walberla/src/pe/rigidbody/RigidBodyCastIterator.h