mclink.h

Go to the documentation of this file.

//
// Copyright (c) 2021 Regents of the SIGNET lab, University of Padova.
// 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 University of Padova (SIGNET lab) 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 OWNER 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.
//
 
#ifndef MCLINK_H
#define MCLINK_H
 
#include "uwphysical.h"
 
class MCLink : public TclObject
{
public:
    enum ChState { NOT_DEFINED = 0, GOOD = 1, MEDIUM = 2, BAD = 3 };
 
    MCLink();
 
    MCLink(double ber_good, double ber_bad, double p_gb, double p_bg,
            double step_period, ChState ch_state = MCLink::GOOD);
 
    virtual ~MCLink()
    {
    }
 
    virtual int command(int, const char *const *);
 
    virtual ChState updateChState();
 
    ChState
    getChState()
    {
        return updateChState();
    }
 
    virtual double
    getBER(); // remember to call updateChState() before returning a BER value
 
protected:
    // Variables
    double ber_good; 
    double ber_bad; 
    double p_gb; 
    double p_bg; 
    double last_update; 
    double step_period; 
    ChState ch_state; 
};
 
#endif /* MCLINK_H  */