fpmas 1.6
Public Types | Public Member Functions | Public Attributes | List of all members
fpmas::api::graph::SetDistantNodeEvent< T > Struct Template Reference

#include <distributed_graph.h>

Inheritance diagram for fpmas::api::graph::SetDistantNodeEvent< T >:
Inheritance graph
[legend]
Collaboration diagram for fpmas::api::graph::SetDistantNodeEvent< T >:
Collaboration graph
[legend]

Public Types

enum  Context { IMPORT_NEW_DISTANT , EXPORT_DISTANT , UNSPECIFIED }
 

Public Member Functions

 SetDistantNodeEvent (DistributedNode< T > *node, Context context)
 
- Public Member Functions inherited from fpmas::api::graph::NodeEvent< T >
 NodeEvent (DistributedNode< T > *node)
 

Public Attributes

Context context
 
- Public Attributes inherited from fpmas::api::graph::NodeEvent< T >
DistributedNode< T > * node
 

Detailed Description

template<typename T>
struct fpmas::api::graph::SetDistantNodeEvent< T >

Event triggered when a node is set DISTANT within a DistributedGraph.

Such event can be handled with callbacks provided to DistributedGraph::addCallOnSetDistant().

In addition to the node instance, information about the context of the event are provided.

Member Enumeration Documentation

◆ Context

Specifies the cause of the set DISTANT operation.

Enumerator
IMPORT_NEW_DISTANT 

Used when a DISTANT node is inserted in the graph as a source or target node of a DISTANT edge.

EXPORT_DISTANT 

Used when a LOCAL node is exported because of a DistributedGraph::distribute() operation, so that the LOCAL node becomes DISTANT.

UNSPECIFIED 

Can be used when the event context is unspecified or does not falls in the other explicit contexts. Can also be useful for tests that does not depend on the context.

Constructor & Destructor Documentation

◆ SetDistantNodeEvent()

template<typename T >
fpmas::api::graph::SetDistantNodeEvent< T >::SetDistantNodeEvent ( DistributedNode< T > *  node,
Context  context 
)
inline

SetDistantNodeEvent constructor.

Member Data Documentation

◆ context

template<typename T >
Context fpmas::api::graph::SetDistantNodeEvent< T >::context

Event context.


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