gum::UndiGraphListener Class Reference

Abstract Base class for all undiGraph Listener. More...

#include <undiGraphListener.h>

Inheritance diagram for gum::UndiGraphListener:

Collaboration diagram for gum::UndiGraphListener:

Public Member Functions
void	attachSignal__ (__sig__::ISignaler *sender)
void	detachSignal__ (__sig__::ISignaler *sender)
Constructors / Destructors
	UndiGraphListener (UndiGraph *g)
	default constructor More...
	~UndiGraphListener ()
	destructor More...
signals to listen to
virtual void	whenNodeAdded (const void *src, NodeId id)=0
	the action to take when a new node is inserted into the graph More...
virtual void	whenNodeDeleted (const void *src, NodeId id)=0
	the action to take when a node has just been removed from the graph More...
virtual void	whenEdgeAdded (const void *src, NodeId id1, NodeId id2)=0
	the action to take when a new edge is inserted into the graph More...
virtual void	whenEdgeDeleted (const void *src, NodeId from, NodeId to)=0
	the action to take when an edge has just been removed from the graph More...

Protected Attributes
UndiGraph *	_graph
	the graph to listen to More...

Detailed Description

Abstract Base class for all undiGraph Listener.

This is the virtual base class for not-oriented graphs meta-listener.

An UndiGraphListener will have to implement following pure methods :

• void whenNodeAdded( const void * ,gum::NodeId )
• void whenNodeDeleted( const void *,gum::NodeId )
• void whenEdgeAdded( const void *,gum::NodeId,gum::NodeId )
• void whenEdgeDeleted( const void *,gum::NodeId,gum::NodeId )

Definition at line 49 of file undiGraphListener.h.

Constructor & Destructor Documentation

UndiGraphListener() [1/2]

gum::UndiGraphListener::UndiGraphListener

(

UndiGraph *

g

)

default constructor

Parameters

g	the graph to listen to

Warning

Note that, by the aGrUM's constructor parameter's rule, the fact that g is passed as a pointer means that g is not copied, but only referenced by the listener.

Definition at line 47 of file undiGraphListener.cpp.

References _graph, GUM_CONNECT, GUM_ERROR, whenEdgeAdded(), whenEdgeDeleted(), whenNodeAdded(), and whenNodeDeleted().

                                                   {
    if (!g) {
      GUM_ERROR(OperationNotAllowed, "A graph listener need a graph to listen to");
    }

    GUM_CONSTRUCTOR(UndiGraphListener);
    _graph = g;

    GUM_CONNECT((*_graph), onNodeAdded, (*this), UndiGraphListener::whenNodeAdded);
    GUM_CONNECT(
       (*_graph), onNodeDeleted, (*this), UndiGraphListener::whenNodeDeleted);
    GUM_CONNECT((*_graph), onEdgeAdded, (*this), UndiGraphListener::whenEdgeAdded);
    GUM_CONNECT(
       (*_graph), onEdgeDeleted, (*this), UndiGraphListener::whenEdgeDeleted);
  }

Here is the call graph for this function:

~UndiGraphListener()

gum::UndiGraphListener::~UndiGraphListener

(

)

destructor

Definition at line 63 of file undiGraphListener.cpp.

{ GUM_DESTRUCTOR(UndiGraphListener); }

UndiGraphListener() [2/2]

gum::UndiGraphListener::UndiGraphListener ( const UndiGraphListener &  d )

private

copy constructor (for the moment, this operation is forbidden)

Parameters

d	the UndiGraphListener to copy

Definition at line 37 of file undiGraphListener.cpp.

References GUM_ERROR.

                                                                 {
    GUM_CONS_CPY(UndiGraphListener);
    GUM_ERROR(OperationNotAllowed, "No copy constructor for UndiGraphListener");
  }

Member Function Documentation

attachSignal__()

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

inherited

Definition at line 36 of file listener_inl.h.

References gum::Listener::__senders.

                                                               {
    __senders.push_back(sender);
  }

detachSignal__()

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

inherited

Definition at line 40 of file listener_inl.h.

References gum::Listener::__senders.

                                                               {
    auto del = std::remove(__senders.begin(), __senders.end(), sender);

    if (del != __senders.end()) __senders.erase(del, __senders.end());
  }

operator=()

UndiGraphListener & gum::UndiGraphListener::operator= ( const UndiGraphListener &  d )

private

copy operator (for the moment, this operation is forbidden)

Parameters

d	the UndiGraphListener to copy

Definition at line 42 of file undiGraphListener.cpp.

References GUM_ERROR.

                                                                            {
    GUM_OP_CPY(UndiGraphListener);
    GUM_ERROR(OperationNotAllowed, "No copy operator for UndiGraphListener");
  }

whenEdgeAdded()

virtual void gum::UndiGraphListener::whenEdgeAdded ( const void *  src, NodeId  id1, NodeId  id2  )

pure virtual

the action to take when a new edge is inserted into the graph

Parameters

src	the object that sent the signal
id1	the id of one node of the edge inserted into the graph
id2	the id of the other node of the edge inserted into the graph

Referenced by UndiGraphListener().

Here is the caller graph for this function:

whenEdgeDeleted()

virtual void gum::UndiGraphListener::whenEdgeDeleted ( const void *  src, NodeId  from, NodeId  to  )

pure virtual

the action to take when an edge has just been removed from the graph

Parameters

src	the object that sent the signal
from	the id of one node of the edge removed from the graph
to	the id of the other node of the edge removed from the graph

Referenced by UndiGraphListener().

Here is the caller graph for this function:

whenNodeAdded()

virtual void gum::UndiGraphListener::whenNodeAdded ( const void *  src, NodeId  id  )

pure virtual

the action to take when a new node is inserted into the graph

Parameters

src	the object that sent the signal
id	the id of the new node inserted into the graph

Referenced by UndiGraphListener().

Here is the caller graph for this function:

whenNodeDeleted()

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

pure virtual

the action to take when a node has just been removed from the graph

Parameters

src	the object that sent the signal
id	the id of the node has just been removed from the graph

Referenced by UndiGraphListener().

Here is the caller graph for this function:

Member Data Documentation

_graph

UndiGraph* gum::UndiGraphListener::_graph

protected

the graph to listen to

Definition at line 100 of file undiGraphListener.h.

Referenced by UndiGraphListener().

---

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

• agrum/graphs/parts/listeners/undiGraphListener.h
• agrum/graphs/parts/listeners/undiGraphListener.cpp