ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends
vtkCompositeMultiProcessController Class Reference

#include <vtkCompositeMultiProcessController.h>

Inheritance diagram for vtkCompositeMultiProcessController:
Inheritance graph
[legend]
Collaboration diagram for vtkCompositeMultiProcessController:
Collaboration graph
[legend]

List of all members.

Public Types

enum  EventId { CompositeMultiProcessControllerChanged = 2345 }

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
int GetActiveControllerID ()
int GetNumberOfControllers ()
int GetControllerId (int idx)
void SetMasterController (int id)
int GetMasterController ()
void RegisterController (vtkMultiProcessController *controller)
void UnRegisterController (vtkMultiProcessController *controller)
int UnRegisterActiveController ()
vtkMultiProcessControllerGetActiveController ()
virtual void Initialize ()
virtual void Initialize (int *, char ***)
virtual void Initialize (int *, char ***, int)
virtual void Finalize ()
virtual void Finalize (int)
virtual void SingleMethodExecute ()
virtual void MultipleMethodExecute ()
virtual void CreateOutputWindow ()
virtual vtkCommunicatorGetCommunicator ()
virtual unsigned long AddRMICallback (vtkRMIFunctionType, void *localArg, int tag)
virtual void TriggerRMI2All (int remote, void *data, int length, int tag, bool sendToActiveToo)
virtual void RemoveAllRMICallbacks (int tag)
virtual int RemoveFirstRMI (int tag)
virtual bool RemoveRMICallback (unsigned long observerTagId)

Static Public Member Functions

static
vtkCompositeMultiProcessController
New ()
static int IsTypeOf (const char *type)
static
vtkCompositeMultiProcessController
SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkCompositeMultiProcessController ()
 ~vtkCompositeMultiProcessController ()

Friends

class vtkCompositeInternals

Detailed Description

vtkCompositeMultiProcessController offer a composite implementation of vtkMultiProcessController that allow us to deal with collaborative MultiProcessController by switching transparently underneath the active one and forwarding the method call to that specific one. RMICallBack are simply set on all of the MultiProcessController inside the composite.

Definition at line 30 of file vtkCompositeMultiProcessController.h.


Member Enumeration Documentation

Enumerator:
CompositeMultiProcessControllerChanged 

Definition at line 120 of file vtkCompositeMultiProcessController.h.


Constructor & Destructor Documentation

vtkCompositeMultiProcessController::vtkCompositeMultiProcessController ( ) [protected]
vtkCompositeMultiProcessController::~vtkCompositeMultiProcessController ( ) [protected]

Member Function Documentation

static vtkCompositeMultiProcessController* vtkCompositeMultiProcessController::New ( ) [static]

Reimplemented from vtkObject.

virtual const char* vtkCompositeMultiProcessController::GetClassName ( ) [virtual]

Reimplemented from vtkMultiProcessController.

static int vtkCompositeMultiProcessController::IsTypeOf ( const char *  type) [static]

Reimplemented from vtkMultiProcessController.

virtual int vtkCompositeMultiProcessController::IsA ( const char *  type) [virtual]

Reimplemented from vtkMultiProcessController.

static vtkCompositeMultiProcessController* vtkCompositeMultiProcessController::SafeDownCast ( vtkObject o) [static]

Reimplemented from vtkMultiProcessController.

void vtkCompositeMultiProcessController::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Reimplemented from vtkMultiProcessController.

int vtkCompositeMultiProcessController::GetActiveControllerID ( )

Return a unique identifier for the given selected controller. This is only used as information to id which client is currently talking to the server. In fact it is used inside vtkPVServerInformation so the client could know what is its unique ID in respect to the server.

int vtkCompositeMultiProcessController::GetNumberOfControllers ( )

Return the number of currently connected controllers.

int vtkCompositeMultiProcessController::GetControllerId ( int  idx)

Return the id of the nth controller.

void vtkCompositeMultiProcessController::SetMasterController ( int  id)

Promote the given controller (ID) to be the next master controller. Making a controller to be the master one, doesn't change anything on the controller itself. It is just a meta-data information that helps client application to build master/slave collaborative mechanism on top

