inet::physicallayer::RadioFrame Class Reference

#include <RadioFrame.h>

Inheritance diagram for inet::physicallayer::RadioFrame:

Public Member Functions
	RadioFrame (const ITransmission *transmission)
	RadioFrame (const RadioFrame &other)
virtual RadioFrame *	dup () const override
virtual std::ostream &	printToStream (std::ostream &stream, int level) const override
	Prints this object to the provided output stream. More...
virtual const ITransmission *	getTransmission () const override
	Returns the radio signal transmission that this radio frame represents. More...
virtual const IArrival *	getArrival () const override
	This function may return nullptr if this is not yet computed. More...
virtual const IListening *	getListening () const override
	This function may return nullptr if this is not yet computed. More...
virtual const IReception *	getReception () const override
	This function may return nullptr if this is not yet computed. More...
Public Member Functions inherited from inet::IPhysicalLayerFrame
virtual	~IPhysicalLayerFrame ()
Public Member Functions inherited from inet::physicallayer::IPrintableObject
virtual	~IPrintableObject ()
virtual std::string	getInfoStringRepresentation () const
virtual std::string	getDetailStringRepresentation () const
virtual std::string	getDebugStringRepresentation () const
virtual std::string	getTraceStringRepresentation () const
virtual std::string	getCompleteStringRepresentation () const

Protected Attributes
const ITransmission *	transmission = nullptr
const IArrival *	arrival = nullptr
const IListening *	listening = nullptr
const IReception *	reception = nullptr

Additional Inherited Members
Public Types inherited from inet::physicallayer::IPrintableObject
enum	PrintLevel {   PRINT_LEVEL_TRACE, PRINT_LEVEL_DEBUG, PRINT_LEVEL_DETAIL, PRINT_LEVEL_INFO,   PRINT_LEVEL_COMPLETE = INT_MIN }

Constructor & Destructor Documentation

inet::physicallayer::RadioFrame::RadioFrame

(

const ITransmission *

transmission

)

                                                        :
    transmission(transmission)
{
}

inet::physicallayer::RadioFrame::RadioFrame

(

const RadioFrame &

other

)

                                              :
    cPacket(other),
    transmission(other.transmission)
{
}

Member Function Documentation

virtual RadioFrame* inet::physicallayer::RadioFrame::dup ( ) const

inlineoverridevirtual

{ return new RadioFrame(*this); }

const IArrival * inet::physicallayer::RadioFrame::getArrival ( ) const

overridevirtual

This function may return nullptr if this is not yet computed.

Implements inet::physicallayer::IRadioFrame.

Referenced by inet::physicallayer::Radio::continueReception(), inet::physicallayer::Radio::endReception(), and inet::physicallayer::Radio::startReception().

{
    if (arrival == nullptr) {
        auto receiver = check_and_cast<const IRadio *>(getArrivalModule());
        arrival = transmission->getTransmitter()->getMedium()->getArrival(receiver, transmission);
    }
    return arrival;
}

const IListening * inet::physicallayer::RadioFrame::getListening ( ) const

overridevirtual

This function may return nullptr if this is not yet computed.

Implements inet::physicallayer::IRadioFrame.

{
    if (listening == nullptr) {
        auto receiver = check_and_cast<const IRadio *>(getArrivalModule());
        listening = transmission->getTransmitter()->getMedium()->getListening(receiver, transmission);
    }
    return listening;
}

const IReception * inet::physicallayer::RadioFrame::getReception ( ) const

overridevirtual

This function may return nullptr if this is not yet computed.

Implements inet::physicallayer::IRadioFrame.

Referenced by inet::physicallayer::Radio::abortReception().

{
    if (reception == nullptr) {
        auto receiver = check_and_cast<const IRadio *>(getArrivalModule());
        reception = transmission->getTransmitter()->getMedium()->getReception(receiver, transmission);
    }
    return reception;
}

const ITransmission * inet::physicallayer::RadioFrame::getTransmission ( ) const

overridevirtual

Returns the radio signal transmission that this radio frame represents.

This function never returns nullptr.

Implements inet::physicallayer::IRadioFrame.

Referenced by inet::physicallayer::Radio::abortTransmission(), inet::physicallayer::Radio::continueTransmission(), and inet::physicallayer::Radio::endTransmission().

{
    return transmission;
}

std::ostream & inet::physicallayer::RadioFrame::printToStream ( std::ostream &  stream, int  level  ) const

overridevirtual

Prints this object to the provided output stream.

Function calls to operator<< with pointers or references either const or not are all forwarded to this function.

Reimplemented from inet::physicallayer::IPrintableObject.

{
    return stream << (cPacket *)this;
}

Member Data Documentation

const IArrival* inet::physicallayer::RadioFrame::arrival = nullptr

mutableprotected

Referenced by getArrival().

const IListening* inet::physicallayer::RadioFrame::listening = nullptr

mutableprotected

Referenced by getListening().

const IReception* inet::physicallayer::RadioFrame::reception = nullptr

mutableprotected

Referenced by getReception().

const ITransmission* inet::physicallayer::RadioFrame::transmission = nullptr

protected

Referenced by getArrival(), getListening(), getReception(), and getTransmission().

---

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

• RadioFrame.h
• RadioFrame.cc