vtkSIProxy.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSIProxy_h
#define vtkSIProxy_h

#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSIObject.h"
#include "vtkSmartPointer.h" // needed for vtkSmartPointer.

class vtkAlgorithmOutput;
class vtkSIProperty;
class vtkPVXMLElement;
class vtkSIProxyDefinitionManager;

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

  void AboutToDelete() override;

  void Push(vtkSMMessage* msg) override;

  void Pull(vtkSMMessage* msg) override;


  vtkObjectBase* GetVTKObject();
  void SetVTKObject(vtkObjectBase*);

  vtkSIProperty* GetSIProperty(const char* name);


  vtkGetStringMacro(VTKClassName);


  vtkGetStringMacro(XMLName);


  vtkGetStringMacro(XMLGroup);

  bool IsNullProxy() { return (VTKClassName == nullptr); };


  virtual void AddInput(int input_port, vtkAlgorithmOutput* connection, const char* method);
  virtual void CleanInputs(const char* method);

  virtual void UpdatePipelineInformation() {}

  virtual void RecreateVTKObjects();

  virtual bool ExtendDefinition(const char* xml);

  const char* GetLogNameOrDefault();

protected:
  vtkSIProxy();
  ~vtkSIProxy() override;

  virtual vtkObjectBase* NewVTKObject(const char* className);

  vtkSIProxy* GetSubSIProxy(const char* name);


  unsigned int GetNumberOfSubSIProxys();
  vtkSIProxy* GetSubSIProxy(unsigned int cc);

  vtkSIProxyDefinitionManager* GetProxyDefinitionManager();

  virtual bool CreateVTKObjects();

  virtual void DeleteVTKObjects();

  virtual void OnCreateVTKObjects();

  bool InitializeAndCreateVTKObjects(vtkSMMessage* message);


  virtual bool ReadXMLAttributes(vtkPVXMLElement* element);
  virtual bool ReadXMLProperty(vtkPVXMLElement* property_element);
  virtual bool ReadXMLSubProxy(vtkPVXMLElement* subproxy_element);

  void AddSIProperty(const char* name, vtkSIProperty*);

  vtkSetStringMacro(VTKClassName);
  vtkSetStringMacro(XMLGroup);
  vtkSetStringMacro(XMLName);
  vtkSetStringMacro(XMLSubProxyName);
  vtkSetStringMacro(PostPush);
  vtkSetStringMacro(PostCreation);
  vtkGetStringMacro(LogName);

  void SetLogName(const char* name);

  char* VTKClassName;
  char* XMLGroup;
  char* XMLName;
  char* XMLSubProxyName;
  char* PostPush;
  char* PostCreation;
  int NumberOfInputPorts;

  vtkSmartPointer<vtkObjectBase> VTKObject;
  bool ObjectsCreated;

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

  class vtkInternals;
  vtkInternals* Internals;

  char* LogName;
  std::string DefaultLogName;
};

#endif