inet::physicallayer::UnitDiskTransmitter Class Reference

Implements the UnitDiskTransmitter model, see the NED file for details. More...

#include <UnitDiskTransmitter.h>

Inheritance diagram for inet::physicallayer::UnitDiskTransmitter:

Public Member Functions
	UnitDiskTransmitter ()
virtual std::ostream &	printToStream (std::ostream &stream, int level, int evFlags=0) const override
	Prints this object to the provided output stream. More...
virtual const ITransmission *	createTransmission (const IRadio *radio, const Packet *packet, const simtime_t startTime) const override
	Returns a transmission which describes the radio signal corresponding to the provided packet. More...
virtual simtime_t	getPreambleDuration () const
virtual b	getHeaderLength () const
virtual bps	getBitrate () const
virtual m	getMaxCommunicationRange () const override
	Returns the maximum communication range. More...
virtual m	getMaxInterferenceRange () const override
	Returns the maximum interference range. More...
Public Member Functions inherited from inet::physicallayer::TransmitterBase
virtual W	getMaxPower () const override
	Returns the maximum transmission power above which no transmission is ever transmitted. More...
Public Member Functions inherited from inet::IPrintableObject
virtual	~IPrintableObject ()
virtual std::string	printToString () const
virtual std::string	printToString (int level, int evFlags=0) const
virtual std::string	getInfoStringRepresentation (int evFlags=0) const
virtual std::string	getDetailStringRepresentation (int evFlags=0) const
virtual std::string	getDebugStringRepresentation (int evFlags=0) const
virtual std::string	getTraceStringRepresentation (int evFlags=0) const
virtual std::string	getCompleteStringRepresentation (int evFlags=0) const

Protected Member Functions
virtual void	initialize (int stage) override
Protected Member Functions inherited from inet::physicallayer::TransmitterBase
virtual int	numInitStages () const override

Protected Attributes
simtime_t	preambleDuration
b	headerLength
bps	bitrate
m	communicationRange
m	interferenceRange
m	detectionRange

Additional Inherited Members
Public Types inherited from inet::IPrintableObject
enum	PrintLevel {   PRINT_LEVEL_TRACE, PRINT_LEVEL_DEBUG, PRINT_LEVEL_DETAIL, PRINT_LEVEL_INFO,   PRINT_LEVEL_COMPLETE = INT_MIN }
enum	PrintFlag { PRINT_FLAG_FORMATTED = (1 << 0), PRINT_FLAG_MULTILINE = (1 << 1) }

Detailed Description

Implements the UnitDiskTransmitter model, see the NED file for details.

Constructor & Destructor Documentation

UnitDiskTransmitter()

inet::physicallayer::UnitDiskTransmitter::UnitDiskTransmitter

(

)

                                         :
    headerLength(b(-1)),
    bitrate(NaN),
    communicationRange(NaN),
    interferenceRange(NaN),
    detectionRange(NaN)
{
}

Member Function Documentation

createTransmission()

const ITransmission * inet::physicallayer::UnitDiskTransmitter::createTransmission ( const IRadio *  transmitter, const Packet *  packet, const simtime_t  startTime  ) const

overridevirtual

Returns a transmission which describes the radio signal corresponding to the provided packet.

This function never returns nullptr.

Implements inet::physicallayer::ITransmitter.

{
    auto phyHeader = packet->peekAtFront<UnitDiskPhyHeader>();
    auto dataLength = packet->getTotalLength() - phyHeader->getChunkLength();
    const auto& signalBitrateReq = const_cast<Packet *>(packet)->findTag<SignalBitrateReq>();
    auto transmissionBitrate = signalBitrateReq != nullptr ? signalBitrateReq->getDataBitrate() : bitrate;
    auto headerDuration = b(headerLength).get() / bps(transmissionBitrate).get();
    auto dataDuration = b(dataLength).get() / bps(transmissionBitrate).get();
    auto duration = preambleDuration + headerDuration + dataDuration;
    auto endTime = startTime + duration;
    auto mobility = transmitter->getAntenna()->getMobility();
    auto startPosition = mobility->getCurrentPosition();
    auto endPosition = mobility->getCurrentPosition();
    auto startOrientation = mobility->getCurrentAngularPosition();
    auto endOrientation = mobility->getCurrentAngularPosition();
    return new UnitDiskTransmission(transmitter, packet, startTime, endTime,
            preambleDuration, headerDuration, dataDuration,
            startPosition, endPosition, startOrientation, endOrientation,
            communicationRange, interferenceRange, detectionRange);
}

