vtkPVCinemaDatabaseInformation.h

Go to the documentation of this file.

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

  Program:   ParaView
  Module:    vtkPVCinemaDatabaseInformation.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 vtkPVCinemaDatabaseInformation_h
#define vtkPVCinemaDatabaseInformation_h

#include "vtkPVInformation.h"
#include "vtkRemotingCinemaModule.h" // for export macros
#include <map>                       // needed for map
#include <string>                    // needed for string
#include <vector>                    // needed for vector

class VTKREMOTINGCINEMA_EXPORT vtkPVCinemaDatabaseInformation : public vtkPVInformation
{
public:
  static vtkPVCinemaDatabaseInformation* New();
  vtkTypeMacro(vtkPVCinemaDatabaseInformation, vtkPVInformation);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void CopyFromObject(vtkObject*) override;
  void AddInformation(vtkPVInformation*) override;
  void CopyToStream(vtkClientServerStream*) override;
  void CopyFromStream(const vtkClientServerStream*) override;

  typedef std::vector<std::string> VectorOfStrings;
  typedef VectorOfStrings PipelineObjectsType;
  typedef std::map<std::string, VectorOfStrings> ControlParametersType;
  typedef std::map<std::string, VectorOfStrings> PipelineObjectParentsType;
  typedef std::map<std::string, bool> PipelineObjectVisibilitiesType;

  const PipelineObjectsType& GetPipelineObjects() const { return this->PipelineObjects; }

  const ControlParametersType& GetControlParameters() const { return this->ControlParameters; }

  const VectorOfStrings& GetControlParameters(const std::string& parameter) const;

  const VectorOfStrings& GetControlParameterValues(const std::string& parameter) const;

  bool GetPipelineObjectVisibility(const std::string& object) const;

  const PipelineObjectParentsType& GetPipelineObjectParents() const
  {
    return this->PipelineObjectParents;
  }

  const VectorOfStrings& GetPipelineObjectParents(const std::string& object) const;

protected:
  vtkPVCinemaDatabaseInformation();
  ~vtkPVCinemaDatabaseInformation() override;

  void Reset();

  PipelineObjectsType PipelineObjects;
  ControlParametersType ControlParameters;
  ControlParametersType ControlParameterValues;
  PipelineObjectParentsType PipelineObjectParents;
  PipelineObjectVisibilitiesType PipelineObjectVisibilities;

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

#endif