This interface represents the transmission of a radio signal. More...

#include <ITransmission.h>

Inheritance diagram for inet::physicallayer::ITransmission:

Public Member Functions
virtual int	getId () const =0
	Returns an identifier for this transmission which is globally unique for the whole lifetime of the simulation among all transmissions. More...

virtual const IRadio *	getTransmitter () const =0
	Returns the transmitter that transmitted this radio signal on the radio channel. More...

virtual int	getTransmitterId () const =0
	Returns the transmitter's id that transmitted this radio signal on the radio channel. More...

virtual const IAntennaGain *	getTransmitterAntennaGain () const =0
	Returns the gain of the transmitting antenna. More...

virtual const IRadioMedium *	getMedium () const =0
	Returns the radio medium used for this transmission. More...

virtual const Packet *	getPacket () const =0
	Returns the packet corresponding to this transmission. More...

virtual const simtime_t	getStartTime () const =0
	Returns the time when the transmitter started this transmission. More...

virtual const simtime_t	getEndTime () const =0
	Returns the time when the transmitter ended this transmission. More...

virtual const simtime_t	getStartTime (IRadioSignal::SignalPart part) const =0

virtual const simtime_t	getEndTime (IRadioSignal::SignalPart part) const =0

virtual const simtime_t	getPreambleStartTime () const =0

virtual const simtime_t	getPreambleEndTime () const =0

virtual const simtime_t	getHeaderStartTime () const =0

virtual const simtime_t	getHeaderEndTime () const =0

virtual const simtime_t	getDataStartTime () const =0

virtual const simtime_t	getDataEndTime () const =0

virtual const simtime_t	getDuration () const =0
	Returns the total length of this transmission. More...

virtual const simtime_t	getDuration (IRadioSignal::SignalPart part) const =0
	Returns the length of the provided part of this transmission. More...

virtual const simtime_t	getPreambleDuration () const =0
	Returns the length of the preamble part of this transmission. More...

virtual const simtime_t	getHeaderDuration () const =0
	Returns the length of the header part of this transmission. More...

virtual const simtime_t	getDataDuration () const =0
	Returns the length of the data part of this transmission. More...

virtual const Coord &	getStartPosition () const =0
	Returns the antenna's position when the transmitter started this transmission. More...

virtual const Coord &	getEndPosition () const =0
	Returns the antenna's position when the transmitter ended this transmission. More...

virtual const Quaternion &	getStartOrientation () const =0
	Returns the antenna's orientation when the transmitter started this transmission. More...

virtual const Quaternion &	getEndOrientation () const =0
	Returns the antenna's orientation when the transmitter ended this transmission. More...

virtual const ITransmissionAnalogModel *	getAnalogModel () const =0
	Returns the analog model of the transmitted signal. More...

Public Member Functions inherited from inet::IPrintableObject
virtual	~IPrintableObject ()

virtual std::ostream &	printToStream (std::ostream &stream, int level, int evFlags=0) const
	Prints this object to the provided output stream. More...

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

Static Protected Attributes
static int	nextId = 0

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

This interface represents the transmission of a radio signal.

There's one instance per transmission of this interface that is sent to all potential receiver radios in a separate signal instance.

This interface is strictly immutable to safely support parallel computation.

Member Function Documentation

◆ getAnalogModel()

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

pure virtual

Returns the analog model of the transmitted signal.

Implemented in inet::physicallayer::TransmissionBase, and inet::physicallayer::LayeredTransmission.

Referenced by inet::physicallayer::PathLossBase::computePathLoss(), inet::physicallayer::TwoRayInterference::computePathLoss(), inet::physicallayer::ScalarAnalogModel::computeReception(), inet::physicallayer::DimensionalAnalogModelBase::computeReceptionPower(), inet::physicallayer::ScalarAnalogModelBase::computeReceptionPower(), and inet::physicallayer::TwoRayGroundReflection::initialize().

◆ getDataDuration()

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

pure virtual

Returns the length of the data part of this transmission.

Implemented in inet::physicallayer::TransmissionBase.

Referenced by inet::physicallayer::ConstantTimePropagation::computeArrival(), and inet::physicallayer::ConstantSpeedPropagation::computeArrival().

◆ getDataEndTime()

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

pure virtual

Implemented in inet::physicallayer::TransmissionBase.

