vtkMRMLIOOptionsDescription.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 __vtkMRMLIOOptionsDescription_h
#define __vtkMRMLIOOptionsDescription_h
 
#include "vtkMRMLLogicExport.h"
 
#include <vtkObject.h>
#include <vtkSmartPointer.h>
#include <vtkVariant.h>
 
#include <string>
#include <vector>
 
class vtkMRMLIOProperties;

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

  void SetProperties(vtkMRMLIOProperties* properties);
  vtkMRMLIOProperties* GetProperties();

  void SetDefaults(vtkMRMLIOProperties* defaults);
  vtkMRMLIOProperties* GetDefaults();

  std::string GetFileName();
  std::vector<std::string> GetFileNames();


  void AddBoolOption(const std::string& property, const std::string& label, const std::string& toolTip, bool defaultValue);
  void AddIntOption(const std::string& property, const std::string& label, const std::string& toolTip, int defaultValue, int minimum, int maximum);
  void AddDoubleOption(const std::string& property, //
                       const std::string& label,
                       const std::string& toolTip,
                       double defaultValue,
                       double minimum,
                       double maximum,
                       int decimals);
  void AddStringOption(const std::string& property, const std::string& label, const std::string& toolTip, const std::string& defaultValue);
  void AddStringListOption(const std::string& property,
                           const std::string& label,
                           const std::string& toolTip,
                           const std::vector<std::string>& defaultValue,
                           const std::string& separator = ";");
  void AddEnumOption(const std::string& property, const std::string& label, const std::string& toolTip, const vtkVariant& defaultValue);
  void AddEnumChoice(const std::string& property, const vtkVariant& value, const std::string& label);
  void AddNodeOption(const std::string& property,
                     const std::string& label,
                     const std::string& toolTip,
                     const std::string& defaultNodeID,
                     const std::vector<std::string>& nodeClasses,
                     bool noneEnabled);


  void SetOptionEnabled(const std::string& property, bool enabled);
  void SetOptionVisible(const std::string& property, bool visible);
  void SetOptionWidget(const std::string& property, const std::string& widget);
  void SetOptionShowHidden(const std::string& property, bool showHidden);

  int GetNumberOfOptions();
  bool HasOption(const std::string& property);
  void RemoveAllOptions();

  vtkVariant GetOptionValue(const std::string& property);
  bool GetBoolOptionValue(const std::string& property, bool defaultValue = false);

  void GetOptionValues(vtkMRMLIOProperties* values);

  int GetOptionIndex(const std::string& property);


  std::string GetNthOptionProperty(int index);
  std::string GetNthOptionType(int index);
  std::string GetNthOptionLabel(int index);
  std::string GetNthOptionToolTip(int index);
  std::string GetNthOptionWidget(int index);
  bool GetNthOptionEnabled(int index);
  bool GetNthOptionVisible(int index);
  vtkVariant GetNthOptionValue(int index);
  std::vector<std::string> GetNthOptionStringListValue(int index);
  std::string GetNthOptionSeparator(int index);
  bool GetNthOptionHasRange(int index);
  double GetNthOptionMinimum(int index);
  double GetNthOptionMaximum(int index);
  int GetNthOptionDecimals(int index);
  int GetNthOptionNumberOfChoices(int index);
  vtkVariant GetNthOptionChoiceValue(int index, int choiceIndex);
  std::string GetNthOptionChoiceLabel(int index, int choiceIndex);
  std::vector<std::string> GetNthOptionNodeClasses(int index);
  bool GetNthOptionNoneEnabled(int index);
  bool GetNthOptionShowHidden(int index);

  std::string ToJSON();
 
protected:
  vtkMRMLIOOptionsDescription();
  ~vtkMRMLIOOptionsDescription() override;
 
private:
  vtkMRMLIOOptionsDescription(const vtkMRMLIOOptionsDescription&) = delete;
  void operator=(const vtkMRMLIOOptionsDescription&) = delete;
 
  class vtkInternal;
  vtkInternal* Internal;
};
 
#endif