vtkCompositeMultiProcessController.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ParaView
  Module:    vtkCompositeMultiProcessController.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkCompositeMultiProcessController_h
#define vtkCompositeMultiProcessController_h

#include "vtkMultiProcessController.h"
#include "vtkRemotingCoreModule.h" // needed for export macro

class VTKREMOTINGCORE_EXPORT vtkCompositeMultiProcessController : public vtkMultiProcessController
{
public:
  static vtkCompositeMultiProcessController* New();
  vtkTypeMacro(vtkCompositeMultiProcessController, vtkMultiProcessController);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  //  --------------------- Composite API -------------------------------

  int GetActiveControllerID();

  int GetNumberOfControllers();

  int GetControllerId(int idx);

  vtkMultiProcessController* GetController(int idx);

  void SetMasterController(int id);

  int GetMasterController();

  void RegisterController(vtkMultiProcessController* controller);

  void UnRegisterController(vtkMultiProcessController* controller);

  int UnRegisterActiveController();

  vtkMultiProcessController* GetActiveController();

  virtual void TriggerRMI2All(int remote, void* data, int length, int tag, bool sendToActiveToo);

  //  --------------- vtkMultiProcessController API ----------------------
  // Make sure inner vtkSocketController are initialized
  virtual void Initialize();
  void Initialize(int*, char***) override { this->Initialize(); };
  void Initialize(int*, char***, int) override { this->Initialize(); };
  void Finalize() override{};              // Empty: Same as vtkSocketController
  void Finalize(int) override{};           // Empty: Same as vtkSocketController
  void SingleMethodExecute() override{};   // Empty: Same as vtkSocketController
  void MultipleMethodExecute() override{}; // Empty: Same as vtkSocketController
  void CreateOutputWindow() override{};    // Empty: Same as vtkSocketController

  vtkCommunicator* GetCommunicator() override;

  //  --------------- RMIs Overloaded API -------------------

  unsigned long AddRMICallback(vtkRMIFunctionType, void* localArg, int tag) override;


  void RemoveAllRMICallbacks(int tag) override;
  int RemoveFirstRMI(int tag) override
  {
    vtkWarningMacro("RemoveRMICallbacks will remove all...");
    this->RemoveAllRMICallbacks(tag);
    return 1;
  }
  bool RemoveRMICallback(unsigned long observerTagId) override;

  enum EventId
  {
    CompositeMultiProcessControllerChanged = 2345
  };

protected:
  vtkCompositeMultiProcessController();
  ~vtkCompositeMultiProcessController() override;

private:
  vtkCompositeMultiProcessController(const vtkCompositeMultiProcessController&) = delete;
  void operator=(const vtkCompositeMultiProcessController&) = delete;

  class vtkCompositeInternals;
  vtkCompositeInternals* Internal;
  friend class vtkCompositeInternals;
};

#endif