◆ getDataStartTime()

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

pure virtual

Implemented in inet::physicallayer::TransmissionBase.

◆ getDuration() [1/2]

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

pure virtual

Returns the total length of this transmission.

Implemented in inet::physicallayer::TransmissionBase.

Referenced by inet::physicallayer::RadioMedium::createReceiverSignal(), inet::physicallayer::NoiseSource::scheduleTransmissionTimer(), and inet::physicallayer::RadioMedium::sendToRadio().

◆ getDuration() [2/2]

virtual const simtime_t inet::physicallayer::ITransmission::getDuration ( IRadioSignal::SignalPart part ) const

pure virtual

Returns the length of the provided part of this transmission.

Implemented in inet::physicallayer::TransmissionBase.

◆ getEndOrientation()

virtual const Quaternion& inet::physicallayer::ITransmission::getEndOrientation ( ) const

pure virtual

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

Implemented in inet::physicallayer::TransmissionBase.

◆ getEndPosition()

virtual const Coord& inet::physicallayer::ITransmission::getEndPosition ( ) const

pure virtual

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

Implemented in inet::physicallayer::TransmissionBase.

Referenced by inet::physicallayer::ConstantSpeedPropagation::computeArrival(), inet::physicallayer::RadioMedium::isInCommunicationRange(), inet::physicallayer::RadioMedium::isInInterferenceRange(), and inet::physicallayer::CommunicationLog::writeTransmission().

◆ getEndTime() [1/2]

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

pure virtual

Returns the time when the transmitter ended this transmission.

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

Implemented in inet::physicallayer::TransmissionBase.

Referenced by inet::physicallayer::RadioMedium::addTransmission(), inet::physicallayer::ConstantTimePropagation::computeArrival(), inet::physicallayer::ConstantSpeedPropagation::computeArrival(), and inet::physicallayer::CommunicationLog::writeTransmission().

◆ getEndTime() [2/2]

virtual const simtime_t inet::physicallayer::ITransmission::getEndTime ( IRadioSignal::SignalPart part ) const

pure virtual

Implemented in inet::physicallayer::TransmissionBase.

◆ getHeaderDuration()

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

pure virtual

Returns the length of the header part of this transmission.

Implemented in inet::physicallayer::TransmissionBase.

Referenced by inet::physicallayer::ConstantTimePropagation::computeArrival(), and inet::physicallayer::ConstantSpeedPropagation::computeArrival().

◆ getHeaderEndTime()

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

pure virtual

Implemented in inet::physicallayer::TransmissionBase.

◆ getHeaderStartTime()

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

pure virtual

Implemented in inet::physicallayer::TransmissionBase.

◆ getId()

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

pure virtual

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

Implemented in inet::physicallayer::TransmissionBase.

Referenced by inet::physicallayer::ReferenceCommunicationCache::addTransmission(), inet::physicallayer::VectorCommunicationCache::addTransmission(), inet::physicallayer::ReceiverBase::computeIsReceptionAttempted(), inet::physicallayer::ReferenceCommunicationCache::getTransmissionCacheEntry(), inet::physicallayer::MapCommunicationCache::getTransmissionCacheEntry(), inet::physicallayer::VectorCommunicationCache::getTransmissionCacheEntry(), inet::physicallayer::ReceptionBase::printToStream(), inet::physicallayer::MapCommunicationCache::removeTransmission(), inet::physicallayer::VectorCommunicationCache::removeTransmission(), inet::physicallayer::CommunicationLog::writeReception(), and inet::physicallayer::CommunicationLog::writeTransmission().

◆ getMedium()

virtual const IRadioMedium* inet::physicallayer::ITransmission::getMedium ( ) const

pure virtual

Returns the radio medium used for this transmission.

This function never return nullptr.

Implemented in inet::physicallayer::TransmissionBase.

Referenced by inet::physicallayer::PathLossBase::computePathLoss(), inet::physicallayer::TwoRayInterference::computePathLoss(), inet::physicallayer::ReceiverBase::computeSignalPower(), and inet::physicallayer::TwoRayGroundReflection::initialize().

◆ getPacket()

virtual const Packet* inet::physicallayer::ITransmission::getPacket ( ) const

pure virtual

Returns the packet corresponding to this transmission.

This function never returns nullptr.

