vtkMRMLIOProperties.h

Go to the documentation of this file.

/*==============================================================================
 
  Program: 3D Slicer
 
  Copyright (c) Kitware Inc.
 
  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.
 
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
 
==============================================================================*/
 
#ifndef __vtkMRMLIOProperties_h
#define __vtkMRMLIOProperties_h
 
#include "vtkMRMLLogicExport.h"
 
#include <vtkObject.h>
#include <vtkVariant.h>
 
#include <map>
#include <string>
#include <vector>
 
class vtkVariantArray;

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

  void SetProperty(const std::string& name, const vtkVariant& value);
  void SetStringProperty(const std::string& name, const std::string& value);
  void SetIntProperty(const std::string& name, int value);
  void SetDoubleProperty(const std::string& name, double value);
  void SetBoolProperty(const std::string& name, bool value);

  void SetStringListProperty(const std::string& name, const std::vector<std::string>& values);

  void SetListProperty(const std::string& name, vtkVariantArray* values);

  void SetMapProperty(const std::string& name, vtkMRMLIOProperties* values);

  void SetObjectProperty(const std::string& name, vtkObject* value);

  vtkVariant GetProperty(const std::string& name) const;
  std::string GetStringProperty(const std::string& name, const std::string& defaultValue = "") const;
  int GetIntProperty(const std::string& name, int defaultValue = 0) const;
  double GetDoubleProperty(const std::string& name, double defaultValue = 0.0) const;
  bool GetBoolProperty(const std::string& name, bool defaultValue = false) const;
  std::vector<std::string> GetStringListProperty(const std::string& name) const;
  bool GetListProperty(const std::string& name, vtkVariantArray* values) const;
  vtkMRMLIOProperties* GetMapProperty(const std::string& name) const;
  vtkObject* GetObjectProperty(const std::string& name) const;

  bool IsBoolProperty(const std::string& name) const;
  bool IsStringListProperty(const std::string& name) const;
  bool IsListProperty(const std::string& name) const;
  bool IsMapProperty(const std::string& name) const;
  bool IsObjectProperty(const std::string& name) const;
 
  bool HasProperty(const std::string& name) const;
  void RemoveProperty(const std::string& name);
  void RemoveAllProperties();

  std::vector<std::string> GetPropertyNames() const;

  void Copy(vtkMRMLIOProperties* source);

  void Update(vtkMRMLIOProperties* source);
 
protected:
  vtkMRMLIOProperties();
  ~vtkMRMLIOProperties() override;
 
private:
  vtkMRMLIOProperties(const vtkMRMLIOProperties&) = delete;
  void operator=(const vtkMRMLIOProperties&) = delete;
 
  std::map<std::string, vtkVariant> Properties;
  std::vector<std::string> Order;
  std::vector<std::string> BoolProperties;
};
 
#endif