vtkMRMLUnitNode.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.

  This file was originally developed by Johan Andruejol, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1

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

#ifndef __vtkMRMLUnitNode_h
#define __vtkMRMLUnitNode_h

// MRML includes
#include "vtkMRMLNode.h"

class VTK_MRML_EXPORT vtkMRMLUnitNode : public vtkMRMLNode
{
public:
  static vtkMRMLUnitNode *New();
  vtkTypeMacro(vtkMRMLUnitNode,vtkMRMLNode);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  vtkMRMLNode* CreateNodeInstance() override;

  void ReadXMLAttributes( const char** atts) override;

  void WriteXML(ostream& of, int indent) override;

  void Copy(vtkMRMLNode *node) override;

  const char* GetNodeTagName() override {return "Unit";}

  void Reset(vtkMRMLNode* defaultNode) override;

  const char* GetQuantity();
  void SetQuantity(const char* quantity);

  virtual double GetDisplayValueFromValue(double value);
  virtual double GetValueFromDisplayValue(double value);
  const char* GetDisplayStringFromValue(double value);

  const char* GetDisplayStringFormat();

  void SetName(const char* name) override;

  vtkGetStringMacro(Prefix);
  vtkSetStringMacro(Prefix);

  vtkGetStringMacro(Suffix);
  vtkSetStringMacro(Suffix);

  vtkGetMacro(Precision, int);
  vtkSetClampMacro(Precision, int, 0, VTK_INT_MAX);

  vtkGetMacro(MinimumValue, double);
  vtkSetMacro(MinimumValue, double);

  vtkGetMacro(MaximumValue, double);
  vtkSetMacro(MaximumValue, double);

  vtkGetMacro(DisplayCoefficient, double);
  vtkSetMacro(DisplayCoefficient, double);

  vtkGetMacro(DisplayOffset, double);
  vtkSetMacro(DisplayOffset, double);

protected:
  vtkMRMLUnitNode();
  ~vtkMRMLUnitNode() override;
  vtkMRMLUnitNode(const vtkMRMLUnitNode&);
  void operator=(const vtkMRMLUnitNode&);

  virtual const char* GetDisplayValueStringFromDisplayValue(double displayValue);
  virtual const char* GetDisplayStringFromDisplayValueString(const char* displayValue);
  std::string WrapValueWithPrefix(const std::string& value) const;
  std::string WrapValueWithSuffix(const std::string& value) const;
  std::string WrapValueWithPrefixAndSuffix(const std::string& value) const;

  char* Prefix;
  char* Suffix;
  int Precision;
  double MinimumValue;
  double MaximumValue;

  double DisplayCoefficient;
  double DisplayOffset;

  std::string LastValueString;
  std::string LastDisplayString;
};

#endif