ITK  4.1.0
Insight Segmentation and Registration Toolkit
itkNumericSeriesFileNames.h
Go to the documentation of this file.
00001 /*=========================================================================
00002  *
00003  *  Copyright Insight Software Consortium
00004  *
00005  *  Licensed under the Apache License, Version 2.0 (the "License");
00006  *  you may not use this file except in compliance with the License.
00007  *  You may obtain a copy of the License at
00008  *
00009  *         http://www.apache.org/licenses/LICENSE-2.0.txt
00010  *
00011  *  Unless required by applicable law or agreed to in writing, software
00012  *  distributed under the License is distributed on an "AS IS" BASIS,
00013  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  *  See the License for the specific language governing permissions and
00015  *  limitations under the License.
00016  *
00017  *=========================================================================*/
00018 #ifndef __itkNumericSeriesFileNames_h
00019 #define __itkNumericSeriesFileNames_h
00020 
00021 
00022 #include "itkObject.h"
00023 #include "itkObjectFactory.h"
00024 #include "itkIntTypes.h"
00025 #include "itkMacro.h"
00026 #include <vector>
00027 
00028 namespace itk
00029 {
00053 class ITK_EXPORT NumericSeriesFileNames:public Object
00054 {
00055 public:
00057   typedef NumericSeriesFileNames Self;
00058   typedef Object                 Superclass;
00059   typedef SmartPointer< Self >   Pointer;
00060 
00062   itkNewMacro(Self);
00063 
00065   itkTypeMacro(NumericSeriesFileNames, Object);
00066 
00067   /* -------- Define the API for NumericSeriesFileNames ----------- */
00068 
00071   itkSetMacro(StartIndex, SizeValueType);
00072   itkGetConstMacro(StartIndex, SizeValueType);
00074 
00076   itkSetMacro(EndIndex, SizeValueType);
00077   itkGetConstMacro(EndIndex, SizeValueType);
00079 
00082   itkSetMacro(IncrementIndex, SizeValueType);
00083   itkGetConstMacro(IncrementIndex, SizeValueType);
00085 
00091   itkSetStringMacro(SeriesFormat);
00092   itkGetStringMacro(SeriesFormat);
00094 
00097   const std::vector< std::string > & GetFileNames();
00098 
00099 protected:
00100   NumericSeriesFileNames();
00101   ~NumericSeriesFileNames() {}
00102   void PrintSelf(std::ostream & os, Indent indent) const;
00103 
00104 private:
00105   NumericSeriesFileNames(const Self &); //purposely not implemented
00106   void operator=(const Self &);         //purposely not implemented
00107 
00108   SizeValueType m_StartIndex;
00109   SizeValueType m_EndIndex;
00110   SizeValueType m_IncrementIndex;
00111 
00113   std::string m_SeriesFormat;
00114 
00115   std::vector< std::string > m_FileNames;
00116 };
00117 } //namespace ITK
00118 
00119 #endif // __itkNumericSeriesFileNames_h
00120