gum::NodeGraphPartIteratorSafe Class Reference

Safe iterator on the node set of a graph. More...

#include <nodeGraphPart.h>

Inheritance diagram for gum::NodeGraphPartIteratorSafe:

Collaboration diagram for gum::NodeGraphPartIteratorSafe:

Public Types
using	iterator_category = std::forward_iterator_tag
	types for STL compliance
using	value_type = NodeId
	types for STL compliance
using	reference = value_type&
	types for STL compliance
using	const_reference = const value_type&
	types for STL compliance
using	pointer = value_type*
	types for STL compliance
using	const_pointer = const value_type*
	types for STL compliance
using	difference_type = std::ptrdiff_t
	types for STL compliance

Public Member Functions
void	_attachSignal_ (__sig__::ISignaler *sender)
void	_detachSignal_ (__sig__::ISignaler *sender)
Constructors / Destructors
	NodeGraphPartIteratorSafe (const NodeGraphPart &nodes)
	default constructor
	NodeGraphPartIteratorSafe (const NodeGraphPartIteratorSafe &it)
	copy constructor
	NodeGraphPartIteratorSafe (NodeGraphPartIteratorSafe &&it)
	move constructor
	~NodeGraphPartIteratorSafe () final
	destructor
Operators
NodeGraphPartIteratorSafe &	operator= (const NodeGraphPartIteratorSafe &it)
	copy assignment operator
NodeGraphPartIteratorSafe &	operator= (NodeGraphPartIteratorSafe &&it)
	move assignment operator
Accessors / Modifiers
void	whenNodeDeleted (const void *src, NodeId id)
	called when a node is deleted in the iterated NodeGraphPart
Operators
bool	operator== (const NodeGraphPartIterator &it) const noexcept
	checks whether two iterators point toward the same node
NodeGraphPartIterator &	operator++ () noexcept
	increment the iterator
value_type	operator* () const
	dereferencing operator

Protected Member Functions
void	setPos_ (NodeId id) noexcept
	this function is used by NodeGraphPart to update
void	validate_ () noexcept
	ensure that the nodeId is either end() either a valid NodeId

Protected Attributes
const NodeGraphPart *	nodes_
	the nodegraphpart on which points the iterator
NodeId	pos_ {0}
	the nodeid on which the iterator points currently
bool	valid_ {false}

Private Types
using	Senders_list = std::vector< __sig__::ISignaler* >
	Alias for the list of signal senders.

Private Attributes
Senders_list	_senders_

Friends
class	NodeGraphPart

Detailed Description

Safe iterator on the node set of a graph.

Definition at line 149 of file nodeGraphPart.h.

Member Typedef Documentation

const_pointer

using gum::NodeGraphPartIteratorSafe::const_pointer = const value_type*

types for STL compliance

Definition at line 160 of file nodeGraphPart.h.

const_reference

using gum::NodeGraphPartIteratorSafe::const_reference = const value_type&

types for STL compliance

Definition at line 158 of file nodeGraphPart.h.

difference_type

using gum::NodeGraphPartIteratorSafe::difference_type = std::ptrdiff_t

types for STL compliance

Definition at line 161 of file nodeGraphPart.h.

iterator_category

using gum::NodeGraphPartIteratorSafe::iterator_category = std::forward_iterator_tag

types for STL compliance

Definition at line 155 of file nodeGraphPart.h.

pointer

using gum::NodeGraphPartIteratorSafe::pointer = value_type*

types for STL compliance

Definition at line 159 of file nodeGraphPart.h.

reference

using gum::NodeGraphPartIteratorSafe::reference = value_type&

types for STL compliance

Definition at line 157 of file nodeGraphPart.h.

Senders_list

using gum::Listener::Senders_list = std::vector< __sig__::ISignaler* >

privateinherited

Alias for the list of signal senders.

Definition at line 96 of file listener.h.

value_type

using gum::NodeGraphPartIteratorSafe::value_type = NodeId

types for STL compliance

Definition at line 156 of file nodeGraphPart.h.

Constructor & Destructor Documentation

NodeGraphPartIteratorSafe() [1/3]

INLINE gum::NodeGraphPartIteratorSafe::NodeGraphPartIteratorSafe ( const NodeGraphPart & nodes )

explicit

default constructor

Definition at line 156 of file nodeGraphPart_inl.h.

                                                                                 :
      NodeGraphPartIterator(nodes) {
    GUM_CONNECT(*const_cast< NodeGraphPart* >(&nodes),
                onNodeDeleted,
                *this,
                NodeGraphPartIteratorSafe::whenNodeDeleted);
    GUM_CONSTRUCTOR(NodeGraphPartIteratorSafe);
  }

References gum::NodeGraphPartIterator::NodeGraphPartIterator(), NodeGraphPartIteratorSafe(), GUM_CONNECT, NodeGraphPart, and whenNodeDeleted().

