INET Framework for OMNeT++/OMNEST
Public Member Functions | Static Protected Attributes | List of all members
inet::physicallayer::ITransmission Class Referenceabstract

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

#include <ITransmission.h>

Inheritance diagram for inet::physicallayer::ITransmission:
inet::physicallayer::IPrintableObject inet::physicallayer::TransmissionBase inet::physicallayer::IdealTransmission inet::physicallayer::LayeredTransmission inet::physicallayer::NarrowbandTransmissionBase inet::physicallayer::Ieee80211IdealTransmission inet::physicallayer::FlatTransmissionBase inet::physicallayer::DimensionalTransmission inet::physicallayer::ScalarTransmission inet::physicallayer::Ieee80211DimensionalTransmission inet::physicallayer::Ieee80211ScalarTransmission

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 const cPacket * getPhyFrame () const =0
 Returns the PHY frame corresponding to this transmission. More...
 
virtual const cPacket * getMacFrame () const =0
 Returns the MAC frame 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 EulerAngles getStartOrientation () const =0
 Returns the antenna's orientation when the transmitter started this transmission. More...
 
virtual const EulerAngles 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::physicallayer::IPrintableObject
virtual ~IPrintableObject ()
 
virtual std::ostream & printToStream (std::ostream &stream, int level) const
 Prints this object to the provided output stream. More...
 
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
 

Static Protected Attributes

static int nextId = 0
 

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
}
 

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 radio frame instance.

This interface is strictly immutable to safely support parallel computation.

Member Function Documentation

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::TwoRayInterference::computePathLoss(), inet::physicallayer::PathLossBase::computePathLoss(), inet::physicallayer::TwoRayGroundReflection::computePathLoss(), inet::physicallayer::ScalarAnalogModel::computeReception(), inet::physicallayer::ScalarAnalogModelBase::computeReceptionPower(), and inet::physicallayer::DimensionalAnalogModelBase::computeReceptionPower().

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().

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

Implemented in inet::physicallayer::TransmissionBase.

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

Implemented in inet::physicallayer::TransmissionBase.

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::createReceiverRadioFrame().

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.

virtual const EulerAngles inet::physicallayer::ITransmission::getEndOrientation ( ) const
pure virtual

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

Implemented in inet::physicallayer::TransmissionBase.

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().

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(), inet::physicallayer::DimensionalAnalogModelBase::computeReceptionPower(), inet::visualizer::MediumVisualizerBase::isSignalPropagationInProgress(), inet::visualizer::MediumVisualizerBase::isSignalTransmissionInProgress(), inet::visualizer::MediumCanvasVisualizer::refreshSignalFigure(), and inet::physicallayer::CommunicationLog::writeTransmission().

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

Implemented in inet::physicallayer::TransmissionBase.

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().

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

Implemented in inet::physicallayer::TransmissionBase.

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

Implemented in inet::physicallayer::TransmissionBase.

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::VectorCommunicationCache::addTransmission(), inet::physicallayer::ReceiverBase::computeIsReceptionAttempted(), inet::visualizer::MediumCanvasVisualizer::createSignalFigure(), inet::physicallayer::ReferenceCommunicationCache::getTransmissionCacheEntry(), inet::physicallayer::VectorCommunicationCache::getTransmissionCacheEntry(), inet::physicallayer::ReceptionBase::printToStream(), inet::visualizer::MediumCanvasVisualizer::refreshSignalFigure(), inet::physicallayer::CommunicationLog::writeReception(), and inet::physicallayer::CommunicationLog::writeTransmission().

virtual const cPacket* inet::physicallayer::ITransmission::getMacFrame ( ) const
pure virtual

Returns the MAC frame corresponding to this transmission.

This function never returns nullptr.

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

Referenced by inet::physicallayer::RadioMedium::createReceiverRadioFrame(), inet::visualizer::MediumCanvasVisualizer::createSignalFigure(), inet::physicallayer::RadioMedium::isPotentialReceiver(), inet::visualizer::MediumVisualizerBase::matchesTransmission(), and inet::physicallayer::ReceptionResult::ReceptionResult().

virtual const cPacket* inet::physicallayer::ITransmission::getPhyFrame ( ) const
pure virtual

Returns the PHY frame corresponding to this transmission.

This function may return nullptr.

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

Referenced by inet::physicallayer::RadioMedium::createReceiverRadioFrame(), and inet::visualizer::MediumVisualizerBase::matchesTransmission().

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().

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

Implemented in inet::physicallayer::TransmissionBase.

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

Implemented in inet::physicallayer::TransmissionBase.

virtual const EulerAngles 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::ScalarAnalogModelBase::computeReceptionPower(), and inet::physicallayer::DimensionalAnalogModelBase::computeReceptionPower().

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.

Referenced by inet::physicallayer::ConstantSpeedPropagation::computeArrival(), inet::physicallayer::TwoRayInterference::computePathLoss(), inet::physicallayer::PathLossBase::computePathLoss(), inet::physicallayer::TwoRayGroundReflection::computePathLoss(), inet::physicallayer::IdealAnalogModel::computeReception(), inet::physicallayer::ScalarAnalogModelBase::computeReceptionPower(), inet::physicallayer::DimensionalAnalogModelBase::computeReceptionPower(), inet::physicallayer::AnalogModelBase::computeTransmissionDirection(), inet::visualizer::MediumCanvasVisualizer::createSignalFigure(), inet::physicallayer::RadioMedium::isInCommunicationRange(), inet::physicallayer::RadioMedium::isInInterferenceRange(), inet::visualizer::MediumCanvasVisualizer::receptionStarted(), inet::visualizer::MediumCanvasVisualizer::refreshSignalFigure(), and inet::physicallayer::CommunicationLog::writeTransmission().

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(), inet::visualizer::MediumVisualizerBase::isSignalPropagationInProgress(), inet::visualizer::MediumVisualizerBase::isSignalTransmissionInProgress(), inet::visualizer::MediumCanvasVisualizer::refreshSignalFigure(), and inet::physicallayer::CommunicationLog::writeTransmission().

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

Implemented in inet::physicallayer::TransmissionBase.

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

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

This function never returns nullptr.

Implemented in inet::physicallayer::TransmissionBase.

Referenced by inet::physicallayer::TwoRayInterference::computePathLoss(), inet::physicallayer::PathLossBase::computePathLoss(), inet::physicallayer::TwoRayGroundReflection::computePathLoss(), inet::physicallayer::ScalarAnalogModelBase::computeReceptionPower(), inet::physicallayer::DimensionalAnalogModelBase::computeReceptionPower(), inet::physicallayer::RadioFrame::getArrival(), inet::physicallayer::RadioFrame::getListening(), inet::physicallayer::RadioFrame::getReception(), inet::physicallayer::RadioMedium::isInterferingTransmission(), inet::visualizer::MediumVisualizerBase::matchesTransmission(), inet::visualizer::MediumCanvasVisualizer::transmissionEnded(), and inet::visualizer::MediumCanvasVisualizer::transmissionStarted().

Member Data Documentation

int inet::physicallayer::ITransmission::nextId = 0
staticprotected
The documentation for this class was generated from the following files: