Developer Documentation
Loading...
Searching...
No Matches
PluginFunctions::ObjectReferenceIterator Class Reference

Helper class that wraps an ObjectIterator to return a reference instead of a pointer. More...

#include <OpenFlipper/BasePlugin/PluginFunctions.hh>

Public Types

using iterator_category = std::forward_iterator_tag
 
using value_type = BaseObjectData
 
using difference_type = std::ptrdiff_t
 
using pointer = BaseObjectData *
 
using reference = BaseObjectData &
 

Public Member Functions

 ObjectReferenceIterator (IteratorRestriction _restriction=ALL_OBJECTS, DataType _dataType=DATA_ALL)
 
 ObjectReferenceIterator (BaseObjectData *_pos, IteratorRestriction _restriction=ALL_OBJECTS, DataType _dataType=DATA_ALL)
 
 ObjectReferenceIterator (const ObjectReferenceIterator &_rhs)
 
ObjectReferenceIteratoroperator= (const ObjectReferenceIterator &_rhs)
 
ObjectReferenceIteratoroperator++ ()
 
ObjectReferenceIterator operator++ (int)
 
bool operator== (const ObjectReferenceIterator &_rhs) const
 
bool operator!= (const ObjectReferenceIterator &_rhs) const
 
BaseObjectDataoperator* ()
 
BaseObjectDataoperator-> ()
 

Private Attributes

ObjectIterator it_
 

Detailed Description

Helper class that wraps an ObjectIterator to return a reference instead of a pointer.

Definition at line 532 of file PluginFunctions.hh.

Member Typedef Documentation

◆ difference_type

using PluginFunctions::ObjectReferenceIterator::difference_type = std::ptrdiff_t

Definition at line 537 of file PluginFunctions.hh.

◆ iterator_category

using PluginFunctions::ObjectReferenceIterator::iterator_category = std::forward_iterator_tag

Definition at line 535 of file PluginFunctions.hh.

◆ pointer

◆ reference

◆ value_type

Constructor & Destructor Documentation

◆ ObjectReferenceIterator() [1/3]

PluginFunctions::ObjectReferenceIterator::ObjectReferenceIterator ( IteratorRestriction  _restriction = ALL_OBJECTS,
DataType  _dataType = DATA_ALL 
)
inlineexplicit

Definition at line 541 of file PluginFunctions.hh.

◆ ObjectReferenceIterator() [2/3]

PluginFunctions::ObjectReferenceIterator::ObjectReferenceIterator ( BaseObjectData _pos,
IteratorRestriction  _restriction = ALL_OBJECTS,
DataType  _dataType = DATA_ALL 
)
inlineexplicit

Definition at line 546 of file PluginFunctions.hh.

◆ ObjectReferenceIterator() [3/3]

PluginFunctions::ObjectReferenceIterator::ObjectReferenceIterator ( const ObjectReferenceIterator _rhs)
inline

Definition at line 551 of file PluginFunctions.hh.

Member Function Documentation

◆ operator!=()

bool PluginFunctions::ObjectReferenceIterator::operator!= ( const ObjectReferenceIterator _rhs) const
inline

Definition at line 579 of file PluginFunctions.hh.

◆ operator*()

BaseObjectData & PluginFunctions::ObjectReferenceIterator::operator* ( )
inline

Definition at line 583 of file PluginFunctions.hh.

◆ operator++() [1/2]

ObjectReferenceIterator & PluginFunctions::ObjectReferenceIterator::operator++ ( )
inline

Definition at line 564 of file PluginFunctions.hh.

◆ operator++() [2/2]

ObjectReferenceIterator PluginFunctions::ObjectReferenceIterator::operator++ ( int  )
inline

Definition at line 569 of file PluginFunctions.hh.

◆ operator->()

BaseObjectData * PluginFunctions::ObjectReferenceIterator::operator-> ( )
inline

Definition at line 587 of file PluginFunctions.hh.

◆ operator=()

ObjectReferenceIterator & PluginFunctions::ObjectReferenceIterator::operator= ( const ObjectReferenceIterator _rhs)
inline

Definition at line 556 of file PluginFunctions.hh.

◆ operator==()

bool PluginFunctions::ObjectReferenceIterator::operator== ( const ObjectReferenceIterator _rhs) const
inline

Definition at line 575 of file PluginFunctions.hh.

Member Data Documentation

◆ it_

ObjectIterator PluginFunctions::ObjectReferenceIterator::it_
private

Definition at line 592 of file PluginFunctions.hh.


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