CARMA C++
PipelineSubsystem.h
Go to the documentation of this file.
1 #ifndef CARMA_MONITOR_PIPELINESUBSYSTEM_H
2 #define CARMA_MONITOR_PIPELINESUBSYSTEM_H
3 
11 #include "carma/monitor/PipelineCommon.h"
12 
13 #include <utility>
14 
15 namespace carma {
16  namespace monitor {
17 
28  class PipelineSubsystem {
29  public:
30 
34  explicit PipelineSubsystem( );
35 
39  virtual ~PipelineSubsystem( );
40 
44  virtual int getBandCount( ) const = 0;
45 
46  virtual
47  carma::monitor::PipelineStatus &
48  getPipelineStatus( ) const = 0;
49 
50  virtual
51  carma::monitor::StageStats &
52  getCatchDataStageStats( ) const = 0;
53 
54  virtual
55  carma::monitor::CatchDataStage &
56  getCatchDataStage( ) const = 0;
57 
58  virtual
59  carma::monitor::CatchDataBand &
60  getCatchDataBand( int bandIdx ) const = 0;
61 
62  virtual
63  carma::monitor::StageStats &
64  getCoherenceStageStats( ) const = 0;
65 
66  virtual
67  carma::monitor::StageStats &
68  getDecimationStageStats( ) const = 0;
69 
70  virtual
71  carma::monitor::Decimation &
72  getDecimation( int bandIdx ) const = 0;
73 
74  virtual
75  carma::monitor::SelfCal &
76  getSelfCal( int bandIdx, bool usb ) const = 0;
77 
78  virtual
79  carma::monitor::StageStats &
80  getPassBandStageStats( ) const = 0;
81 
82  virtual
83  carma::monitor::StageStats &
84  getTsysStageStats( ) const = 0;
85 
86  virtual
87  carma::monitor::TsysStage &
88  getTsysStage( ) const = 0;
89 
90  virtual
91  carma::monitor::StageStats &
92  getBlankFlagStageStats( ) const = 0;
93 
94  virtual
95  carma::monitor::BlankFlagStage &
96  getBlankFlagStage( ) const = 0;
97 
98  virtual
99  carma::monitor::StageStats &
100  getLinelengthStageStats( ) const = 0;
101 
102  virtual
103  carma::monitor::StageStats &
104  getIFcorrectionStageStats( ) const = 0;
105 
106  virtual
107  carma::monitor::StageStats &
108  getWvrStageStats( ) const = 0;
109 
110  virtual
111  carma::monitor::StageStats &
112  getSelfCalStageStats( ) const = 0;
113 
114  virtual
115  carma::monitor::StageStats &
116  getIntegratorStageStats( ) const = 0;
117 
118  virtual
119  carma::monitor::IntegratorStage &
120  getIntegratorStage( ) const = 0;
121 
122  virtual
123  carma::monitor::StageStats &
124  getCorrelatorPublisherStageStats( ) const = 0;
125 
126  virtual
127  carma::monitor::CorrelatorPublisherStage &
128  getCorrelatorPublisherStage( ) const = 0;
129 
130  virtual
131  carma::monitor::StageStats &
132  getVisBrickStageStats( ) const = 0;
133 
134  virtual
135  carma::monitor::VisBrickStage &
136  getVisBrickStage( ) const = 0;
137 
141  virtual
142  carma::monitor::LastIntegration& lastIntegration() const = 0;
143 
148  virtual void startAutoWriter( float delay ) = 0;
149 
153  virtual void stopAutoWriter( ) = 0;
154 
158  virtual bool autoWriterIsAlive( ) const = 0;
159 
163  virtual void write( ) = 0;
164 
165  protected:
166 
167  // Nothing protected
168 
169  private:
170 
171  // Nothing private
172 
173  }; // End class PipelineSubsystem
174  } // End namespace monitor
175 } // End namespace carma
176 
177 #endif // End #ifndef CARMA_MONITOR_PIPELINESUBSYSTEM_H
carma::monitor::PipelineSubsystem::startAutoWriter
virtual void startAutoWriter(float delay)=0
Start the monitor system auto writer (automatically writes data to the Frame Scriber Publisher every ...
carma::monitor::PipelineSubsystem::lastIntegration
virtual carma::monitor::LastIntegration & lastIntegration() const =0
Retrieve reference to lastIntegration container.
carma::monitor::PipelineSubsystem::write
virtual void write()=0
Write frame data.
carma::monitor::PipelineSubsystem::getBandCount
virtual int getBandCount() const =0
Retrieve band count - differs among wb and sl systems.
carma::monitor::PipelineSubsystem
Abstract base class for retrieving pipeline monitor system components common between the spectral lin...
Definition: PipelineSubsystem.h:28
carma::monitor::PipelineSubsystem::stopAutoWriter
virtual void stopAutoWriter()=0
Stop the autowriter.
carma::monitor::PipelineSubsystem::autoWriterIsAlive
virtual bool autoWriterIsAlive() const =0
Check to see if autowriter is alive.
carma::monitor::PipelineSubsystem::~PipelineSubsystem
virtual ~PipelineSubsystem()
Destructor.