SimulatorToolbox.hh

Go to the documentation of this file.

/*
    Copyright (c) 2002-2010 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 SimulatorToolbox.hh
 *
 * Declaration of SimulatorToolbox class.
 *
 * @author Jussi Nykänen 2004 (nykanen-no.spam-cs.tut.fi)
 * @author Pekka Jääskeläinen 2005,2009-2010 (pjaaskel-no.spam-cs.tut.fi)
 * @note rating: red
 */
 
#ifndef TTA_SIMULATOR_TOOLBOX_HH
#define TTA_SIMULATOR_TOOLBOX_HH
 
#include <string>
#include <vector>
#include "SimulatorTextGenerator.hh"
#include "CompilerWarnings.hh"
IGNORE_CLANG_WARNING("-Wkeyword-macro")
#include "boost/regex.hpp"
POP_CLANG_DIAGS
 
class OperationPool;
class SimulationEventHandler;
 
 
/**
 * Class that offers global services to Simulator classes.
 *
 * Services provided by this utility class are provided as singleton
 * instances. None of the returned data are simulation specific, thus
 * the instances can be shared by multiple parallel simulations.
 */
class SimulatorToolbox {
public:
 
    static OperationPool& operationPool();
    static SimulatorTextGenerator& textGenerator();
    
    static boost::regex fuPortRegex();
 
protected:
    /// Instantiation not allowed.
    SimulatorToolbox();
 
private:
    /// Copying not allowed.
    SimulatorToolbox(const SimulatorToolbox&);
    /// Assignment not allowed.
    SimulatorToolbox& operator=(const SimulatorToolbox&);
 
    /// Global instance of OperationPool.
    static OperationPool* pool_;
    /// Global instance of SimulatorTextGenerator.
    static SimulatorTextGenerator textGenerator_;
};
 
#endif