vtkSMStateLoader.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMStateLoader_h
#define vtkSMStateLoader_h
 
#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMDeserializerXML.h"
 
#include <map>    // needed for API
#include <string> // needed for API
 
class vtkPVXMLElement;
class vtkSMProxy;
class vtkSMProxyLocator;
 
struct vtkSMStateLoaderInternals;
 
class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMStateLoader : public vtkSMDeserializerXML
{
public:
  static vtkSMStateLoader* New();
  vtkTypeMacro(vtkSMStateLoader, vtkSMDeserializerXML);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  int LoadState(vtkPVXMLElement* rootElement, bool keepOriginalId = false);
 
 
  void SetProxyLocator(vtkSMProxyLocator* loc);
  vtkGetObjectMacro(ProxyLocator, vtkSMProxyLocator);
 
 
  vtkSetMacro(KeepIdMapping, int);
  vtkGetMacro(KeepIdMapping, int);
  vtkBooleanMacro(KeepIdMapping, int);
 
 
  vtkTypeUInt32* GetMappingArray(int& size);
 
protected:
  vtkSMStateLoader();
  ~vtkSMStateLoader() override;
 
  virtual int LoadStateInternal(vtkPVXMLElement* rootElement);
 
  void CreatedNewProxy(vtkTypeUInt32 id, vtkSMProxy* proxy) override;
 
  vtkSMProxy* CreateProxy(
    const char* xmlgroup, const char* xmlname, const char* subProxyName = nullptr) override;
 
  virtual int HandleProxyCollection(vtkPVXMLElement* collectionElement);
  virtual void HandleCustomProxyDefinitions(vtkPVXMLElement* element);
  int HandleLinks(vtkPVXMLElement* linksElement);
  virtual int BuildProxyCollectionInformation(vtkPVXMLElement*);
 
 
  virtual void RegisterProxy(vtkTypeUInt32 id, vtkSMProxy* proxy);
  virtual void RegisterProxyInternal(const char* group, const char* name, vtkSMProxy* proxy);
 
  virtual bool UpdateRegistrationInfo(std::string& group, std::string& name, vtkSMProxy* proxy);
 
  vtkPVXMLElement* LocateProxyElement(vtkTypeUInt32 id) override;
 
  vtkPVXMLElement* LocateProxyElementInternal(vtkPVXMLElement* root, vtkTypeUInt32 id);
 
  virtual bool VerifyXMLVersion(vtkPVXMLElement* rootElement);
 
  vtkSMProxy* LocateExistingProxyUsingRegistrationName(vtkTypeUInt32 id);
 
  vtkPVXMLElement* ServerManagerStateElement;
  vtkSMProxyLocator* ProxyLocator;
  int KeepIdMapping;
 
private:
  vtkSMStateLoader(const vtkSMStateLoader&) = delete;
  void operator=(const vtkSMStateLoader&) = delete;
 
  vtkSMStateLoaderInternals* Internal;
};
 
#endif