itkCSVFileReaderBase.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkCSVFileReaderBase_h
#define itkCSVFileReaderBase_h
 
#include "itkLightProcessObject.h"
#include <limits>
#include "itkMacro.h"
#include "itkSize.h"
#include <fstream>
#include "ITKIOCSVExport.h"
 
namespace itk
{
 
class ITKIOCSV_EXPORT CSVFileReaderBase : public LightProcessObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(CSVFileReaderBase);

  using Self = CSVFileReaderBase;
  using Superclass = LightProcessObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(CSVFileReaderBase);

  itkSetStringMacro(FileName);

  itkSetMacro(FieldDelimiterCharacter, char);

  itkGetMacro(FieldDelimiterCharacter, char);

  itkSetMacro(UseStringDelimiterCharacter, bool);

  itkGetConstMacro(UseStringDelimiterCharacter, bool);

  itkSetMacro(StringDelimiterCharacter, char);

  itkGetMacro(StringDelimiterCharacter, char);

  itkSetMacro(HasRowHeaders, bool);

  itkGetConstMacro(HasRowHeaders, bool);

  itkSetMacro(HasColumnHeaders, bool);

  itkGetConstMacro(HasColumnHeaders, bool);

  itkBooleanMacro(HasRowHeaders);
  itkBooleanMacro(HasColumnHeaders);
  itkBooleanMacro(UseStringDelimiterCharacter);

  void
  GetDataDimension(SizeValueType & rows, SizeValueType & cols);

  void
  GetNextField(std::string &);

  template <typename TData>
  TData
  ConvertStringToValueType(const std::string & str)
  {
    TData              value;
    std::istringstream isstream(str);
 
    if ((isstream >> value).fail() || !(isstream >> std::ws).eof())
    {
      return std::numeric_limits<TData>::quiet_NaN();
    }
 
    return value;
  }

  virtual void
  Parse() = 0;
 
protected:
  std::string   m_FileName{};
  char          m_FieldDelimiterCharacter{};
  char          m_StringDelimiterCharacter{};
  bool          m_UseStringDelimiterCharacter{};
  bool          m_HasRowHeaders{};
  bool          m_HasColumnHeaders{};
  std::ifstream m_InputStream{};
  int           m_EndOfColumnHeadersLine{};
  std::string   m_Line{};
 
  CSVFileReaderBase();
  ~CSVFileReaderBase() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  PrepareForParsing();
};
 
} // end namespace itk
 
#endif