inet::physicallayer::TransmissionBase Class Reference

#include <TransmissionBase.h>

Inheritance diagram for inet::physicallayer::TransmissionBase:

Public Member Functions
	TransmissionBase (const IRadio *transmitter, const cPacket *macFrame, const simtime_t startTime, const simtime_t endTime, const simtime_t preambleDuration, const simtime_t headerDuration, const simtime_t dataDuration, const Coord startPosition, const Coord endPosition, const EulerAngles startOrientation, const EulerAngles endOrientation)
virtual int	getId () const override
	Returns an identifier for this transmission which is globally unique for the whole lifetime of the simulation among all transmissions. More...
virtual std::ostream &	printToStream (std::ostream &stream, int level) const override
	Prints this object to the provided output stream. More...
virtual const IRadio *	getTransmitter () const override
	Returns the transmitter that transmitted this radio signal on the radio channel. More...
virtual const cPacket *	getPhyFrame () const override
	Returns the PHY frame corresponding to this transmission. More...
virtual const cPacket *	getMacFrame () const override
	Returns the MAC frame corresponding to this transmission. More...
virtual const simtime_t	getStartTime () const override
	Returns the time when the transmitter started this transmission. More...
virtual const simtime_t	getEndTime () const override
	Returns the time when the transmitter ended this transmission. More...
virtual const simtime_t	getStartTime (IRadioSignal::SignalPart part) const override
virtual const simtime_t	getEndTime (IRadioSignal::SignalPart part) const override
virtual const simtime_t	getPreambleStartTime () const override
virtual const simtime_t	getPreambleEndTime () const override
virtual const simtime_t	getHeaderStartTime () const override
virtual const simtime_t	getHeaderEndTime () const override
virtual const simtime_t	getDataStartTime () const override
virtual const simtime_t	getDataEndTime () const override
virtual const simtime_t	getDuration () const override
	Returns the total length of this transmission. More...
virtual const simtime_t	getDuration (IRadioSignal::SignalPart part) const override
	Returns the length of the provided part of this transmission. More...
virtual const simtime_t	getPreambleDuration () const override
	Returns the length of the preamble part of this transmission. More...
virtual const simtime_t	getHeaderDuration () const override
	Returns the length of the header part of this transmission. More...
virtual const simtime_t	getDataDuration () const override
	Returns the length of the data part of this transmission. More...
virtual const Coord	getStartPosition () const override
	Returns the antenna's position when the transmitter started this transmission. More...
virtual const Coord	getEndPosition () const override
	Returns the antenna's position when the transmitter ended this transmission. More...
virtual const EulerAngles	getStartOrientation () const override
	Returns the antenna's orientation when the transmitter started this transmission. More...
virtual const EulerAngles	getEndOrientation () const override
	Returns the antenna's orientation when the transmitter ended this transmission. More...
virtual const ITransmissionAnalogModel *	getAnalogModel () const override
	Returns the analog model of the transmitted signal. More...
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 int	id
const IRadio *	transmitter
const cPacket *	macFrame
const simtime_t	startTime
const simtime_t	endTime
const simtime_t	preambleDuration
const simtime_t	headerDuration
const simtime_t	dataDuration
const Coord	startPosition
const Coord	endPosition
const EulerAngles	startOrientation
const EulerAngles	endOrientation

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 }
Static Protected Attributes inherited from inet::physicallayer::ITransmission
static int	nextId = 0

Constructor & Destructor Documentation

inet::physicallayer::TransmissionBase::TransmissionBase	(	const IRadio *	transmitter,
		const cPacket *	macFrame,
		const simtime_t	startTime,
		const simtime_t	endTime,
		const simtime_t	preambleDuration,
		const simtime_t	headerDuration,
		const simtime_t	dataDuration,
		const Coord	startPosition,
		const Coord	endPosition,
		const EulerAngles	startOrientation,
		const EulerAngles	endOrientation
	)

                                                                                                                                                                                                                                                                                                                                                                   :
    id(nextId++),
    transmitter(transmitter),
    macFrame(macFrame),
    startTime(startTime),
    endTime(endTime),
    preambleDuration(preambleDuration),
    headerDuration(headerDuration),
    dataDuration(dataDuration),
    startPosition(startPosition),
    endPosition(endPosition),
    startOrientation(startOrientation),
    endOrientation(endOrientation)
{
}

Member Function Documentation

virtual const ITransmissionAnalogModel* inet::physicallayer::TransmissionBase::getAnalogModel ( ) const

inlineoverridevirtual

Returns the analog model of the transmitted signal.

Implements inet::physicallayer::ITransmission.

Reimplemented in inet::physicallayer::LayeredTransmission.

{ return check_and_cast<const ITransmissionAnalogModel *>(this); }

virtual const simtime_t inet::physicallayer::TransmissionBase::getDataDuration ( ) const

inlineoverridevirtual

Returns the length of the data part of this transmission.

Implements inet::physicallayer::ITransmission.

Referenced by getDuration().

