otbObjectList.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2020 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 otbObjectList_hxx
#define otbObjectList_hxx

#include "otbObjectList.h"
#include "itkMacro.h"

namespace otb
{
template <class TObject>
ObjectList<TObject>::ObjectList()
{
}

template <class TObject>
void ObjectList<TObject>::Reserve(InternalContainerSizeType size)
{
  m_InternalContainer.reserve(size);
}

template <class TObject>
typename ObjectList<TObject>::InternalContainerSizeType ObjectList<TObject>::Capacity(void) const
{
  return m_InternalContainer.capacity();
}

template <class TObject>
typename ObjectList<TObject>::InternalContainerSizeType ObjectList<TObject>::Size(void) const
{
  return m_InternalContainer.size();
}

template <class TObject>
void ObjectList<TObject>::Resize(InternalContainerSizeType size)
{
  m_InternalContainer.resize(size);
}

template <class TObject>
void ObjectList<TObject>::PushBack(ObjectType* element)
{
  m_InternalContainer.push_back(element);
  this->Modified();
}

template <class TObject>
void ObjectList<TObject>::PopBack(void)
{
  if (m_InternalContainer.size() > 0)
  {
    m_InternalContainer.pop_back();
    this->Modified();
  }
}

template <class TObject>
void ObjectList<TObject>::SetNthElement(unsigned int index, ObjectPointerType element)
{
  if (index >= m_InternalContainer.size())
  {
    itkExceptionMacro(<< "Impossible to SetNthElement with the index element " << index << "; this element don't exist, the size of the list is "
                      << m_InternalContainer.size() << ".");
  }
  m_InternalContainer[index] = element;
  this->Modified();
}

template <class TObject>
void ObjectList<TObject>::SetNthElement(unsigned int index, const ObjectType* element)
{
  if (index >= m_InternalContainer.size())
  {
    itkExceptionMacro(<< "Impossible to SetNthElement with the index element " << index << "; this element don't exist, the size of the list is "
                      << m_InternalContainer.size() << ".");
  }
  m_InternalContainer[index] = const_cast<ObjectType*>(element);
  this->Modified();
}

template <class TObject>
typename ObjectList<TObject>::ObjectPointerType ObjectList<TObject>::GetNthElement(unsigned int index) const
{
  if (index >= m_InternalContainer.size())
  {
    itkExceptionMacro(<< "Impossible to GetNthElement with the index element " << index << "; this element don't exist, the size of the list is "
                      << m_InternalContainer.size() << ".");
  }
  return m_InternalContainer[index];
}

template <class TObject>
typename ObjectList<TObject>::Superclass* ObjectList<TObject>::GetNthDataObject(unsigned int index) const
{

  return dynamic_cast<itk::DataObject*>(GetNthElement(index).GetPointer());
}

template <class TObject>
typename ObjectList<TObject>::ObjectPointerType ObjectList<TObject>::Front(void)
{
  return m_InternalContainer.front();
}
template <class TObject>
typename ObjectList<TObject>::ObjectPointerType ObjectList<TObject>::Back(void)
{
  return m_InternalContainer.back();
}

template <class TObject>
void ObjectList<TObject>::Erase(unsigned int index)
{
  if (index >= m_InternalContainer.size())
  {
    itkExceptionMacro(<< "Impossible to erase the index element " << index << "; the size of the list is " << m_InternalContainer.size() << ".");
  }
  m_InternalContainer.erase(m_InternalContainer.begin() + index);
  this->Modified();
}

template <class TObject>
void ObjectList<TObject>::Clear(void)
{
  m_InternalContainer.clear();
  this->Modified();
}

template <class TObject>
typename ObjectList<TObject>::Iterator ObjectList<TObject>::Insert(Iterator position, ObjectPointerType element)
{
  Iterator iter(m_InternalContainer.insert(position.GetIter(), element));
  this->Modified();
  return iter;
}

template <class TObject>
typename ObjectList<TObject>::ReverseIterator ObjectList<TObject>::Insert(ReverseIterator position, ObjectPointerType element)
{
  ReverseIterator iter((typename InternalContainerType::reverse_iterator)(m_InternalContainer.insert(position.GetIter().base(), element)));
  this->Modified();
  return iter;
}

template <class TObject>
typename ObjectList<TObject>::Iterator ObjectList<TObject>::Begin(void)
{
  Iterator iter(m_InternalContainer.begin());
  return iter;
}

template <class TObject>
typename ObjectList<TObject>::ConstIterator ObjectList<TObject>::Begin(void) const
{
  ConstIterator iter(m_InternalContainer.begin());
  return iter;
}

template <class TObject>
typename ObjectList<TObject>::ReverseIterator ObjectList<TObject>::ReverseBegin(void)
{
  ReverseIterator iter(m_InternalContainer.rbegin());
  return iter;
}

template <class TObject>
typename ObjectList<TObject>::ReverseConstIterator ObjectList<TObject>::ReverseBegin(void) const
{
  ReverseConstIterator iter(m_InternalContainer.rbegin());
  return iter;
}

template <class TObject>
typename ObjectList<TObject>::Iterator ObjectList<TObject>::End(void)
{
  Iterator iter(m_InternalContainer.end());
  return iter;
}

template <class TObject>
typename ObjectList<TObject>::ConstIterator ObjectList<TObject>::End(void) const
{
  ConstIterator iter(m_InternalContainer.end());
  return iter;
}

template <class TObject>
typename ObjectList<TObject>::ReverseIterator ObjectList<TObject>::ReverseEnd(void)
{
  ReverseIterator iter(m_InternalContainer.rend());
  return iter;
}

template <class TObject>
typename ObjectList<TObject>::ReverseConstIterator ObjectList<TObject>::ReverseEnd(void) const
{
  ReverseConstIterator iter(m_InternalContainer.rend());
  return iter;
}

template <class TObject>
void ObjectList<TObject>::Erase(Iterator begin, Iterator end)
{
  m_InternalContainer.erase(begin.GetIter(), end.GetIter());
  this->Modified();
}

template <class TObject>
void ObjectList<TObject>::Erase(Iterator loc)
{
  m_InternalContainer.erase(loc.GetIter());
  this->Modified();
}

template <class TObject>
void ObjectList<TObject>::PrintSelf(std::ostream& os, itk::Indent indent) const
{
  Superclass::PrintSelf(os, indent);
  os << indent << "Size: " << m_InternalContainer.size() << std::endl;
  os << indent << "List contains : " << std::endl;
  ConstIterator iter = this->Begin();
  while (iter != this->End())
  {
    os << indent.GetNextIndent() << iter.Get().GetPointer() << std::endl;
    os << indent.GetNextIndent() << iter.Get() << std::endl;
    //                iter.Get()->PrintSelf(os, indent.GetNextIndent());
    //                iter.Get()->Print(os, indent.GetNextIndent());
    ++iter;
  }
}
} // end namespace otb

#endif