itkParameterFileParser.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  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 __itkParameterFileParser_h
#define __itkParameterFileParser_h
 
#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkMacro.h"
 
#include <map>
#include <string>
#include <vector>
 
namespace itk
{
 
class ParameterFileParser : public Object
{
public:
 
  typedef ParameterFileParser        Self;
  typedef Object                     Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;
 
  itkNewMacro( Self );
 
  itkTypeMacro( ParameterFileParser, Object );
 
  typedef std::vector< std::string > ParameterValuesType;
  typedef std::map<
    std::string,
    ParameterValuesType >                 ParameterMapType;
 
  itkSetStringMacro( ParameterFileName );
  itkGetStringMacro( ParameterFileName );
 
  virtual const ParameterMapType & GetParameterMap( void ) const;
 
  void ReadParameterFile( void );
 
  std::string ReturnParameterFileAsString( void );
 
protected:
 
  ParameterFileParser();
  ~ParameterFileParser() override;
 
private:
 
  ParameterFileParser( const Self & ); // purposely not implemented
  void operator=( const Self & );      // purposely not implemented
 
  void BasicFileChecking( void ) const;
 
  bool CheckLine( const std::string & line, std::string & lineOut ) const;
 
  void GetParameterFromLine( const std::string & fullLine,
    const std::string & line );
 
  void SplitLine( const std::string & fullLine, const std::string & line,
    std::vector< std::string > & splittedLine ) const;
 
  void ThrowException( const std::string & line, const std::string & hint ) const;
 
  std::string      m_ParameterFileName;
  ParameterMapType m_ParameterMap;
 
};
 
} // end of namespace itk
 
#endif // end __itkParameterFileParser_h