PluginFunctions::BaseObjectIterator Class Reference

Core Data Iterator used to iterate over all objects (Including groups) More...

#include <OpenFlipper/BasePlugin/PluginFunctions.hh>

Public Types
typedef BaseObject	value_type
	type of the Objects the iterator works on
typedef BaseObject *	value_handle
	handle type (just an int)
typedef value_type &	reference
	reference type
typedef value_type *	pointer
	basic pointer type

Public Member Functions
	BaseObjectIterator (const IteratorRestriction &_restriction=ALL_OBJECTS, DataType _dataType=DATA_ALL)
	Use this constructor for iterating through your data.
	BaseObjectIterator (BaseObject *pos, const IteratorRestriction &_restriction=ALL_OBJECTS, DataType _dataType=DATA_ALL)
	additional constructor starting at a given position
	operator value_handle ()
	return the current position of the iterator
bool	operator== (const BaseObjectIterator &_rhs)
	compare iterators
bool	operator!= (const BaseObjectIterator &_rhs)
	compare iterators
BaseObjectIterator &	operator= (const BaseObjectIterator &_rhs)
	assign iterators
pointer	operator-> ()
	dereference
BaseObjectIterator &	operator++ ()
	next element
BaseObjectIterator &	operator-- ()
	last element
BaseObject *	operator* ()
	dereference the iterator
BaseObject *	index ()
	return current position of the iterator

Private Attributes
BaseObject *	pos_
	current position of the iterator
DataType	dataType_
	returned data types of the iterator
IteratorRestriction	restriction_
	Restriction of the iterator.

Detailed Description

Core Data Iterator used to iterate over all objects (Including groups)

This iterator is a more low level one not only returning really visible objects but also Data containers ( e.g. groups... ) You can choose if the iterator returns only Target, Source or all objects.
Additionally you can set the type of objects returned by the iterator.

Definition at line 696 of file PluginFunctions.hh.

Member Typedef Documentation

pointer

typedef value_type* PluginFunctions::BaseObjectIterator::pointer

basic pointer type

Definition at line 710 of file PluginFunctions.hh.

reference

typedef value_type& PluginFunctions::BaseObjectIterator::reference

reference type

Definition at line 707 of file PluginFunctions.hh.

value_handle

typedef BaseObject* PluginFunctions::BaseObjectIterator::value_handle

handle type (just an int)

Definition at line 704 of file PluginFunctions.hh.

value_type

typedef BaseObject PluginFunctions::BaseObjectIterator::value_type

type of the Objects the iterator works on

Definition at line 701 of file PluginFunctions.hh.

Constructor & Destructor Documentation

BaseObjectIterator() [1/2]

PluginFunctions::BaseObjectIterator::BaseObjectIterator	(	const IteratorRestriction &	_restriction = ALL_OBJECTS,
		DataType	_dataType = DATA_ALL
	)

Use this constructor for iterating through your data.

Parameters

_restriction	Use this parameter to define which objects will be returned. You can select between ALL_OBJECTS , TARGET_OBJECTS , SOURCE_OBJECTS.
_dataType	Use this parameter to select the returned object types. You can use DATA_ALL DATA_POLY_MESH DATA_TRIANGLE_MESH DATA_VOLUME

Definition at line 57 of file PluginFunctionsBaseIterator.cc.

BaseObjectIterator() [2/2]

PluginFunctions::BaseObjectIterator::BaseObjectIterator	(	BaseObject *	pos,
		const IteratorRestriction &	_restriction = ALL_OBJECTS,
		DataType	_dataType = DATA_ALL
	)

additional constructor starting at a given position

Definition at line 100 of file PluginFunctionsBaseIterator.cc.

Member Function Documentation

index()

BaseObject * PluginFunctions::BaseObjectIterator::index ( )

inline

return current position of the iterator

Definition at line 749 of file PluginFunctions.hh.

operator value_handle()

PluginFunctions::BaseObjectIterator::operator value_handle ( )

inline

return the current position of the iterator

Definition at line 725 of file PluginFunctions.hh.

operator!=()

bool PluginFunctions::BaseObjectIterator::operator!=

(

const BaseObjectIterator &

_rhs

)

compare iterators

Definition at line 112 of file PluginFunctionsBaseIterator.cc.

operator*()

BaseObject * PluginFunctions::BaseObjectIterator::operator*

(

)

dereference the iterator

This operator returns a pointer to the current object the iterator points to.

Returns

Pointer to the current ObjectData

Definition at line 181 of file PluginFunctionsBaseIterator.cc.

operator++()

BaseObjectIterator & PluginFunctions::BaseObjectIterator::operator++

(

)

next element

Definition at line 128 of file PluginFunctionsBaseIterator.cc.

operator--()

BaseObjectIterator & PluginFunctions::BaseObjectIterator::operator--

(

)

last element

Definition at line 171 of file PluginFunctionsBaseIterator.cc.

operator->()

BaseObjectIterator::pointer PluginFunctions::BaseObjectIterator::operator->

(

)

dereference

Definition at line 124 of file PluginFunctionsBaseIterator.cc.

operator=()

BaseObjectIterator & PluginFunctions::BaseObjectIterator::operator=

(

const BaseObjectIterator &

_rhs

)

assign iterators

Definition at line 116 of file PluginFunctionsBaseIterator.cc.

operator==()

bool PluginFunctions::BaseObjectIterator::operator==

(

const BaseObjectIterator &

_rhs

)

compare iterators

Definition at line 108 of file PluginFunctionsBaseIterator.cc.

Member Data Documentation

dataType_

DataType PluginFunctions::BaseObjectIterator::dataType_

private

returned data types of the iterator

Definition at line 756 of file PluginFunctions.hh.

pos_

BaseObject* PluginFunctions::BaseObjectIterator::pos_

private

current position of the iterator

Definition at line 753 of file PluginFunctions.hh.

restriction_

IteratorRestriction PluginFunctions::BaseObjectIterator::restriction_

private

Restriction of the iterator.

Definition at line 759 of file PluginFunctions.hh.

---

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

• OpenFlipper/BasePlugin/PluginFunctions.hh
• OpenFlipper/BasePlugin/PluginFunctionsBaseIterator.cc