VTK
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Friends | List of all members
vtkPBGLDistributedGraphHelper Class Reference

end namespace boost::graph::distributed More...

#include <vtkPBGLDistributedGraphHelper.h>

Inheritance diagram for vtkPBGLDistributedGraphHelper:
[legend]
Collaboration diagram for vtkPBGLDistributedGraphHelper:
[legend]

Public Types

typedef vtkDistributedGraphHelper Superclass
 
- Public Types inherited from vtkDistributedGraphHelper
typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkPBGLDistributedGraphHelperNewInstance () const
 
void Synchronize ()
 Synchronizes all of the processors involved in this distributed graph, so that all processors have a consistent view of the distributed graph for the computation that follows. More...
 
vtkDistributedGraphHelperClone ()
 Clones this distributed graph helper. More...
 
boost::graph::distributed::mpi_process_group GetProcessGroup ()
 Return the process group associated with this distributed graph. More...
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
- Public Member Functions inherited from vtkDistributedGraphHelper
vtkDistributedGraphHelperNewInstance () const
 
vtkIdType GetVertexOwner (vtkIdType v) const
 Returns owner of vertex v, by extracting top ceil(log2 P) bits of v. More...
 
vtkIdType GetVertexIndex (vtkIdType v) const
 Returns local index of vertex v, by masking off top ceil(log2 P) bits of v. More...
 
vtkIdType GetEdgeOwner (vtkIdType e_id) const
 Returns owner of edge with ID e_id, by extracting top ceil(log2 P) bits of e_id. More...
 
vtkIdType GetEdgeIndex (vtkIdType e_id) const
 Returns local index of edge with ID e_id, by masking off top ceil(log2 P) bits of e_id. More...
 
vtkIdType MakeDistributedId (int owner, vtkIdType local)
 Builds a distributed ID consisting of the given owner and the local ID. More...
 
void SetVertexPedigreeIdDistribution (vtkVertexPedigreeIdDistribution Func, void *userData)
 Set the pedigreeId -> processor distribution function that determines how vertices are distributed when they are associated with pedigree ID, which must be a unique label such as a URL or IP address. More...
 
vtkIdType GetVertexOwnerByPedigreeId (const vtkVariant &pedigreeId)
 Determine which processor owns the vertex with the given pedigree ID. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPBGLDistributedGraphHelperSafeDownCast (vtkObjectBase *o)
 
static vtkPBGLDistributedGraphHelperNew ()
 Creates an empty Parallel BGL distributed graph helper. More...
 
- Static Public Member Functions inherited from vtkDistributedGraphHelper
static int IsTypeOf (const char *type)
 
static vtkDistributedGraphHelperSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyDISTRIBUTEDVERTEXIDS ()
 Information Keys that distributed graphs can append to attribute arrays to flag them as containing distributed IDs. More...
 
static vtkInformationIntegerKeyDISTRIBUTEDEDGEIDS ()
 Information Keys that distributed graphs can append to attribute arrays to flag them as containing distributed IDs. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Public Attributes

vtkPBGLDistributedGraphHelperInternalsInternals
 The Parallel BGL-specific internal information for this distributed graph. More...
 

Protected Types

enum  Tags {
  FIND_VERTEX_TAG, FIND_EDGE_SOURCE_TARGET_TAG, ADD_VERTEX_NO_REPLY_TAG, ADD_VERTEX_WITH_REPLY_TAG,
  ADD_VERTEX_PROPS_NO_REPLY_TAG, ADD_VERTEX_PROPS_WITH_REPLY_TAG, ADD_DIRECTED_BACK_EDGE_TAG, ADD_UNDIRECTED_BACK_EDGE_TAG,
  ADD_DIRECTED_EDGE_NO_REPLY_TAG, ADD_UNDIRECTED_EDGE_NO_REPLY_TAG, ADD_DIRECTED_EDGE_WITH_REPLY_TAG, ADD_UNDIRECTED_EDGE_WITH_REPLY_TAG,
  ADD_DIRECTED_EDGE_NI_NO_REPLY_TAG, ADD_UNDIRECTED_EDGE_NI_NO_REPLY_TAG, ADD_DIRECTED_EDGE_NI_WITH_REPLY_TAG, ADD_UNDIRECTED_EDGE_NI_WITH_REPLY_TAG,
  ADD_DIRECTED_EDGE_IN_NO_REPLY_TAG, ADD_UNDIRECTED_EDGE_IN_NO_REPLY_TAG, ADD_DIRECTED_EDGE_NN_NO_REPLY_TAG, ADD_UNDIRECTED_EDGE_NN_NO_REPLY_TAG
}
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPBGLDistributedGraphHelper ()
 
 ~vtkPBGLDistributedGraphHelper ()
 
