lib/cpPlugins/ProcessObject.h

   1 #ifndef __CPPLUGINS__PROCESSOBJECT__H__
   2 #define __CPPLUGINS__PROCESSOBJECT__H__
   3
   4 #include <map>
   5 #include <set>
   6 #include <cpPlugins/Object.h>
   7 #include <cpPlugins/Parameters.h>
   8 #include <cpPlugins/Port.h>
   9
  10 namespace cpPlugins
  11 {
  12   /**
  13    */
  14   class cpPlugins_EXPORT ProcessObject
  15     : public Object
  16   {
  17   public:
  18     typedef ProcessObject                   Self;
  19     typedef Object                          Superclass;
  20     typedef itk::SmartPointer< Self >       Pointer;
  21     typedef itk::SmartPointer< const Self > ConstPointer;
  22
  23   public:
  24     itkTypeMacro( ProcessObject, Object );
  25     cpPlugins_Id_Macro( ProcessObject, Object );
  26
  27     itkBooleanMacro( PrintExecution );
  28     itkGetConstMacro( LastExecutionSpan, long );
  29     itkGetConstMacro( PrintExecution, bool );
  30     itkSetMacro( PrintExecution, bool );
  31     itkSetObjectMacro( PrintExecutionStream, std::ofstream );
  32
  33   public:
  34     Parameters* GetParameters( );
  35     const Parameters* GetParameters( ) const;
  36
  37     virtual void SetITK( itk::LightObject* o ) final;
  38     virtual void SetVTK( vtkObjectBase* o ) final;
  39
  40     // IO management
  41     std::set< std::string > GetInputsNames( ) const;
  42     std::set< std::string > GetOutputsNames( ) const;
  43     unsigned int GetNumberOfInputs( ) const;
  44     unsigned int GetNumberOfOutputs( ) const;
  45
  46     OutputPort& GetOutputPort( const std::string& id );
  47     const OutputPort& GetOutputPort( const std::string& id ) const;
  48
  49     DataObject* GetInput( const std::string& id );
  50     const DataObject* GetInput( const std::string& id ) const;
  51
  52     template< class _TType = DataObject >
  53       inline _TType* GetOutput( const std::string& id );
  54
  55     template< class _TType = DataObject >
  56       inline const _TType* GetOutput( const std::string& id ) const;
  57
  58     template< class _TType >
  59       inline _TType* GetInputData( const std::string& name );
  60
  61     template< class _TType >
  62       inline _TType* GetOutputData( const std::string& name );
  63
  64     bool SetInputPort( const std::string& id, const OutputPort& port );
  65
  66     void DisconnectInputs( );
  67     void DisconnectOutputs( );
  68     void Disconnect( );
  69
  70     // Pipeline execution
  71     virtual void Modified( ) const ITK_OVERRIDE;
  72     virtual itk::ModifiedTimeType GetMTime( ) const ITK_OVERRIDE;
  73     virtual void Update( );
  74
  75     // Qt dialog creation
  76     virtual ParametersQtDialog* CreateQtDialog( );
  77     virtual bool IsInteractive( );
  78     virtual void SetInteractionObjects( const std::vector< void* >& objs );
  79
  80   protected:
  81     ProcessObject( );
  82     virtual ~ProcessObject( );
  83
  84     void _AddInput( const std::string& name, bool required = true );
  85     void _Error( const std::string& error );
  86
  87     template< class O >
  88       inline void _AddOutput( const std::string& name );
  89
  90     template< class F >
  91       inline F* _CreateITK( );
  92     template< class F >
  93       inline F* _CreateVTK( );
  94
  95     virtual void _GenerateData( ) = 0;
  96
  97   private:
  98     // Purposely not implemented
  99     ProcessObject( const Self& );
 100     Self& operator=( const Self& );
 101
 102   protected:
 103     Parameters m_Parameters;
 104
 105     typedef std::map< std::string, InputPort >  _TInputs;
 106     typedef std::map< std::string, OutputPort > _TOutputs;
 107     _TInputs  m_Inputs;
 108     _TOutputs m_Outputs;
 109
 110     itk::ModifiedTimeType m_LastExecutionTime;
 111     mutable long m_LastExecutionSpan;
 112
 113     bool m_PrintExecution;
 114     std::ostream* m_PrintExecutionStream;
 115   };
 116
 117 } // ecapseman
 118
 119 #include <cpPlugins/ProcessObject.hxx>
 120
 121 #endif // __CPPLUGINS__PROCESSOBJECT__H__
 122
 123 // eof - $RCSfile$