{ return dataDuration; }

virtual const simtime_t inet::physicallayer::TransmissionBase::getDataEndTime ( ) const

inlineoverridevirtual

Implements inet::physicallayer::ITransmission.

Referenced by getEndTime().

{ return endTime; }

virtual const simtime_t inet::physicallayer::TransmissionBase::getDataStartTime ( ) const

inlineoverridevirtual

Implements inet::physicallayer::ITransmission.

Referenced by getStartTime().

{ return endTime - dataDuration; }

virtual const simtime_t inet::physicallayer::TransmissionBase::getDuration ( ) const

inlineoverridevirtual

Returns the total length of this transmission.

Implements inet::physicallayer::ITransmission.

Referenced by getDuration().

{ return endTime - startTime; }

const simtime_t inet::physicallayer::TransmissionBase::getDuration ( IRadioSignal::SignalPart  part ) const

overridevirtual

Returns the length of the provided part of this transmission.

Implements inet::physicallayer::ITransmission.

{
    switch (part) {
        case IRadioSignal::SIGNAL_PART_WHOLE:
            return getDuration();
        case IRadioSignal::SIGNAL_PART_PREAMBLE:
            return getPreambleDuration();
        case IRadioSignal::SIGNAL_PART_HEADER:
            return getHeaderDuration();
        case IRadioSignal::SIGNAL_PART_DATA:
            return getDataDuration();
        default:
            throw cRuntimeError("Unknown signal part: '%s'", IRadioSignal::getSignalPartName(part));
    }
}

virtual const EulerAngles inet::physicallayer::TransmissionBase::getEndOrientation ( ) const

inlineoverridevirtual

Returns the antenna's orientation when the transmitter ended this transmission.

Implements inet::physicallayer::ITransmission.

{ return endOrientation; }

virtual const Coord inet::physicallayer::TransmissionBase::getEndPosition ( ) const

inlineoverridevirtual

Returns the antenna's position when the transmitter ended this transmission.

Implements inet::physicallayer::ITransmission.

{ return endPosition; }

virtual const simtime_t inet::physicallayer::TransmissionBase::getEndTime ( ) const

inlineoverridevirtual

Returns the time when the transmitter ended this transmission.

It is the end of the last bit's transmission.

Implements inet::physicallayer::ITransmission.

Referenced by getEndTime().

{ return endTime; }

const simtime_t inet::physicallayer::TransmissionBase::getEndTime ( IRadioSignal::SignalPart  part ) const

overridevirtual

Implements inet::physicallayer::ITransmission.

{
    switch (part) {
        case IRadioSignal::SIGNAL_PART_WHOLE:
            return getEndTime();
        case IRadioSignal::SIGNAL_PART_PREAMBLE:
            return getPreambleEndTime();
        case IRadioSignal::SIGNAL_PART_HEADER:
            return getHeaderEndTime();
        case IRadioSignal::SIGNAL_PART_DATA:
            return getDataEndTime();
        default:
            throw cRuntimeError("Unknown signal part: '%s'", IRadioSignal::getSignalPartName(part));
    }
}

virtual const simtime_t inet::physicallayer::TransmissionBase::getHeaderDuration ( ) const

inlineoverridevirtual

Returns the length of the header part of this transmission.

Implements inet::physicallayer::ITransmission.

Referenced by getDuration().

{ return headerDuration; }

virtual const simtime_t inet::physicallayer::TransmissionBase::getHeaderEndTime ( ) const

inlineoverridevirtual

Implements inet::physicallayer::ITransmission.

Referenced by getEndTime().

{ return endTime - dataDuration; }

virtual const simtime_t inet::physicallayer::TransmissionBase::getHeaderStartTime ( ) const

inlineoverridevirtual

Implements inet::physicallayer::ITransmission.

Referenced by getStartTime().

{ return startTime + preambleDuration; }

virtual int inet::physicallayer::TransmissionBase::getId ( ) const

inlineoverridevirtual

Returns an identifier for this transmission which is globally unique for the whole lifetime of the simulation among all transmissions.

Implements inet::physicallayer::ITransmission.

{ return id; }

virtual const cPacket* inet::physicallayer::TransmissionBase::getMacFrame ( ) const

inlineoverridevirtual

Returns the MAC frame corresponding to this transmission.

This function never returns nullptr.

Implements inet::physicallayer::ITransmission.

Reimplemented in inet::physicallayer::LayeredTransmission.

{ return macFrame; }

virtual const cPacket* inet::physicallayer::TransmissionBase::getPhyFrame ( ) const

inlineoverridevirtual

Returns the PHY frame corresponding to this transmission.

This function may return nullptr.

Implements inet::physicallayer::ITransmission.

Reimplemented in inet::physicallayer::LayeredTransmission.

{ return nullptr; }

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

inlineoverridevirtual

Returns the length of the preamble part of this transmission.

Implements inet::physicallayer::ITransmission.

Referenced by getDuration().

{ return preambleDuration; }