void AddVertexInternal (vtkVariantArray *propertyArr, vtkIdType *vertex)
 Add a vertex, optionally with properties, to the distributed graph. More...
 
void AddVertexInternal (const vtkVariant &pedigreeId, vtkIdType *vertex)
 Add a vertex with the given pedigree ID to the distributed graph. More...
 
void AddEdgeInternal (vtkIdType u, vtkIdType v, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)
 Add an edge (u, v) to the distributed graph. More...
 
void AddEdgeInternal (const vtkVariant &uPedigreeId, vtkIdType v, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)
 Adds an edge (u, v) and returns the new edge. More...
 
void AddEdgeInternal (vtkIdType u, const vtkVariant &vPedigreeId, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)
 Adds an edge (u, v) and returns the new edge. More...
 
void AddEdgeInternal (const vtkVariant &uPedigreeId, const vtkVariant &vPedigreeId, bool directed, vtkVariantArray *propertyArr, vtkEdgeType *edge)
 Adds an edge (u, v) and returns the new edge. More...
 
vtkIdType FindVertex (const vtkVariant &pedigreeId)
 Try to find the vertex with the given pedigree ID. More...
 
void FindEdgeSourceAndTarget (vtkIdType id, vtkIdType *source, vtkIdType *target)
 Determine the source and target of the edge with the given ID. More...
 
void AttachToGraph (vtkGraph *graph)
 Attach this distributed graph helper to the given graph. More...
 
- Protected Member Functions inherited from vtkDistributedGraphHelper
 vtkDistributedGraphHelper ()
 
 ~vtkDistributedGraphHelper () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Friends

class vtkPBGLDistributedGraphHelperInternals
 

Additional Inherited Members

- Protected Attributes inherited from vtkDistributedGraphHelper
vtkGraphGraph
 The graph to which this distributed graph helper is already attached. More...
 
vtkVertexPedigreeIdDistribution VertexDistribution
 The distribution function used to map a pedigree ID to a processor. More...
 
void * VertexDistributionUserData
 Extra, user-specified data to be passed into the distribution function. More...
 
vtkIdType signBitMask
 Bit mask to speed up decoding graph info {owner,index}. More...
 
vtkIdType highBitShiftMask
 Bit mask to speed up decoding graph info {owner,index}. More...
 
int procBits
 Number of bits required to represent # of processors (owner) More...
 
int indexBits
 Number of bits required to represent {vertex,edge} index. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

end namespace boost::graph::distributed

helper for the vtkGraph class that provides support for the Parallel Boost Graph Library

vtkPBGLDistributedGraphHelper is a helper class that allows a vtkGraph object to be distributed across several different processors using the Parallel Boost Graph Library (Parallel BGL, or PBGL). When attached to a vtkGraph instance, vtkPBGLDistributedGraphHelper provides the necessary communication support to build and manipulate distributed graphs. To enable the use of this class, you will need to configure VTK with the VTK_USE_PARALLEL_BGL option.

Deprecated:
Not maintained as of VTK 6.2 and will be removed eventually.

.SEEALSO vtkGraph vtkDistributedGraphHelper

Tests:
vtkPBGLDistributedGraphHelper (Tests)

Definition at line 55 of file vtkPBGLDistributedGraphHelper.h.

Member Typedef Documentation

