Stage.h

Go to the documentation of this file.

// $Id: Stage.h,v 1.1 2011/08/18 23:25:52 abeard Exp $

#ifndef CARMA_PIPELINE_STAGE_H
#define CARMA_PIPELINE_STAGE_H

#include "carma/correlator/lib/CorrelatorDataPtr.h"
#include "carma/util/Time.h"

#include <memory>

namespace carma {

    namespace correlator {
        namespace lib {
            class CorrelatorBand;
            class CorrelatorData;
        } // namespace lib
    } // namespace correlator 

    namespace monitor {
        class StageStats;
    } // namespace monitor

    namespace pipeline {

        class Stage {
        public:

            virtual ~Stage( );

            void activate( );

            void deactivate( );

            bool isStageActive( ) const;

            std::string getName( ) const;

            void preprocessCorrelatorData(
                    const carma::correlator::lib::CorrelatorDataPtr cd );

            void processCorrelatorBand( 
                    carma::correlator::lib::CorrelatorBand * cb );

            carma::correlator::lib::CorrelatorDataPtr
            postprocessCorrelatorData( 
                carma::correlator::lib::CorrelatorDataPtr cd );

            void fillStageMonitorData( );

            void fillMonitorStageStats( );

        protected:

            virtual void preprocess( 
                    const carma::correlator::lib::CorrelatorDataPtr cd ) = 0;

            virtual void
                processBand( carma::correlator::lib::CorrelatorBand * cb ) = 0;

            virtual carma::correlator::lib::CorrelatorDataPtr
                postprocess( carma::correlator::lib::CorrelatorDataPtr cd ) = 0;

            virtual void fillMonitorData( )  = 0;

            explicit 
                Stage( carma::monitor::StageStats & stageStats,
                        const std::string & name );

            carma::util::frameType getDataFrameCount( ) const;

        private:

            Stage( const Stage & );
            Stage & operator=( const Stage & );

            struct Pimpl;
            const ::std::auto_ptr<Pimpl> pimpl_;

        }; // End class Stage

    } // namespace pipeline
} // namespace carma

#endif // #ifndef CARMA_PIPELINE_STAGE_H