uwphy-clmsg.h

Go to the documentation of this file.

//
// Copyright (c) 2015 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 UWPHY_CLMSG_H
#define UWPHY_CLMSG_H
 
#include <clmessage.h>
#include <packet.h>
 
#define CLMSG_UWPHY_VERBOSITY (3)
 
#define CLMSG_UWPHY_NOT_VALID (-1)
 
#define CLMSG_UWPHY_TIME_NOT_VALID (-1)
 
#define CLMSG_UWPHY_STACK_ID_NOT_VALID (-1)
 
extern ClMessage_t CLMSG_UWPHY_TX_POWER;
extern ClMessage_t CLMSG_UWPHY_B_RATE;
extern ClMessage_t CLMSG_UWPHY_THRESH;
extern ClMessage_t CLMSG_UWPHY_LOSTPKT;
extern ClMessage_t CLMSG_UWPHY_TX_BUSY;
 
class ClMsgUwPhy : public ClMessage
{
public:
    enum ReqType { NOT_VALID = -1, SET_REQ, GET_REQ, SET_REPLY, GET_REPLY };
 
    ClMsgUwPhy(ClMessage_t type);
 
    ClMsgUwPhy(int stack_id, int dest_module_id, ClMessage_t type);
 
    ClMsgUwPhy(const ClMsgUwPhy &msg);
 
    virtual ~ClMsgUwPhy();
 
    virtual ClMsgUwPhy *copy();
 
    void setReqType(ReqType type);
 
    ReqType getReqType();
 
protected:
    // receiver stack id (valid only for broadcast request)
    int stack_id; /* <id of the stack */
    ReqType req_type; /*< request type: either get, set, request or reply */
};
 
class ClMsgUwPhyTxPwr : public ClMsgUwPhy
{
public:
    ClMsgUwPhyTxPwr();
 
    ClMsgUwPhyTxPwr(int stack_id, int dest_module_id);
 
    ClMsgUwPhyTxPwr(const ClMsgUwPhyTxPwr &msg);
 
    virtual ~ClMsgUwPhyTxPwr();
 
    double getPower();
 
    void setPower(double powr);
 
private:
    double tx_power; /* < Transmission power. Its definition (W, dB, dB re uPa,
                        ...) depends on the specific phy.*/
};
 
class ClMsgUwPhyBRate : public ClMsgUwPhy
{
public:
    ClMsgUwPhyBRate();
 
    ClMsgUwPhyBRate(int stack_id, int dest_module_id);
 
    ClMsgUwPhyBRate(const ClMsgUwPhyBRate &msg);
 
    virtual ~ClMsgUwPhyBRate();
 
    double getBRate();
 
    void setBRate(double rate);
 
private:
    double b_rate; /* < Communication threshold. Can be either the baud or the
                      bit rate.*/
};
 
class ClMsgUwPhyThresh : public ClMsgUwPhy
{
public:
    ClMsgUwPhyThresh();
 
    ClMsgUwPhyThresh(int stack_id, int dest_module_id);
 
    ClMsgUwPhyThresh(const ClMsgUwPhyThresh &msg);
 
    virtual ~ClMsgUwPhyThresh();
 
    double getThresh();
 
    void setThresh(double thresh);
 
private:
    double threshold; /* < Receiving threshold. Can be either the rx_power or
                         the SNR.*/
};
 
class ClMsgUwPhyGetLostPkts : public ClMsgUwPhy
{
public:
    ClMsgUwPhyGetLostPkts(bool control = false);
 
    ClMsgUwPhyGetLostPkts(
            int stack_id, int dest_module_id, bool control = false);
 
    ClMsgUwPhyGetLostPkts(const ClMsgUwPhyGetLostPkts &msg);
 
    ~ClMsgUwPhyGetLostPkts();
 
    uint getLostPkts();
 
    void setLostPkts(uint lost_pkt);
 
    inline bool
    isControl()
    {
        return is_control;
    }
 
private:
    uint lost_packets; /* < Number of packets lost by the phy.*/
    bool is_control;
};
 
class ClMsgUwPhyTxBusy : public ClMsgUwPhy
{
public:
    ClMsgUwPhyTxBusy();
 
    ClMsgUwPhyTxBusy(int stack_id, int dest_module_id);
 
    ClMsgUwPhyTxBusy(const ClMsgUwPhyTxBusy &msg);
 
    ~ClMsgUwPhyTxBusy();
 
    int getTxBusy();
 
    void setTxBusy(int powr);
 
    int getGetOp();
 
    void setGetOp(int);
 
private:
    int tx_busy; /* < Transmission power. Its definition (W, dB, dB re uPa, ...)
                    depends on the specific phy.*/
    int getop; // To signal if mac just wants to read the value
};
 
#endif /* UWPHY_CLMSG_H  */