Definition at line 58 of file vtkPBGLDistributedGraphHelper.h.

Member Enumeration Documentation

Enumerator
FIND_VERTEX_TAG 
FIND_EDGE_SOURCE_TARGET_TAG 
ADD_VERTEX_NO_REPLY_TAG 
ADD_VERTEX_WITH_REPLY_TAG 
ADD_VERTEX_PROPS_NO_REPLY_TAG 
ADD_VERTEX_PROPS_WITH_REPLY_TAG 
ADD_DIRECTED_BACK_EDGE_TAG 
ADD_UNDIRECTED_BACK_EDGE_TAG 
ADD_DIRECTED_EDGE_NO_REPLY_TAG 
ADD_UNDIRECTED_EDGE_NO_REPLY_TAG 
ADD_DIRECTED_EDGE_WITH_REPLY_TAG 
ADD_UNDIRECTED_EDGE_WITH_REPLY_TAG 
ADD_DIRECTED_EDGE_NI_NO_REPLY_TAG 
ADD_UNDIRECTED_EDGE_NI_NO_REPLY_TAG 
ADD_DIRECTED_EDGE_NI_WITH_REPLY_TAG 
ADD_UNDIRECTED_EDGE_NI_WITH_REPLY_TAG 
ADD_DIRECTED_EDGE_IN_NO_REPLY_TAG 
ADD_UNDIRECTED_EDGE_IN_NO_REPLY_TAG 
ADD_DIRECTED_EDGE_NN_NO_REPLY_TAG 
ADD_UNDIRECTED_EDGE_NN_NO_REPLY_TAG 

Definition at line 97 of file vtkPBGLDistributedGraphHelper.h.

Constructor & Destructor Documentation

vtkPBGLDistributedGraphHelper::vtkPBGLDistributedGraphHelper ( )
protected
vtkPBGLDistributedGraphHelper::~vtkPBGLDistributedGraphHelper ( )
protected

Member Function Documentation

static int vtkPBGLDistributedGraphHelper::IsTypeOf ( const char *  type)
static
virtual int vtkPBGLDistributedGraphHelper::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDistributedGraphHelper.

static vtkPBGLDistributedGraphHelper* vtkPBGLDistributedGraphHelper::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkPBGLDistributedGraphHelper::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDistributedGraphHelper.

vtkPBGLDistributedGraphHelper* vtkPBGLDistributedGraphHelper::NewInstance ( ) const
static vtkPBGLDistributedGraphHelper* vtkPBGLDistributedGraphHelper::New ( )
static

Creates an empty Parallel BGL distributed graph helper.

void vtkPBGLDistributedGraphHelper::Synchronize ( )
virtual

Synchronizes all of the processors involved in this distributed graph, so that all processors have a consistent view of the distributed graph for the computation that follows.

This routine should be invoked after adding new edges into the distributed graph, so that other processors will see those edges (or their corresponding back-edges).

Implements vtkDistributedGraphHelper.

vtkDistributedGraphHelper* vtkPBGLDistributedGraphHelper::Clone ( )
virtual

Clones this distributed graph helper.

Implements vtkDistributedGraphHelper.

boost::graph::distributed::mpi_process_group vtkPBGLDistributedGraphHelper::GetProcessGroup ( )

Return the process group associated with this distributed graph.

void vtkPBGLDistributedGraphHelper::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkDistributedGraphHelper.

void vtkPBGLDistributedGraphHelper::AddVertexInternal ( vtkVariantArray propertyArr,
vtkIdType vertex 
)
protectedvirtual

Add a vertex, optionally with properties, to the distributed graph.

If vertex is non-NULL, it will be set to the newly-added (or found) vertex. Note that if propertyArr is non-NULL and the vertex data contains pedigree IDs, a vertex will only be added if there is no vertex with that pedigree ID.

Implements vtkDistributedGraphHelper.

void vtkPBGLDistributedGraphHelper::AddVertexInternal ( const vtkVariant pedigreeId,
vtkIdType vertex 
)
protectedvirtual

Add a vertex with the given pedigree ID to the distributed graph.

