/*
 * Copyright (c) 2018, University of Kaiserslautern
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Authors:
 *    Felipe S. Prado
 *    Matthias Jung
 */

#ifndef RECORDABLECONTROLLER_H
#define RECORDABLECONTROLLER_H

#include "Controller.h"

struct RecordableController: public Controller {
public:
    RecordableController(sc_module_name name, TlmRecorder *rec) :
        Controller(name), tlmRecorder(rec)
    {
    }

protected:
    TlmRecorder *tlmRecorder;

    virtual tlm_sync_enum nb_transport_fw(tlm_generic_payload &payload,
                                          tlm_phase &phase, sc_time &fwDelay) override;
    virtual tlm_sync_enum nb_transport_bw(tlm_generic_payload &payload,
                                          tlm_phase &phase, sc_time &bwDelay) override;
    virtual void sendToFrontend(tlm_generic_payload &payload,
                                const tlm_phase &phase, const sc_time &delay) override;
    virtual void schedule(Command command, tlm_generic_payload &payload) override;

    void recordPhase(tlm::tlm_generic_payload &trans, tlm::tlm_phase phase,
                     sc_time delay);
};

#endif // RECORDABLECONTROLLER_H
