ITK  4.9.0
Insight Segmentation and Registration Toolkit
itkNumericSeriesFileNames.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
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 itkNumericSeriesFileNames_h
19 #define itkNumericSeriesFileNames_h
20 #include "ITKIOImageBaseExport.h"
21 
22 
23 #include "itkObject.h"
24 #include "itkObjectFactory.h"
25 #include "itkIntTypes.h"
26 #include "itkMacro.h"
27 #include <vector>
28 
29 namespace itk
30 {
54 class ITKIOImageBase_EXPORT NumericSeriesFileNames:public Object
55 {
56 public:
59  typedef Object Superclass;
61 
63  itkNewMacro(Self);
64 
66  itkTypeMacro(NumericSeriesFileNames, Object);
67 
68  /* -------- Define the API for NumericSeriesFileNames ----------- */
69 
72  itkSetMacro(StartIndex, SizeValueType);
73  itkGetConstMacro(StartIndex, SizeValueType);
75 
77  itkSetMacro(EndIndex, SizeValueType);
78  itkGetConstMacro(EndIndex, SizeValueType);
80 
83  itkSetMacro(IncrementIndex, SizeValueType);
84  itkGetConstMacro(IncrementIndex, SizeValueType);
86 
92  itkSetStringMacro(SeriesFormat);
93  itkGetStringMacro(SeriesFormat);
95 
98  const std::vector< std::string > & GetFileNames();
99 
100 protected:
103  virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
104 
105 private:
106  NumericSeriesFileNames(const Self &) ITK_DELETE_FUNCTION;
107  void operator=(const Self &) ITK_DELETE_FUNCTION;
108 
109  SizeValueType m_StartIndex;
110  SizeValueType m_EndIndex;
111  SizeValueType m_IncrementIndex;
112 
114  std::string m_SeriesFormat;
115 
116  std::vector< std::string > m_FileNames;
117 };
118 } //namespace ITK
119 
120 #endif // itkNumericSeriesFileNames_h
Light weight base class for most itk classes.
Generate an ordered sequence of filenames.
unsigned long SizeValueType
Definition: itkIntTypes.h:143
Control indentation during Print() invocation.
Definition: itkIndent.h:49
Base class for most ITK classes.
Definition: itkObject.h:57