getBitrate()

virtual bps inet::physicallayer::UnitDiskTransmitter::getBitrate ( ) const

inlinevirtual

{ return bitrate; }

getHeaderLength()

virtual b inet::physicallayer::UnitDiskTransmitter::getHeaderLength ( ) const

inlinevirtual

{ return headerLength; }

getMaxCommunicationRange()

virtual m inet::physicallayer::UnitDiskTransmitter::getMaxCommunicationRange ( ) const

inlineoverridevirtual

Returns the maximum communication range.

Returns a value in the range [0, +infinity] or NaN if unspecified.

Reimplemented from inet::physicallayer::TransmitterBase.

{ return communicationRange; }

getMaxInterferenceRange()

virtual m inet::physicallayer::UnitDiskTransmitter::getMaxInterferenceRange ( ) const

inlineoverridevirtual

Returns the maximum interference range.

Returns a value in the range [0, +infinity] or NaN if unspecified.

Reimplemented from inet::physicallayer::TransmitterBase.

{ return interferenceRange; }

getPreambleDuration()

virtual simtime_t inet::physicallayer::UnitDiskTransmitter::getPreambleDuration ( ) const

inlinevirtual

{ return preambleDuration; }

initialize()

void inet::physicallayer::UnitDiskTransmitter::initialize ( int  stage )

overrideprotectedvirtual

{
    if (stage == INITSTAGE_LOCAL) {
        preambleDuration = par("preambleDuration");
        headerLength = b(par("headerLength"));
        bitrate = bps(par("bitrate"));
        communicationRange = m(par("communicationRange"));
        interferenceRange = m(par("interferenceRange"));
        detectionRange = m(par("detectionRange"));
    }
}

printToStream()

std::ostream & inet::physicallayer::UnitDiskTransmitter::printToStream ( std::ostream &  stream, int  level, int  evFlags = 0  ) const

overridevirtual

Prints this object to the provided output stream.

Reimplemented from inet::IPrintableObject.

{
    stream << "UnitDiskTransmitter";
    if (level <= PRINT_LEVEL_TRACE)
        stream << EV_FIELD(preambleDuration)
               << EV_FIELD(headerLength)
               << EV_FIELD(bitrate);
    if (level <= PRINT_LEVEL_INFO)
        stream << EV_FIELD(communicationRange);
    if (level <= PRINT_LEVEL_TRACE)
        stream << EV_FIELD(interferenceRange)
               << EV_FIELD(detectionRange);
    return stream;
}

Member Data Documentation

bitrate

bps inet::physicallayer::UnitDiskTransmitter::bitrate

protected

Referenced by createTransmission(), initialize(), and printToStream().

communicationRange

m inet::physicallayer::UnitDiskTransmitter::communicationRange

protected

Referenced by createTransmission(), initialize(), and printToStream().

detectionRange

m inet::physicallayer::UnitDiskTransmitter::detectionRange

protected

Referenced by createTransmission(), initialize(), and printToStream().

headerLength

b inet::physicallayer::UnitDiskTransmitter::headerLength

protected

Referenced by createTransmission(), initialize(), and printToStream().

interferenceRange

m inet::physicallayer::UnitDiskTransmitter::interferenceRange

protected

Referenced by createTransmission(), initialize(), and printToStream().

preambleDuration

simtime_t inet::physicallayer::UnitDiskTransmitter::preambleDuration

protected

Referenced by createTransmission(), initialize(), and printToStream().

---

The documentation for this class was generated from the following files:

• UnitDiskTransmitter.h
• UnitDiskTransmitter.cc