// =========================================================================
// @author Leonardo Florez Valencia
// @email florez-l@javeriana.edu.co
// =========================================================================
#ifndef __fpa__Filters__Algorithm__h__
#define __fpa__Filters__Algorithm__h__

#include <set>
#include <itkDataObject.h>
#include <fpa/Config.h>
#include <fpa/Filters/Event.h>

namespace fpa
{
  namespace Filters
  {
    /**
     */
    template< class _TTraits >
    class Algorithm
      : public _TTraits::TFilterInterface,
        public _TTraits::TMarksInterface,
        public _TTraits::TSeedsInterface
    {
    public:
      typedef _TTraits TTraits;
      fpaTraitsMacro( typename TTraits );

      typedef typename TTraits::TFilterInterface Superclass;
      typedef Algorithm                          Self;
      typedef itk::SmartPointer< Self >          Pointer;
      typedef itk::SmartPointer< const Self >    ConstPointer;

      typedef fpa::Filters::Event< TVertex > TEvent;

    public:
      itkTypeMacro( fpa::Filters::Algorithm, TTraits::TFilterInterface );

      itkBooleanMacro( VisualDebug );
      itkGetConstMacro( VisualDebug, bool );
      itkSetMacro( VisualDebug, bool );

      itkGetConstMacro( InitValue, TOutputValue );
      itkSetMacro( InitValue, TOutputValue );

    public:
      virtual itk::ModifiedTimeType GetMTime( ) const override;
      virtual void InvokeEvent( const itk::EventObject& e );
      virtual void InvokeEvent( const itk::EventObject& e ) const;

    protected:
      Algorithm( );
      virtual ~Algorithm( );

      // Main algorithm method
      virtual void GenerateData( ) override;

      // Object association
      void _Associate( itk::Object* o );
      void _Deassociate( itk::Object* o );
      void _DeassociateAll( );

      // Pipeline related methods
      virtual void _BeforeGenerateData( );
      virtual void _AfterGenerateData( );

      // Filter related methods
      virtual void _AssignOutputValue( const TNode& n ) = 0;
      virtual void _ConfigureOutputs( ) = 0;
      virtual TInputValue _GetInputValue( const TVertex& v ) const = 0;
      virtual TInputValue _GetInputValue( const TNode& n ) const;
      virtual TOutputValue _GetOutputValue( const TVertex& v ) const = 0;
      virtual TOutputValue _GetOutputValue( const TNode& n ) const;
      virtual TNeighborhood _GetNeighbors( const TVertex& v ) const = 0;
      virtual TNeighborhood _GetNeighbors( const TNode& n ) const;
      virtual const itk::DataObject* _GetReferenceInput( ) const;

      // Marks related methods
      virtual bool _IsMarked( const TVertex& v ) const = 0;
      virtual bool _IsMarked( const TNode& n ) const;
      virtual bool _IsNotMarked( const TVertex& v ) const;
      virtual bool _IsNotMarked( const TNode& n ) const;
      virtual void _Mark( const TNode& n ) = 0;

      // Queue related methods
      virtual void _QueueClear( ) = 0;
      virtual TNode _QueuePop( ) = 0;
      virtual void _QueuePush( const TNode& n ) = 0;
      virtual unsigned long _QueueSize( ) const = 0;

      // Algoritm related methods
      virtual void _PostComputeOutputValue( TNode& n ) = 0;
      virtual void _PreComputeOutputValue( TNode& n ) = 0;
      virtual void _Reinitialize( );

    private:
      Algorithm( const Self& other );
      Self& operator=( const Self& other );

    protected:
      bool m_VisualDebug;
      TOutputValue m_InitValue;
      std::set< itk::Object* > m_AssociatedObjects;
    };

  } // ecapseman

} // ecapseman

#ifndef ITK_MANUAL_INSTANTIATION
#  include <fpa/Filters/Algorithm.hxx>
#endif // ITK_MANUAL_INSTANTIATION
#endif // __fpa__Filters__Algorithm__h__
// eof - $RCSfile$