otbVectorDataIOBase.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * 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
 *
 * 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 otbVectorDataIOBase_h
#define otbVectorDataIOBase_h
 
#include <string>
 
#include "itkLightProcessObject.h"
#include "itkIndent.h"
#include "itkPoint.h"
#include "itkDataObject.h"
 
#include "OTBVectorDataBaseExport.h"
 
namespace otb
{
 
class OTBVectorDataBase_EXPORT VectorDataIOBase : public itk::LightProcessObject
{
public:
  typedef VectorDataIOBase        Self;
  typedef itk::LightProcessObject Superclass;
  typedef itk::SmartPointer<Self> Pointer;
 
  itkTypeMacro(VectorDataIOBase, Superclass);
 
  itkStaticConstMacro(VDimension, unsigned int, 3);
  typedef itk::Vector<double, VDimension> SpacingType;
  typedef itk::Point<double, VDimension>  PointType;
 
  itkSetStringMacro(FileName);
  itkGetStringMacro(FileName);
 
  typedef enum { BigEndian, LittleEndian, OrderNotApplicable } ByteOrder;
 
  itkSetEnumMacro(ByteOrder, ByteOrder);
  itkGetEnumMacro(ByteOrder, ByteOrder);
  void SetByteOrderToBigEndian()
  {
    this->SetByteOrder(BigEndian);
  }
  void SetByteOrderToLittleEndian()
  {
    this->SetByteOrder(LittleEndian);
  }
 
  std::string GetByteOrderAsString(ByteOrder) const;
 
  typedef std::streamoff SizeType;
 
  /*-------- This part of the interfaces deals with reading data ----- */
 
  virtual bool CanReadFile(const char*) const = 0;
 
  virtual bool CanStreamRead() const
  {
    return false;
  }
 
  /*   /\** Read the spacing and dimensions of the VectorData. */
  /*    * Assumes SetFileName has been called with a valid file name. *\/ */
  /*   virtual void ReadVectorDataInformation() = 0; */
 
  virtual void Read(itk::DataObject* data) = 0;
 
  /*-------- This part of the interfaces deals with writing data ----- */
 
  virtual bool CanWriteFile(const char*) const = 0;
 
  virtual bool CanStreamWrite() const
  {
    return false;
  }
 
  /*   /\** Writes the spacing and dimensions of the VectorData. */
  /*    * Assumes SetFileName has been called with a valid file name. *\/ */
  /*   virtual void WriteVectorDataInformation() = 0; */
 
  virtual void Write(const itk::DataObject* data, char** papszOptions = nullptr) = 0;
 
protected:
  VectorDataIOBase();
  ~VectorDataIOBase() override;
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  ByteOrder m_ByteOrder;
 
  bool m_Initialized;
 
  std::string m_FileName;
 
  virtual void Reset(const bool freeDynamic = true);
 
private:
  VectorDataIOBase(const Self&) = delete;
  void operator=(const Self&) = delete;
};
 
} // end namespace otb
 
#endif // otbVectorDataIOBase_h