vtkSIProperty.h

Go to the documentation of this file.

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

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

class vtkClientServerStream;
class vtkSIObject;
class vtkSIProxy;
class vtkPVXMLElement;

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


  vtkGetStringMacro(XMLName);


  vtkGetStringMacro(Command);


  vtkGetMacro(InformationOnly, bool);


  vtkGetMacro(Repeatable, bool);


  vtkSetMacro(IsInternal, bool);
  vtkGetMacro(IsInternal, bool);

protected:
  vtkSIProperty();
  ~vtkSIProperty() override;

  friend class vtkSIProxy;

  vtkSIObject* GetSIObject(vtkTypeUInt32 globalid);

  virtual bool Push(vtkSMMessage*, int);

  virtual bool Pull(vtkSMMessage*);

  virtual bool ReadXMLAttributes(vtkSIProxy* proxyhelper, vtkPVXMLElement* element);


  bool ProcessMessage(vtkClientServerStream& stream);
  const vtkClientServerStream& GetLastResult();
  vtkObjectBase* GetVTKObject();

  vtkSetStringMacro(Command);
  vtkSetStringMacro(XMLName);

  char* XMLName;
  char* Command;
  bool InformationOnly;
  bool Repeatable;
  bool IsInternal;

  vtkWeakPointer<vtkSIProxy> SIProxyObject;

  // Allow subclass to save the property value as a state part
  void SaveValueToCache(vtkSMMessage* proxyStateUpdate, int offset);

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

  class vtkInternals;
  vtkInternals* Internals;
};

#endif