Referenced by NodeGraphPartIteratorSafe(), NodeGraphPartIteratorSafe(), NodeGraphPartIteratorSafe(), ~NodeGraphPartIteratorSafe(), operator=(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

NodeGraphPartIteratorSafe() [2/3]

INLINE gum::NodeGraphPartIteratorSafe::NodeGraphPartIteratorSafe

(

const NodeGraphPartIteratorSafe &

it

)

copy constructor

Definition at line 167 of file nodeGraphPart_inl.h.

                                                                                          :
      NodeGraphPartIterator(it) {
    GUM_CONNECT(*const_cast< NodeGraphPart* >(nodes_),
                onNodeDeleted,
                *this,
                NodeGraphPartIteratorSafe::whenNodeDeleted);
    GUM_CONS_CPY(NodeGraphPartIteratorSafe);
  }

References gum::NodeGraphPartIterator::NodeGraphPartIterator(), NodeGraphPartIteratorSafe(), GUM_CONNECT, NodeGraphPart, gum::NodeGraphPartIterator::nodes_, and whenNodeDeleted().

Here is the call graph for this function:

NodeGraphPartIteratorSafe() [3/3]

INLINE gum::NodeGraphPartIteratorSafe::NodeGraphPartIteratorSafe

(

NodeGraphPartIteratorSafe &&

it

)

move constructor

Definition at line 178 of file nodeGraphPart_inl.h.

                                                                                     :
      NodeGraphPartIterator(std::move(it)) {
    GUM_CONNECT(*const_cast< NodeGraphPart* >(nodes_),
                onNodeDeleted,
                *this,
                NodeGraphPartIteratorSafe::whenNodeDeleted);
    GUM_CONS_MOV(NodeGraphPartIteratorSafe);
  }

References gum::NodeGraphPartIterator::NodeGraphPartIterator(), NodeGraphPartIteratorSafe(), GUM_CONNECT, NodeGraphPart, gum::NodeGraphPartIterator::nodes_, and whenNodeDeleted().

Here is the call graph for this function:

~NodeGraphPartIteratorSafe()

INLINE gum::NodeGraphPartIteratorSafe::~NodeGraphPartIteratorSafe ( )

final

destructor

Definition at line 188 of file nodeGraphPart_inl.h.

                                                               {
    GUM_DESTRUCTOR(NodeGraphPartIteratorSafe);
  }

References NodeGraphPartIteratorSafe().

Here is the call graph for this function:

Member Function Documentation

_attachSignal_()

INLINE void gum::Listener::_attachSignal_ ( __sig__::ISignaler * sender )

inherited

Definition at line 57 of file listener_inl.h.

{ _senders_.push_back(sender); }

References _senders_.

_detachSignal_()

INLINE void gum::Listener::_detachSignal_ ( __sig__::ISignaler * sender )

inherited

Definition at line 59 of file listener_inl.h.

                                                               {
    auto del = std::remove(_senders_.begin(), _senders_.end(), sender);
 
    if (del != _senders_.end()) _senders_.erase(del, _senders_.end());
  }

References _senders_.

Referenced by gum::__sig__::BasicSignaler< Args >::detach().

Here is the caller graph for this function:

operator*()

INLINE NodeId gum::NodeGraphPartIterator::operator* ( ) const

inherited

dereferencing operator

Definition at line 134 of file nodeGraphPart_inl.h.

                                                       {
    if (!valid_) { GUM_ERROR(UndefinedIteratorValue, "This iterator is not valid !") }
 
    return pos_;
  }

References GUM_ERROR, pos_, and valid_.

operator++()

INLINE NodeGraphPartIterator & gum::NodeGraphPartIterator::operator++ ( )

noexceptinherited

increment the iterator

Definition at line 127 of file nodeGraphPart_inl.h.

                                                                           {
    ++pos_;
    validate_();
    return *this;
  }

References NodeGraphPartIterator(), pos_, and validate_().

Here is the call graph for this function:

operator=() [1/2]

INLINE NodeGraphPartIteratorSafe & gum::NodeGraphPartIteratorSafe::operator=

(

const NodeGraphPartIteratorSafe &

it

)

copy assignment operator

Definition at line 194 of file nodeGraphPart_inl.h.

                                                                            {
    //  avoid self assignment
    if (&it != this) {
      NodeGraphPartIterator::operator=(it);
      Listener::operator=(it);
      GUM_OP_CPY(NodeGraphPartIteratorSafe);
    }
 
    return *this;
  }

References NodeGraphPartIteratorSafe(), and gum::NodeGraphPartIterator::operator=().

Here is the call graph for this function:

operator=() [2/2]

INLINE NodeGraphPartIteratorSafe & gum::NodeGraphPartIteratorSafe::operator=

(

NodeGraphPartIteratorSafe &&

it

)

move assignment operator

Definition at line 207 of file nodeGraphPart_inl.h.

                                                                       {
    //  avoid self assignment
    if (&it != this) {
      NodeGraphPartIterator::operator=(std::move(it));
      Listener::operator=(std::move(it));
      GUM_OP_MOV(NodeGraphPartIteratorSafe);
    }
 
    return *this;
  }

References NodeGraphPartIteratorSafe(), and gum::NodeGraphPartIterator::operator=().

Here is the call graph for this function:

operator==()

INLINE bool gum::NodeGraphPartIterator::operator== ( const NodeGraphPartIterator & it ) const

noexceptinherited

checks whether two iterators point toward the same node

Definition at line 122 of file nodeGraphPart_inl.h.

                                                                                     {
    return ((pos_ == it.pos_) && (valid_ == it.valid_) && (nodes_ == it.nodes_));
  }

References NodeGraphPartIterator(), nodes_, pos_, and valid_.

Here is the call graph for this function:

setPos_()

INLINE void gum::NodeGraphPartIterator::setPos_ ( NodeId id )

protectednoexceptinherited

this function is used by NodeGraphPart to update

Definition at line 141 of file nodeGraphPart_inl.h.

                                                               {
    pos_ = id;
 
    if (pos_ >= nodes_->bound()) {
      pos_   = nodes_->bound();
      valid_ = false;
    } else {
      valid_ = nodes_->exists(pos_);
    }
  }

References nodes_, pos_, and valid_.

validate_()

INLINE void gum::NodeGraphPartIterator::validate_ ( )

protectednoexceptinherited

ensure that the nodeId is either end() either a valid NodeId

Definition at line 59 of file nodeGraphPart_inl.h.

                                                        {
    valid_ = false;
 
    if (pos_ > nodes_->bound()) { pos_ = nodes_->bound(); }
 
    while (pos_ < nodes_->bound()) {
      if (!nodes_->_inHoles_(pos_)) {
        valid_ = true;
        return;
      }
 
      ++pos_;
    }
  }

References nodes_, pos_, and valid_.

Referenced by gum::NodeGraphPart::begin(), gum::NodeGraphPart::beginSafe(), and operator++().

Here is the caller graph for this function:

whenNodeDeleted()

void gum::NodeGraphPartIteratorSafe::whenNodeDeleted	(	const void *	src,
		NodeId	id )

called when a node is deleted in the iterated NodeGraphPart

Parameters

src	the NodeGraphPart
id	id of deleted node

Definition at line 254 of file nodeGraphPart.cpp.

                                                                            {
    if (id == pos_) {   // we just deleted the pos_ in NodeGraphPart
      valid_ = false;
    }
 
    if (pos_ >= nodes_->bound()) {   // moreover, it was the last position
      pos_   = nodes_->bound();
      valid_ = false;
    }
  }

References gum::NodeGraphPartIterator::nodes_, gum::NodeGraphPartIterator::pos_, and gum::NodeGraphPartIterator::valid_.

Referenced by NodeGraphPartIteratorSafe(), NodeGraphPartIteratorSafe(), and NodeGraphPartIteratorSafe().

Here is the caller graph for this function:

Friends And Related Symbol Documentation

NodeGraphPart

friend class NodeGraphPart

friend

Definition at line 150 of file nodeGraphPart.h.

References NodeGraphPart.

Referenced by NodeGraphPartIteratorSafe(), NodeGraphPartIteratorSafe(), NodeGraphPartIteratorSafe(), and NodeGraphPart.

Member Data Documentation

_senders_

Senders_list gum::Listener::_senders_

privateinherited

Definition at line 113 of file listener.h.

Referenced by Listener(), ~Listener(), _attachSignal_(), and _detachSignal_().

nodes_

const NodeGraphPart* gum::NodeGraphPartIterator::nodes_

protectedinherited

the nodegraphpart on which points the iterator

Definition at line 136 of file nodeGraphPart.h.

Referenced by NodeGraphPartIterator(), NodeGraphPartIterator(), NodeGraphPartIterator(), gum::NodeGraphPartIteratorSafe::NodeGraphPartIteratorSafe(), gum::NodeGraphPartIteratorSafe::NodeGraphPartIteratorSafe(), operator=(), operator=(), operator==(), setPos_(), validate_(), and gum::NodeGraphPartIteratorSafe::whenNodeDeleted().

pos_

NodeId gum::NodeGraphPartIterator::pos_ {0}

protectedinherited

the nodeid on which the iterator points currently

Definition at line 139 of file nodeGraphPart.h.

{0};

Referenced by NodeGraphPartIterator(), NodeGraphPartIterator(), operator*(), operator++(), operator=(), operator=(), operator==(), setPos_(), validate_(), and gum::NodeGraphPartIteratorSafe::whenNodeDeleted().

valid_

bool gum::NodeGraphPartIterator::valid_ {false}

protectedinherited

Definition at line 142 of file nodeGraphPart.h.

{false};

Referenced by NodeGraphPartIterator(), NodeGraphPartIterator(), operator*(), operator=(), operator=(), operator==(), setPos_(), validate_(), and gum::NodeGraphPartIteratorSafe::whenNodeDeleted().

---

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

• agrum/base/graphs/parts/nodeGraphPart.h
• agrum/base/graphs/parts/nodeGraphPart.cpp
• agrum/base/graphs/parts/nodeGraphPart_inl.h