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

  Program:   ParaView
  Module:    vtkSMStateVersionController.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.

=========================================================================*/
// .NAME vtkSMStateVersionController
// .SECTION Description
// vtkSMStateVersionController is used to convert the state XML from any
// previously supported versions to the current version.

#ifndef __vtkSMStateVersionController_h
#define __vtkSMStateVersionController_h

#include "vtkPVServerManagerCoreModule.h" //needed for exports
#include "vtkSMStateVersionControllerBase.h"

class VTKPVSERVERMANAGERCORE_EXPORT vtkSMStateVersionController : public vtkSMStateVersionControllerBase
{
public:
  static vtkSMStateVersionController* New();
  vtkTypeMacro(vtkSMStateVersionController, vtkSMStateVersionControllerBase);
  void PrintSelf(ostream& os, vtkIndent indent);

  // Description:
  // Called before a state is loaded.
  // The argument must be the root element for the state being loaded.
  // eg. for server manager state, it will point to <ServerManagerState />
  // element.
  // Returns false if the conversion failed, else true.
  virtual bool Process(vtkPVXMLElement* root);

  bool Process_3_0_To_3_2(vtkPVXMLElement* root);
  bool Process_3_2_To_3_4(vtkPVXMLElement* root);
  bool Process_3_4_to_3_6(vtkPVXMLElement* root);
  bool Process_3_6_to_3_8(vtkPVXMLElement* root);
  bool Process_3_8_to_3_10(vtkPVXMLElement* root);
  bool Process_3_10_to_3_12(vtkPVXMLElement* root);
  bool Process_3_12_to_3_14(vtkPVXMLElement* root, vtkPVXMLElement* parent);
  bool Process_3_14_to_4_0(vtkPVXMLElement* root);
  bool Process_4_0_to_next(vtkPVXMLElement* root);

//BTX
  bool ConvertViewModulesToViews(vtkPVXMLElement* parent);
  bool ConvertLegacyReader(vtkPVXMLElement* parent);
  bool ConvertStreamTracer(vtkPVXMLElement* parent);
  bool ConvertExodusIIReader(vtkPVXMLElement* parent);
  bool ConvertPVAnimationSceneToAnimationScene(vtkPVXMLElement* parent);
  bool ConvertRepresentationProperty(vtkPVXMLElement* element);
  bool ConvertCTHPartProperties(vtkPVXMLElement* element);
protected:
  vtkSMStateVersionController();
  ~vtkSMStateVersionController();

  vtkPVXMLElement* ConvertMultiViewLayout(vtkPVXMLElement* xml);

private:
  vtkSMStateVersionController(const vtkSMStateVersionController&); // Not implemented
  void operator=(const vtkSMStateVersionController&); // Not implemented
//ETX
};

#endif