Implemented in inet::physicallayer::TransmissionBase, and inet::physicallayer::LayeredTransmission.

Referenced by inet::physicallayer::ErrorModelBase::computeCorruptedPacket(), inet::physicallayer::ReceiverBase::computeReceivedPacket(), inet::physicallayer::RadioMedium::createReceiverSignal(), inet::physicallayer::RadioMedium::isPotentialReceiver(), and inet::physicallayer::RadioMedium::pickUpSignals().

◆ getPreambleDuration()

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

pure virtual

Returns the length of the preamble part of this transmission.

Implemented in inet::physicallayer::TransmissionBase.

Referenced by inet::physicallayer::ConstantTimePropagation::computeArrival(), and inet::physicallayer::ConstantSpeedPropagation::computeArrival().

◆ getPreambleEndTime()

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

pure virtual

Implemented in inet::physicallayer::TransmissionBase.

◆ getPreambleStartTime()

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

pure virtual

Implemented in inet::physicallayer::TransmissionBase.

◆ getStartOrientation()

virtual const Quaternion& inet::physicallayer::ITransmission::getStartOrientation ( ) const

pure virtual

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

Implemented in inet::physicallayer::TransmissionBase.

Referenced by inet::physicallayer::DimensionalAnalogModelBase::computeReceptionPower(), and inet::physicallayer::ScalarAnalogModelBase::computeReceptionPower().

◆ getStartPosition()

virtual const Coord& inet::physicallayer::ITransmission::getStartPosition ( ) const

pure virtual

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

Implemented in inet::physicallayer::TransmissionBase.

◆ getStartTime() [1/2]

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

pure virtual

Returns the time when the transmitter started this transmission.

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

Implemented in inet::physicallayer::TransmissionBase.

Referenced by inet::physicallayer::ConstantTimePropagation::computeArrival(), inet::physicallayer::ConstantSpeedPropagation::computeArrival(), inet::physicallayer::DimensionalAnalogModelBase::computeReceptionPower(), and inet::physicallayer::CommunicationLog::writeTransmission().

◆ getStartTime() [2/2]

virtual const simtime_t inet::physicallayer::ITransmission::getStartTime ( IRadioSignal::SignalPart part ) const

pure virtual

Implemented in inet::physicallayer::TransmissionBase.

◆ getTransmitter()

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

pure virtual

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

This function may return nullptr.

Implemented in inet::physicallayer::TransmissionBase.

Referenced by inet::physicallayer::WirelessSignal::getTransmitter().

◆ getTransmitterAntennaGain()

virtual const IAntennaGain* inet::physicallayer::ITransmission::getTransmitterAntennaGain ( ) const

pure virtual

Returns the gain of the transmitting antenna.

Implemented in inet::physicallayer::TransmissionBase.

Referenced by inet::physicallayer::DimensionalAnalogModelBase::computeReceptionPower(), and inet::physicallayer::ScalarAnalogModelBase::computeReceptionPower().

◆ getTransmitterId()

virtual int inet::physicallayer::ITransmission::getTransmitterId ( ) const

pure virtual

Returns the transmitter's id that transmitted this radio signal on the radio channel.

Implemented in inet::physicallayer::TransmissionBase.

Referenced by inet::physicallayer::RadioMedium::isInterferingTransmission(), and inet::physicallayer::RadioMedium::pickUpSignals().

Member Data Documentation

◆ nextId

int inet::physicallayer::ITransmission::nextId = 0

staticprotected

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

Public Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getAnalogModel()

◆ getDataDuration()

◆ getDataEndTime()

◆ getDataStartTime()

◆ getDuration() [1/2]

◆ getDuration() [2/2]

◆ getEndOrientation()

◆ getEndPosition()

◆ getEndTime() [1/2]

◆ getEndTime() [2/2]

◆ getHeaderDuration()

◆ getHeaderEndTime()

◆ getHeaderStartTime()

◆ getId()

◆ getMedium()

◆ getPacket()

◆ getPreambleDuration()

◆ getPreambleEndTime()

◆ getPreambleStartTime()

◆ getStartOrientation()

◆ getStartPosition()

◆ getStartTime() [1/2]

◆ getStartTime() [2/2]

◆ getTransmitter()

◆ getTransmitterAntennaGain()

◆ getTransmitterId()

Member Data Documentation

◆ nextId