vtkPlusParameters.h

Go to the documentation of this file.

/*=Plus=header=begin======================================================
Program: Plus
Copyright (c) Laboratory for Percutaneous Surgery. All rights reserved.
See License.txt for details.
=========================================================Plus=header=end*/

#ifndef __vtkPlusParameters_h
#define __vtkPlusParameters_h

#include "vtkPlusDataCollectionExport.h"

#include <string>
#include <map>

class vtkPlusDataCollectionExport vtkPlusParameters : public vtkObject
{
protected:
  class ParameterInfo
  {
  public:
    ParameterInfo() : Value(""), Set(false), Pending(false) {};
    ParameterInfo(std::string defaultValue) : Value(defaultValue), Set(false), Pending(false) {};

    std::string Value;
    bool Set;
    bool Pending;
  };
  typedef std::map<std::string, ParameterInfo> ParameterMap;
  typedef ParameterMap::iterator ParameterMapIterator;
  typedef ParameterMap::const_iterator ParameterMapConstIterator;

  ParameterMapConstIterator begin() const;
  ParameterMapConstIterator end() const;

  public:
    static const char* XML_ELEMENT_TAG;
    static const char* PARAMETER_TAG;
    static const char* NAME_TAG;
    static const char* VALUE_TAG;

public:
  static vtkPlusParameters* New();
  vtkTypeMacro(vtkPlusParameters, vtkObject);

  virtual PlusStatus ReadConfiguration(vtkXMLDataElement* deviceConfig);

  virtual PlusStatus WriteConfiguration(vtkXMLDataElement* deviceConfig);

  virtual PlusStatus DeepCopy(const vtkPlusParameters& otherParameters);

  template<typename T> PlusStatus GetValue(const std::string& paramName, T& outputValue) const
  {
    ParameterMapConstIterator keyIt = this->Parameters.find(paramName);
    if (keyIt != this->Parameters.end() && keyIt->second.Set == false)
    {
      return PLUS_FAIL;
    }
    else if (keyIt == this->Parameters.end())
    {
      return PLUS_FAIL;
    }

    std::stringstream ss;
    ParameterMapConstIterator it = this->Parameters.find(paramName);
    ss.str(it->second.Value);
    ss >> outputValue;
    return PLUS_SUCCESS;
  }

  template<typename T> PlusStatus SetValue(const std::string& paramName, T aValue)
  {
    std::stringstream ss;
    ss << aValue;
    if (this->Parameters[paramName].Value != ss.str())
    {
      this->Parameters[paramName].Pending = true;
    }
    this->Parameters[paramName].Value = ss.str();
    this->Parameters[paramName].Set = true;
    return PLUS_SUCCESS;
  };
  bool IsSet(const std::string& paramName) const;
  bool IsPending(const std::string& paramName) const;
  PlusStatus SetPending(const std::string& paramName, bool pending);

  virtual void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

protected:
  vtkPlusParameters();
  virtual ~vtkPlusParameters();

  virtual const char* GetXMLElementName() { return vtkPlusParameters::XML_ELEMENT_TAG; };

  ParameterMap Parameters;
};

#endif