int vtkCompositeMultiProcessController::GetMasterController ( )

Retrun the ID of the designed "Master" controller. That master controller is nothing else than a tag that can only be set on a single controller at a time.

void vtkCompositeMultiProcessController::RegisterController ( vtkMultiProcessController controller)

Append the given controller to the composite set. We focus on vtkSocketController because most of the API method are empty

void vtkCompositeMultiProcessController::UnRegisterController ( vtkMultiProcessController controller)

Remove the given controller to the composite set.

int vtkCompositeMultiProcessController::UnRegisterActiveController ( )

Remove the active controller and return the number of registered controler left.

vtkMultiProcessController* vtkCompositeMultiProcessController::GetActiveController ( )

Provides access to the active controller.

virtual void vtkCompositeMultiProcessController::TriggerRMI2All ( int  remote,
void *  data,
int  length,
int  tag,
bool  sendToActiveToo 
) [virtual]

Allow server to broadcast data to all connected client with our without sending to the active client

virtual void vtkCompositeMultiProcessController::Initialize ( ) [virtual]
virtual void vtkCompositeMultiProcessController::Initialize ( int ,
char ***   
) [inline, virtual]

Definition at line 87 of file vtkCompositeMultiProcessController.h.

virtual void vtkCompositeMultiProcessController::Initialize ( int ,
char ***  ,
int   
) [inline, virtual]

Definition at line 88 of file vtkCompositeMultiProcessController.h.

virtual void vtkCompositeMultiProcessController::Finalize ( void  ) [inline, virtual]

Implements vtkMultiProcessController.

Definition at line 89 of file vtkCompositeMultiProcessController.h.

virtual void vtkCompositeMultiProcessController::Finalize ( int  ) [inline, virtual]

Implements vtkMultiProcessController.

Definition at line 90 of file vtkCompositeMultiProcessController.h.

virtual void vtkCompositeMultiProcessController::SingleMethodExecute ( ) [inline, virtual]

Implements vtkMultiProcessController.

Definition at line 91 of file vtkCompositeMultiProcessController.h.

virtual void vtkCompositeMultiProcessController::MultipleMethodExecute ( ) [inline, virtual]

Implements vtkMultiProcessController.

Definition at line 92 of file vtkCompositeMultiProcessController.h.

virtual void vtkCompositeMultiProcessController::CreateOutputWindow ( ) [inline, virtual]

Implements vtkMultiProcessController.

Definition at line 93 of file vtkCompositeMultiProcessController.h.

virtual vtkCommunicator* vtkCompositeMultiProcessController::GetCommunicator ( ) [virtual]

Reimplemented from vtkMultiProcessController.

virtual unsigned long vtkCompositeMultiProcessController::AddRMICallback ( vtkRMIFunctionType  ,
void *  localArg,
int  tag 
) [virtual]

These methods are a part of the newer API to add multiple rmi callbacks. When the RMI is triggered, all the callbacks are called Adds a new callback for an RMI. Returns the identifier for the callback.

Reimplemented from vtkMultiProcessController.

virtual void vtkCompositeMultiProcessController::RemoveAllRMICallbacks ( int  tag) [virtual]

These methods are a part of the newer API to add multiple rmi callbacks. When the RMI is triggered, all the callbacks are called Removes all callbacks for the tag.

Reimplemented from vtkMultiProcessController.

virtual int vtkCompositeMultiProcessController::RemoveFirstRMI ( int  tag) [inline, virtual]

These methods are a part of the newer API to add multiple rmi callbacks. When the RMI is triggered, all the callbacks are called Removes all callbacks for the tag.

Reimplemented from vtkMultiProcessController.

Definition at line 111 of file vtkCompositeMultiProcessController.h.

virtual bool vtkCompositeMultiProcessController::RemoveRMICallback ( unsigned long  observerTagId) [virtual]

These methods are a part of the newer API to add multiple rmi callbacks. When the RMI is triggered, all the callbacks are called Removes all callbacks for the tag.

Reimplemented from vtkMultiProcessController.


Friends And Related Function Documentation

friend class vtkCompositeInternals [friend]

Definition at line 135 of file vtkCompositeMultiProcessController.h.


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