virtual const simtime_t inet::physicallayer::TransmissionBase::getPreambleEndTime ( ) const

inlineoverridevirtual

Implements inet::physicallayer::ITransmission.

Referenced by getEndTime().

{ return startTime + preambleDuration; }

virtual const simtime_t inet::physicallayer::TransmissionBase::getPreambleStartTime ( ) const

inlineoverridevirtual

Implements inet::physicallayer::ITransmission.

Referenced by getStartTime().

{ return startTime; }

virtual const EulerAngles inet::physicallayer::TransmissionBase::getStartOrientation ( ) const

inlineoverridevirtual

Returns the antenna's orientation when the transmitter started this transmission.

Implements inet::physicallayer::ITransmission.

{ return startOrientation; }

virtual const Coord inet::physicallayer::TransmissionBase::getStartPosition ( ) const

inlineoverridevirtual

Returns the antenna's position when the transmitter started this transmission.

Implements inet::physicallayer::ITransmission.

{ return startPosition; }

virtual const simtime_t inet::physicallayer::TransmissionBase::getStartTime ( ) const

inlineoverridevirtual

Returns the time when the transmitter started this transmission.

It is the start of the first bit's transmission.

Implements inet::physicallayer::ITransmission.

Referenced by getStartTime().

{ return startTime; }

const simtime_t inet::physicallayer::TransmissionBase::getStartTime ( IRadioSignal::SignalPart  part ) const

overridevirtual

Implements inet::physicallayer::ITransmission.

{
    switch (part) {
        case IRadioSignal::SIGNAL_PART_WHOLE:
            return getStartTime();
        case IRadioSignal::SIGNAL_PART_PREAMBLE:
            return getPreambleStartTime();
        case IRadioSignal::SIGNAL_PART_HEADER:
            return getHeaderStartTime();
        case IRadioSignal::SIGNAL_PART_DATA:
            return getDataStartTime();
        default:
            throw cRuntimeError("Unknown signal part: '%s'", IRadioSignal::getSignalPartName(part));
    }
}

virtual const IRadio* inet::physicallayer::TransmissionBase::getTransmitter ( ) const

inlineoverridevirtual

Returns the transmitter that transmitted this radio signal on the radio channel.

This function never returns nullptr.

Implements inet::physicallayer::ITransmission.

{ return transmitter; }

std::ostream & inet::physicallayer::TransmissionBase::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.

Reimplemented in inet::physicallayer::LayeredTransmission, inet::physicallayer::IdealTransmission, inet::physicallayer::NarrowbandTransmissionBase, inet::physicallayer::DimensionalTransmission, inet::physicallayer::FlatTransmissionBase, inet::physicallayer::ScalarTransmission, inet::physicallayer::Ieee80211IdealTransmission, inet::physicallayer::Ieee80211DimensionalTransmission, and inet::physicallayer::Ieee80211ScalarTransmission.

Referenced by inet::physicallayer::NarrowbandTransmissionBase::printToStream(), inet::physicallayer::IdealTransmission::printToStream(), and inet::physicallayer::LayeredTransmission::printToStream().

{
    if (level <= PRINT_LEVEL_DETAIL)
        stream << ", id = " << id;
    if (level <= PRINT_LEVEL_TRACE)
        stream << ", transmitterId = " << transmitter->getId()
               << ", startTime = " << startTime
               << ", endTime = " << endTime
               << ", startPosition = " << startPosition
               << ", preambleDuration = " << preambleDuration
               << ", headerPosition = " << headerDuration
               << ", dataPosition = " << dataDuration
               << ", endPosition = " << endPosition
               << ", startOrientation = " << startOrientation
               << ", endOrientation = " << endOrientation;
    return stream;
}

Member Data Documentation

const simtime_t inet::physicallayer::TransmissionBase::dataDuration

protected

Referenced by printToStream().

const EulerAngles inet::physicallayer::TransmissionBase::endOrientation

protected

Referenced by printToStream().

const Coord inet::physicallayer::TransmissionBase::endPosition

protected

Referenced by printToStream().

const simtime_t inet::physicallayer::TransmissionBase::endTime

protected

Referenced by printToStream().

const simtime_t inet::physicallayer::TransmissionBase::headerDuration

protected

Referenced by printToStream().

const int inet::physicallayer::TransmissionBase::id

protected

Referenced by printToStream().

const cPacket* inet::physicallayer::TransmissionBase::macFrame

protected

const simtime_t inet::physicallayer::TransmissionBase::preambleDuration

protected

Referenced by printToStream().

const EulerAngles inet::physicallayer::TransmissionBase::startOrientation

protected

Referenced by printToStream().

const Coord inet::physicallayer::TransmissionBase::startPosition

protected

Referenced by printToStream().

const simtime_t inet::physicallayer::TransmissionBase::startTime

protected

Referenced by printToStream().

const IRadio* inet::physicallayer::TransmissionBase::transmitter

protected

Referenced by printToStream().

---

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

• TransmissionBase.h
• TransmissionBase.cc