SystemThresholdFrame.h

Go to the documentation of this file.

/*
 * SystemThresholdFrame.h - Class holding thresholds for carma monitor system.
 */

#ifndef CARMA_SYSTEM_THRESHOLD_FRAME_H
#define CARMA_SYSTEM_THRESHOLD_FRAME_H

#include "carma/util/ErrorException.h"
#include "carma/monitor/types.h"

namespace carma {
namespace monitor {


class MonitorSystem;
class MonitorPoint;
class MonitorPointThreshold;
struct ThresholdStruct;


class ThresholdObjectNotFoundException : public ::carma::util::ErrorException  
{
  public:

    ThresholdObjectNotFoundException ( tagIDType    tagID, 
                                       const char * fileName, 
                                       int          lineNo );

    ~ThresholdObjectNotFoundException () throw () { }

  private:

    static std::string makeMessage( tagIDType tagID );
};


class ReachedNumThresholdLimitException : public ::carma::util::ErrorException  
{
  public:

    ReachedNumThresholdLimitException( long         maxThresholds,
                                       tagIDType    tagID,
                                       const char * fileName, 
                                       int          lineNo);

    ~ReachedNumThresholdLimitException () throw () { }

  private:

    static std::string makeMessage( long      maxThresholds,
                                    tagIDType tagID );
};


struct ThresholdFrameStruct {
    long maxNumThresholds; // # of thresholds that the frame can hold

    long numThresholds; // # of thresholds allocated within this frame

    int * thresholdIndex; // points to array of indices to thresholds

    ThresholdStruct * thresholds;
};


class SystemThresholdFrame {

  public:

    explicit SystemThresholdFrame( MonitorSystem & monitorSystem );

    virtual ~SystemThresholdFrame() ;

    long getNumThresholds() const;

    long getMaxNumThresholds() const;

    virtual void calibrateMonitorSystem( );

    MonitorPointThreshold & getThreshold( tagIDType tagID ) const;

  protected:

    ThresholdFrameStruct & getThresholdFrame( ) const;

    ThresholdStruct & getThresholdStruct( int index ) const;

    int findThreshold( tagIDType tagID ) const;

    static size_t sizeThresholdFrame (long maxThresholds);

    static ThresholdFrameStruct &
    setThresholdFrameSize( ThresholdFrameStruct & frame,
                           long                   maxThresholds );

    static ThresholdFrameStruct &
    fixupFramePointers( ThresholdFrameStruct & frame );

  private:

    static ThresholdFrameStruct &
    createThresholdFrameStruct( MonitorSystem & monitorSystem );

    static void
    destroyThresholdFrameStruct( ThresholdFrameStruct & thresholdFrameStruct );

    void initializeThresholdValues( );

    struct MpThreshPair {
        MonitorPoint *    mp;
        ThresholdStruct * thresholdStruct;
    };

    ThresholdFrameStruct &        thresholdFrame_;
    MonitorSystem &               monitorSystem_;
    ::std::vector< MpThreshPair > mpThreshPairs_;
}; // class SystemThresholdFrame


}  // namespace carma::monitor
}  // namespace carma

#endif