gum::__sig__::BasicSignaler< Args > Class Template Reference

Base class for signalers, managing connector lifecycle. More...

#include <signaler.h>

Inherits ISignaler.

Public Member Functions
	~BasicSignaler () override
	Destructor: detaches from all targets and deletes connectors.
bool	hasListener () override
void	detach (Listener *target)
	Detach a specific listener from this signaler.

Protected Types
using	ConnectorList = std::vector< IConnector< Args... >* >

Protected Member Functions
	BasicSignaler ()
	Default constructor.
	BasicSignaler (const BasicSignaler &other)
	Copy constructor: duplicates all connectors and re-attaches to targets.
void	detachFromTarget (Listener *target) override
	Called by Listener to detach when the listener is destroyed.
void	duplicateTarget (const Listener *oldTarget, Listener *newTarget) override
	Called by Listener copy constructor to duplicate connections.

Protected Attributes
ConnectorList	_connectors_

Friends
class	gum::Listener

Detailed Description

template<typename... Args>
class gum::__sig__::BasicSignaler< Args >

Base class for signalers, managing connector lifecycle.

Template Parameters

Args	The types of arguments passed when the signal is emitted.

Definition at line 163 of file signaler.h.

Member Typedef Documentation

ConnectorList

template<typename... Args>

using gum::__sig__::BasicSignaler< Args >::ConnectorList = std::vector< IConnector< Args... >* >

protected

Definition at line 165 of file signaler.h.

Constructor & Destructor Documentation

BasicSignaler() [1/2]

template<typename... Args>

gum::__sig__::BasicSignaler< Args >::BasicSignaler ( )

inlineprotected

Default constructor.

Definition at line 168 of file signaler.h.

{ GUM_CONSTRUCTOR(BasicSignaler); }

References BasicSignaler().

Referenced by BasicSignaler(), BasicSignaler(), and ~BasicSignaler().

Here is the call graph for this function:

Here is the caller graph for this function:

BasicSignaler() [2/2]

template<typename... Args>

gum::__sig__::BasicSignaler< Args >::BasicSignaler ( const BasicSignaler< Args > & other )

protected

Copy constructor: duplicates all connectors and re-attaches to targets.

Definition at line 89 of file signaler_tpl.h.

                                                                    : ISignaler() {
    GUM_CONS_CPY(BasicSignaler);
    for (const auto* connector: other._connectors_) {
      auto* cloned = connector->clone();
      _connectors_.push_back(cloned);
      cloned->target()->_attachSignal_(this);
    }
  }

References BasicSignaler(), and _connectors_.

Here is the call graph for this function:

~BasicSignaler()

template<typename... Args>

gum::__sig__::BasicSignaler< Args >::~BasicSignaler ( )

override

Destructor: detaches from all targets and deletes connectors.

Definition at line 99 of file signaler_tpl.h.

                                           {
    GUM_DESTRUCTOR(BasicSignaler);
    for (auto* connector: _connectors_) {
      connector->target()->_detachSignal_(this);
      delete connector;
    }
    _connectors_.clear();
  }

References BasicSignaler(), and _connectors_.

Here is the call graph for this function:

Member Function Documentation

detach()

template<typename... Args>

void gum::__sig__::BasicSignaler< Args >::detach

(

Listener *

target

)

Detach a specific listener from this signaler.

Definition at line 114 of file signaler_tpl.h.

                                                        {
    for (auto it = _connectors_.rbegin(); it != _connectors_.rend(); ++it) {
      if ((*it)->target() == target) {
        auto* conn = *it;
        _connectors_.erase(std::next(it).base());
        target->_detachSignal_(this);
        delete conn;
        return;
      }
    }
  }

References _connectors_, gum::Listener::_detachSignal_(), and gum::Listener.

Here is the call graph for this function:

detachFromTarget()

template<typename... Args>

void gum::__sig__::BasicSignaler< Args >::detachFromTarget ( Listener * target )

overrideprotected

Called by Listener to detach when the listener is destroyed.

Definition at line 127 of file signaler_tpl.h.

                                                                  {
    for (auto it = _connectors_.begin(); it != _connectors_.end();) {
      if ((*it)->target() == target) {
        delete *it;
        it = _connectors_.erase(it);
      } else {
        ++it;
      }
    }
  }

References _connectors_, and gum::Listener.

Here is the call graph for this function:

duplicateTarget()

template<typename... Args>

void gum::__sig__::BasicSignaler< Args >::duplicateTarget ( const Listener * oldTarget, Listener * newTarget )

overrideprotected

Called by Listener copy constructor to duplicate connections.

Definition at line 139 of file signaler_tpl.h.

                                                                                               {
    ConnectorList toAdd;
    for (auto* connector: _connectors_) {
      if (connector->target() == oldTarget) { toAdd.push_back(connector->duplicate(newTarget)); }
    }
    for (auto* newConn: toAdd) {
      _connectors_.push_back(newConn);
    }
  }

References _connectors_, and gum::Listener.

Here is the call graph for this function:

hasListener()

template<typename... Args>

bool gum::__sig__::BasicSignaler< Args >::hasListener ( )

override

Returns

true if at least one listener is attached.

Definition at line 109 of file signaler_tpl.h.

                                             {
    return !_connectors_.empty();
  }

References _connectors_.

Friends And Related Symbol Documentation

gum::Listener

template<typename... Args>

friend class gum::Listener

friend

Definition at line 184 of file signaler.h.

References gum::Listener.

Referenced by detach(), detachFromTarget(), duplicateTarget(), and gum::Listener.

Member Data Documentation

_connectors_

template<typename... Args>

ConnectorList gum::__sig__::BasicSignaler< Args >::_connectors_

protected

Definition at line 192 of file signaler.h.

Referenced by BasicSignaler(), ~BasicSignaler(), detach(), detachFromTarget(), duplicateTarget(), and hasListener().

---

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

• agrum/base/core/signal/signaler.h
• agrum/base/core/signal/signaler_tpl.h