If vertex is non-NULL, it will receive the newly-created vertex.

Implements vtkDistributedGraphHelper.

void vtkPBGLDistributedGraphHelper::AddEdgeInternal ( vtkIdType  u,
vtkIdType  v,
bool  directed,
vtkVariantArray propertyArr,
vtkEdgeType edge 
)
protectedvirtual

Add an edge (u, v) to the distributed graph.

The edge may be directed undirected. If edge is non-null, it will receive the newly-created edge. If propertyArr is non-null, it specifies the properties that will be attached to the newly-created edge.

Implements vtkDistributedGraphHelper.

void vtkPBGLDistributedGraphHelper::AddEdgeInternal ( const vtkVariant uPedigreeId,
vtkIdType  v,
bool  directed,
vtkVariantArray propertyArr,
vtkEdgeType edge 
)
protectedvirtual

Adds an edge (u, v) and returns the new edge.

The graph edge may or may not be directed, depending on the given flag. If edge is non-null, it will receive the newly-created edge. uPedigreeId is the pedigree ID of vertex u, which will be added if no vertex by that pedigree ID exists. If propertyArr is non-null, it specifies the properties that will be attached to the newly-created edge.

Implements vtkDistributedGraphHelper.

void vtkPBGLDistributedGraphHelper::AddEdgeInternal ( vtkIdType  u,
const vtkVariant vPedigreeId,
bool  directed,
vtkVariantArray propertyArr,
vtkEdgeType edge 
)
protectedvirtual

Adds an edge (u, v) and returns the new edge.

The graph edge may or may not be directed, depending on the given flag. If edge is non-null, it will receive the newly-created edge. vPedigreeId is the pedigree ID of vertex u, which will be added if no vertex with that pedigree ID exists. If propertyArr is non-null, it specifies the properties that will be attached to the newly-created edge.

Implements vtkDistributedGraphHelper.

void vtkPBGLDistributedGraphHelper::AddEdgeInternal ( const vtkVariant uPedigreeId,
const vtkVariant vPedigreeId,
bool  directed,
vtkVariantArray propertyArr,
vtkEdgeType edge 
)
protectedvirtual

Adds an edge (u, v) and returns the new edge.

The graph edge may or may not be directed, depending on the given flag. If edge is non-null, it will receive the newly-created edge. uPedigreeId is the pedigree ID of vertex u and vPedigreeId is the pedigree ID of vertex u, each of which will be added if no vertex by that pedigree ID exists. If propertyArr is non-null, it specifies the properties that will be attached to the newly-created edge.

Implements vtkDistributedGraphHelper.

vtkIdType vtkPBGLDistributedGraphHelper::FindVertex ( const vtkVariant pedigreeId)
protectedvirtual

Try to find the vertex with the given pedigree ID.

Returns true and fills in the vertex ID if the vertex is found, and returns false otherwise;

Implements vtkDistributedGraphHelper.

void vtkPBGLDistributedGraphHelper::FindEdgeSourceAndTarget ( vtkIdType  id,
vtkIdType source,
vtkIdType target 
)
protectedvirtual

Determine the source and target of the edge with the given ID.

Used internally by vtkGraph::GetSourceVertex and vtkGraph::GetTargetVertex.

Implements vtkDistributedGraphHelper.

void vtkPBGLDistributedGraphHelper::AttachToGraph ( vtkGraph graph)
protectedvirtual

Attach this distributed graph helper to the given graph.

This will be called as part of vtkGraph::SetDistributedGraphHelper.

Reimplemented from vtkDistributedGraphHelper.

Friends And Related Function Documentation

friend class vtkPBGLDistributedGraphHelperInternals
friend

Definition at line 231 of file vtkPBGLDistributedGraphHelper.h.

Member Data Documentation

vtkPBGLDistributedGraphHelperInternals* vtkPBGLDistributedGraphHelper::Internals

The Parallel BGL-specific internal information for this distributed graph.

TODO: Make this protected

Definition at line 89 of file vtkPBGLDistributedGraphHelper.h.


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