itkArchetypeSeriesFileNames.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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 itkArchetypeSeriesFileNames_h
#define itkArchetypeSeriesFileNames_h
#include "ITKIOImageBaseExport.h"


#include "itkObject.h"
#include "itkObjectFactory.h"
#include <vector>
#include <string>

namespace itk
{
class ITKIOImageBase_EXPORT ArchetypeSeriesFileNames:public Object
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(ArchetypeSeriesFileNames);

  using Self = ArchetypeSeriesFileNames;
  using Superclass = Object;
  using Pointer = SmartPointer< Self >;

  itkNewMacro(Self);

  itkTypeMacro(ArchetypeSeriesFileNames, Object);

  /* -------- Define the API for ArchetypeSeriesFileNames ----------- */

  // The archetypical filename from which to generate the regular
  // expressions
  void SetArchetype(const std::string & archetype);

  itkGetStringMacro(Archetype);

  using VectorSizeType = size_t;

  VectorSizeType GetNumberOfGroupings();

  using IntVectorType = std::vector< int >;
  using StringVectorType = std::vector< std::string >;

  const StringVectorType & GetFileNames(VectorSizeType group = 0);

protected:
  ArchetypeSeriesFileNames();
  ~ArchetypeSeriesFileNames() override = default;
  void PrintSelf(std::ostream & os, Indent indent) const override;

  void Scan();

private:
  std::string m_Archetype;

  std::vector< StringVectorType > m_Groupings;
  StringVectorType                m_FileNames; // ivar for returning by
                                               // reference

  TimeStamp m_ArchetypeMTime;
  TimeStamp m_ScanTime;
};
} //namespace ITK

#endif // itkArchetypeSeriesFileNames_h