vtkSIObject.h

Go to the documentation of this file.

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

  Program:   ParaView
  Module:    vtkSIObject.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 vtkSIObject_h
#define vtkSIObject_h

#include "vtkObject.h"
#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMMessageMinimal.h"            // needed for vtkSMMessage
#include "vtkWeakPointer.h"                 // needed for vtkWeakPointer

class vtkClientServerInterpreter;
class vtkPVSessionCore;

class VTKREMOTINGSERVERMANAGER_EXPORT vtkSIObject : public vtkObject
{
public:
  static vtkSIObject* New();
  vtkTypeMacro(vtkSIObject, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual void AboutToDelete(){};

  virtual void Initialize(vtkPVSessionCore* session);

  virtual void Push(vtkSMMessage* msg);

  virtual void Pull(vtkSMMessage* msg);

  vtkClientServerInterpreter* GetInterpreter();

  vtkSIObject* GetSIObject(vtkTypeUInt32 globalid) const;

  vtkObject* GetRemoteObject(vtkTypeUInt32 globalid);


  vtkSetMacro(GlobalID, vtkTypeUInt32);
  vtkGetMacro(GlobalID, vtkTypeUInt32);

protected:
  vtkSIObject();
  ~vtkSIObject() override;

  vtkWeakPointer<vtkClientServerInterpreter> Interpreter;
  vtkWeakPointer<vtkPVSessionCore> SessionCore;

  vtkSMMessage* LastPushedMessage;

  vtkTypeUInt32 GlobalID;

private:
  vtkSIObject(const vtkSIObject&) = delete;
  void operator=(const vtkSIObject&) = delete;
};

#endif // #ifndef vtkSIObject_h