MonitorPointIterator.h

Go to the documentation of this file.

#ifndef CARMA_MONITOR_MONITORPOINTITERATOR_H
#define CARMA_MONITOR_MONITORPOINTITERATOR_H


#include <vector>
#include <string>

namespace carma {
namespace monitor {

// Forward class declarations
class MonitorPoint;
class MonitorContainer;


class MonitorPointIterator {
    public:
        explicit MonitorPointIterator( 
            const MonitorContainer         & rootContainer,
            int                              maxDepth = 0,
            const std::vector<std::string>   skip = std::vector<std::string>());

        bool operator++( );

        bool operator++( int dummy );

        bool hasMonitorPoint( ) const;

        MonitorPoint & getMonitorPoint( ) const;

        void reset( );

        void checkStats( bool throwOnProblem ) const;

    private:
        // No copying
        MonitorPointIterator( const MonitorPointIterator & rhs );
        MonitorPointIterator & operator=( const MonitorPointIterator & rhs );

        MonitorPoint & handleBadDeref( ) const;

        struct StackEntry {
            const MonitorContainer * parent;
            int                      index;
        };

        const MonitorContainer & rootContainer_;
        const unsigned int       maxDepth_;

        bool                     initialized_;
        const MonitorContainer * parent_;
        int                      index_;
        bool                     hasCurrentValue_;
        MonitorPoint *           currentValue_;

        // Placeholder: holds the component index for each level in
        //              the hierarachy
        ::std::vector< StackEntry > stack_;

        const std::vector<std::string> skip_; // Containers to skip
};


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


inline bool
carma::monitor::MonitorPointIterator::operator++( const int )
{
    return operator++();
}


inline bool
carma::monitor::MonitorPointIterator::hasMonitorPoint( ) const
{
    return hasCurrentValue_;
}


inline carma::monitor::MonitorPoint &
carma::monitor::MonitorPointIterator::getMonitorPoint( ) const
{
    if ( currentValue_ != 0 )
        return *currentValue_;
    else
        return handleBadDeref();
}


#endif