StopPointManager.hh

Go to the documentation of this file.

/*
    Copyright (c) 2002-2009 Tampere University.
 
    This file is part of TTA-Based Codesign Environment (TCE).
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 */
/**
 * @file StopPointManager.hh
 *
 * Declaration of StopPointManager class.
 *
 * @author Pekka Jääskeläinen 2005 (pjaaskel-no.spam-cs.tut.fi)
 * @note rating: red
 */
 
#ifndef TTA_STOP_POINT_MANAGER_HH
#define TTA_STOP_POINT_MANAGER_HH
 
#include <vector>
#include <map>
 
#include "Exception.hh"
#include "StopPoint.hh"
#include "SimulatorConstants.hh"
#include "Listener.hh"
 
class TTASimulationController;
class SimulationEventHandler;
 
/**
 * Keeps book of user-set simulation stop points.
 */
class StopPointManager : public Listener {
public:
    StopPointManager(
        TTASimulationController& controller, 
        SimulationEventHandler& eventHandler);
 
    virtual ~StopPointManager();
    unsigned int add(const StopPoint& stopPoint);
    void deleteStopPoint(unsigned int handle);
    void deleteAll();
 
    void enable(unsigned int handle);
    void enableAll();
 
    void enableOnceAndDelete(unsigned int handle);
    void enableOnceAndDisable(unsigned int handle);
 
    void disable(unsigned int handle);
    void disableAll();
 
    const StopPoint& stopPointWithHandleConst(unsigned int handle) const;
 
    unsigned int stopPointHandle(unsigned int index);
    unsigned int stopPointCount();
 
    void setIgnore(unsigned int handle, unsigned int count);
    void setCondition(unsigned int handle, const ConditionScript& condition);
    void removeCondition(unsigned int handle);
 
    unsigned int stopCausingStopPoint(unsigned int index) const;
    unsigned int stopCausingStopPointCount() const;
 
    void handleEvent();
 
private:
    /// The breakpoint storage.
    typedef std::map<unsigned int, StopPoint*> StopPointIndex;
    /// The handle storage.
    typedef std::vector<unsigned int> HandleContainer;
 
    StopPoint* findStopPoint(unsigned int handle);
 
    /// The stop points.
    StopPointIndex stopPoints_;
    /// The stop point handles.
    HandleContainer handles_;
    /// Represents the next free handle.
    unsigned int handleCount_;
    /// The clock cycle in which simulation was stopped last.
    ClockCycleCount lastStopCycle_;
    /// The simulation controller to use to stop the simulation.
    TTASimulationController& controller_;
    /// The event handler to use to register stop points to.
    SimulationEventHandler& eventHandler_;
    
};
 
#endif