go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
itkParameterFileParser.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright UMC Utrecht and contributors
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef __itkParameterFileParser_h
19 #define __itkParameterFileParser_h
20 
21 #include "itkObject.h"
22 #include "itkObjectFactory.h"
23 #include "itkMacro.h"
24 
25 #include <map>
26 #include <string>
27 #include <vector>
28 #include <fstream>
29 
30 namespace itk
31 {
32 
79 class ParameterFileParser : public Object
80 {
81 public:
82 
85  typedef Object Superclass;
87  typedef SmartPointer< const Self > ConstPointer;
88 
90  itkNewMacro( Self );
91 
93  itkTypeMacro( ParameterFileParser, Object );
94 
96  typedef std::vector< std::string > ParameterValuesType;
97  typedef std::map<
98  std::string,
100 
102  itkSetStringMacro( ParameterFileName );
103  itkGetStringMacro( ParameterFileName );
104 
106  virtual const ParameterMapType & GetParameterMap( void ) const;
107 
109  void ReadParameterFile( void );
110 
114  std::string ReturnParameterFileAsString( void );
115 
116 protected:
117 
120 
121 private:
122 
123  ParameterFileParser( const Self & ); // purposely not implemented
124  void operator=( const Self & ); // purposely not implemented
125 
132  void BasicFileChecking( void ) const;
133 
139  bool CheckLine( const std::string & line, std::string & lineOut ) const;
140 
142  void GetParameterFromLine( const std::string & fullLine,
143  const std::string & line );
144 
146  void SplitLine( const std::string & fullLine, const std::string & line,
147  std::vector< std::string > & splittedLine ) const;
148 
152  void ThrowException( const std::string & line, const std::string & hint ) const;
153 
155  std::string m_ParameterFileName;
156  std::ifstream m_ParameterFile;
158 
159 };
160 
161 } // end of namespace itk
162 
163 #endif // end __itkParameterFileParser_h
itk::ParameterFileParser
Implements functionality to read a parameter file.
Definition: itkParameterFileParser.h:80
itk::ParameterFileParser::ThrowException
void ThrowException(const std::string &line, const std::string &hint) const
itk::ParameterFileParser::SplitLine
void SplitLine(const std::string &fullLine, const std::string &line, std::vector< std::string > &splittedLine) const
SmartPointer< Self >
itk::ParameterFileParser::ParameterMapType
std::map< std::string, ParameterValuesType > ParameterMapType
Definition: itkParameterFileParser.h:99
itk::ParameterFileParser::~ParameterFileParser
virtual ~ParameterFileParser()
itk::ParameterFileParser::CheckLine
bool CheckLine(const std::string &line, std::string &lineOut) const
itk::ParameterFileParser::ParameterFileParser
ParameterFileParser()
itk::ParameterFileParser::BasicFileChecking
void BasicFileChecking(void) const
itk::ParameterFileParser::ParameterFileParser
ParameterFileParser(const Self &)
itk::ParameterFileParser::GetParameterFromLine
void GetParameterFromLine(const std::string &fullLine, const std::string &line)
itk::ParameterFileParser::Self
ParameterFileParser Self
Definition: itkParameterFileParser.h:84
itk::ParameterFileParser::ParameterValuesType
std::vector< std::string > ParameterValuesType
Definition: itkParameterFileParser.h:93
itk::ParameterFileParser::GetParameterMap
virtual const ParameterMapType & GetParameterMap(void) const
itk::ParameterFileParser::m_ParameterMap
ParameterMapType m_ParameterMap
Definition: itkParameterFileParser.h:157
itk::ParameterFileParser::ConstPointer
SmartPointer< const Self > ConstPointer
Definition: itkParameterFileParser.h:87
itk::ParameterFileParser::m_ParameterFileName
std::string m_ParameterFileName
Definition: itkParameterFileParser.h:155
itk::ParameterFileParser::m_ParameterFile
std::ifstream m_ParameterFile
Definition: itkParameterFileParser.h:156
itk
Definition: itkAdvancedImageToImageMetric.h:40
itk::ParameterFileParser::Superclass
Object Superclass
Definition: itkParameterFileParser.h:85
itk::ParameterFileParser::operator=
void operator=(const Self &)
itk::ParameterFileParser::ReturnParameterFileAsString
std::string ReturnParameterFileAsString(void)
itk::ParameterFileParser::Pointer
SmartPointer< Self > Pointer
Definition: itkParameterFileParser.h:86
itk::ParameterFileParser::ReadParameterFile
void ReadParameterFile(void)


Generated on OURCE_DATE_EPOCH for elastix by doxygen 1.8.18 elastix logo