radio_accnoise.h

simulator for ad hoc

/*
 * GloMoSim is COPYRIGHTED software.  Release 2.02 of GloMoSim is available 
 * at no cost to educational users only.
 *
 * Commercial use of this software requires a separate license.  No cost,
 * evaluation licenses are available for such purposes; please contact
 * [e-mail]
 *
 * By obtaining copies of this and any other files that comprise GloMoSim2.02,
 * you, the Licensee, agree to abide by the following conditions and
 * understandings with respect to the copyrighted software:
 *
 * 1.Permission to use, copy, and modify this software and its documentation
 *   for education and non-commercial research purposes only is hereby granted
 *   to Licensee, provided that the copyright notice, the original author's
 *   names and unit identification, and this permission notice appear on all
 *   such copies, and that no charge be made for such copies. Any entity
 *   desiring permission to use this software for any commercial or
 *   non-educational research purposes should contact: 
 *
 *   Professor Rajive Bagrodia 
 *   University of California, Los Angeles 
 *   Department of Computer Science 
 *   Box 951596 
 *   3532 Boelter Hall 
 *   Los Angeles, CA 90095-1596 
 *   [e-mail]
 *
 * 2.NO REPRESENTATIONS ARE MADE ABOUT THE SUITABILITY OF THE SOFTWARE FOR ANY
 *   PURPOSE. IT IS PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY.
 *
 * 3.Neither the software developers, the Parallel Computing Lab, UCLA, or any
 *   affiliate of the UC system shall be liable for any damages suffered by
 *   Licensee from the use of this software.
 */

// Use the latest version of Parsec if this line causes a compiler error.
/*
 * $Id: radio_accnoise.h,v 1.9 2001/08/31 19:25:35 jmartin Exp $
 */

#ifndef _RADIO_ACCNOISE_H_
#define _RADIO_ACCNOISE_H_


#include "main.h"

typedef enum {
    SNR_BOUNDED = 1,
    BER_BASED
} RADIO_RX_TYPE;

/*
 * Structure for radio statistics variables
 */
typedef struct radio_accnoise_stats_str {
    int totalTxSignals;
    int totalRxSignalsAboveRX;
    int totalRxSignalsAboveCS;
    int totalRxSignalsToMac;
    int totalCollisions;
    double energyConsumed;
    clocktype turnOnTime;
} RadioAccnoiseStats;


#define FAST_FADING_COHERENCE_TIME 1000000

/*
 * Structure for Radio.
 */
typedef struct glomo_radio_accnoise_str {
    int              radioIdNumber;
    
    RADIO_RX_TYPE    radioRxType;
    double           radioRxSnrThreshold;
    double           radioRxSnrThreshold_dB;

    Message     *rxMsg;
    double       rxMsgPower_mW;
    clocktype    rxStartTime;
    long double  noisePower_mW;
    int          numSignals;
    clocktype    lastReceivedFrameTime;
    double       lastReceivedFrameFastFading_dB;
    NODE_ADDR    lastReceivedFrameSourceNode; 

    RadioStatusType mode;
    RadioStatusType previousMode;

    RadioAccnoiseStats    stats; /* Stores statistical results */
    
    
    
} GlomoRadioAccnoise;


/*
 * FUNCTION    RadioAccnoiseLayer
 * PURPOSE     Models the behaviour of the Radio with capture on receiving
 *             the message enclosed in msgHdr.
 *
 * Parameters:
 *     node:     node which received the message
 *     msgHdr:   message received by the layer
 */
void RadioAccnoiseLayer(GlomoNode *node, const int radioNum, Message *msgHdr);

void RadioAccnoiseInit(GlomoNode *node, const int radioNum, 
                      const GlomoNodeInput *nodeInput);

void RadioAccnoiseFinalize(GlomoNode *node, const int radioNum);

static /*inline*/
RadioStatusType RadioAccnoiseGetStatus(GlomoNode *node, int radioNum) {
    GlomoRadioAccnoise* radioAccnoise = 
       (GlomoRadioAccnoise *)node->radioData[radioNum]->radioVar;
    return (radioAccnoise->mode);
}

void RadioAccnoiseStartTransmittingPacket(
   GlomoNode* node, int radioNum, 
   Message* packet, NODE_ADDR receivingNode,
   BOOL useMacLayerSpecifiedDelay,
   clocktype delayUntilAirborne);

#endif /* _RADIO_ACCNOISE_H_ */