otbOGRFieldWrapper.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 otbOGRFieldWrapper_h
#define otbOGRFieldWrapper_h
 
#include <memory>
#include <string>
 
class OGRFieldDefn;
class OGRFeature;
#if defined(_MSC_VER)
#pragma warning(push)
#pragma warning(disable : 4251)
#include "ogr_core.h" // OGR enums
#pragma warning(pop)
#else
#include "ogr_core.h" // OGR enums
#endif
#include "itkIndent.h"
 
#include "OTBGdalAdaptersExport.h"
 
namespace otb
{
namespace ogr
{
 
/*===========================================================================*/
/*===========================[ Field definition ]============================*/
/*===========================================================================*/
class OTBGdalAdapters_EXPORT FieldDefn
{
public:
  FieldDefn(OGRFieldDefn& definition) : m_Definition(&definition)
  {
  }
  std::string  GetName() const; 
  OGRFieldType GetType() const; 
 
  OGRFieldDefn& ogr()
  {
    return *m_Definition;
  }
  OGRFieldDefn& ogr() const
  {
    return *m_Definition;
  }
 
private:
  OGRFieldDefn* m_Definition;
};
 
inline bool operator==(FieldDefn const& lhs, FieldDefn const& rhs)
{
  return lhs.GetName() == rhs.GetName() && lhs.GetType() == rhs.GetType();
}
 
OTBGdalAdapters_EXPORT std::ostream& operator<<(std::ostream& os, FieldDefn const& defn);
 
/*===========================================================================*/
/*=================================[ Field ]=================================*/
/*===========================================================================*/
class Feature;
 
class OTBGdalAdapters_EXPORT Field
{
public:
 
  Field(Feature& feature, int index);
  FieldDefn const& GetDefinition() const
  {
    return m_Definition;
  }
  OGRFieldType GetType() const
  {
    return m_Definition.GetType();
  }
  std::string GetName() const
  {
    return m_Definition.GetName();
  }
 
  bool HasBeenSet() const;
  void Unset() const;
 
  template <typename T>
  void SetValue(T const& value);
 
  template <typename T>
  T GetValue() const;
 
  std::ostream& PrintSelf(std::ostream& os, itk::Indent indent) const;
 
  void Assign(Field const& f);
 
  OGRField& ogr();
 
  OGRField& ogr() const;
 
private:
  bool          UncheckedHasBeenSet() const;
  void          UncheckedUnset() const;
  std::ostream& UncheckedPrintSelf(std::ostream& os, itk::Indent indent) const;
  void UncheckedAssign(Field const& f);
 
 
  void CheckInvariants() const;
 
  FieldDefn m_Definition;
  std::shared_ptr<OGRFeature>& m_Feature;
  int m_index;
};
}
} // end namespace otb::ogr
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbOGRFieldWrapper.hxx"
#endif
 
#endif // otbOGRFieldWrapper_h