otbPolyLineParametricPathWithValue.h

/*=========================================================================

Program:   ORFEO Toolbox
Language:  C++
Date:      $Date$
Version:   $Revision$


Copyright (c) Centre National d'Etudes Spatiales. All rights reserved.
See OTBCopyright.txt for details.


This software is distributed WITHOUT ANY WARRANTY; without even 
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __otbPolyLineParametricPathWithValue_h
#define __otbPolyLineParametricPathWithValue_h

#include "itkPolyLineParametricPath.h"
#include "itkMetaDataObject.h"
#include "otbMacro.h"

namespace otb
{
/** \class PolyLineParametricPathWithValue
 *  \brief This class implement a PolyLineParametricPath for which a value can be set.
 * The value is stored in the itk::MetaDataDictionary.
 * The precision of the value can be set.
 * 
 * \sa itk::PolyLineParametricPath.
 */
template < class TValue,unsigned int VDimension=2>
class ITK_EXPORT PolyLineParametricPathWithValue
  : public itk::PolyLineParametricPath<VDimension>
{
 public:
  /** Standard typedefs */
  typedef PolyLineParametricPathWithValue          Self;
  typedef itk::PolyLineParametricPath<VDimension>  Superclass;
  typedef itk::SmartPointer<Self>                  Pointer;
  typedef itk::SmartPointer<const Self>            ConstPointer;
  
  /** Type macro */
  itkNewMacro(Self);
  
  /** Creation through object factory macro */
  itkTypeMacro(PolyLineParametricPath, MySuperclass);
  
  /** Template parameters typedefs */
 typedef TValue ValueType;
 
 /** Derived typedefs */
 typedef typename Superclass::VertexType VertexType;
 typedef typename Superclass::VertexListType VertexListType;
 typedef typename Superclass::ContinuousIndexType ContinuousIndexType;
 typedef typename VertexListType::ConstIterator   VertexListConstIteratorType;
 
 itkGetMacro(Key,std::string);

 void SetValue(ValueType value)
 {
   itk::MetaDataDictionary & dict = this->GetMetaDataDictionary();
   itk::EncapsulateMetaData<ValueType>(dict,m_Key,value);
 }

 ValueType GetValue(void)
 {
   ValueType resp = itk::NumericTraits<ValueType>::Zero;
   itk::MetaDataDictionary & dict = this->GetMetaDataDictionary();
   if(dict.HasKey(m_Key))
   {
     itk::ExposeMetaData<ValueType>(dict,m_Key,resp);
   }
   else
   {
     itkGenericExceptionMacro(<<"Key "<<m_Key<<" not found in metadata dictionary !");
   }
   return resp;
 }
 
 /**
  * Return the path length (perimeter).
  * \return The length.
  */
 virtual double GetLength();

protected:
  /** Constructor */
  PolyLineParametricPathWithValue();
  /** Destructor */
  virtual ~PolyLineParametricPathWithValue() 
 { }
 /**PrintSelf method */
  virtual void PrintSelf(std::ostream& os, itk::Indent indent) const;

 private:
  PolyLineParametricPathWithValue(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
  std::string m_Key;
};
}// End namespace otb

#ifndef OTB_MANUAL_INSTANTIATION
#include "otbPolyLineParametricPathWithValue.txx"
#endif

#endif