INET Framework for OMNeT++/OMNEST
inet::physicallayer::UnitDiskTransmission Class Reference

This model characterizes transmissions with the communication range, interference range, and detection range. More...

#include <UnitDiskTransmission.h>

Inheritance diagram for inet::physicallayer::UnitDiskTransmission:
inet::physicallayer::TransmissionBase inet::physicallayer::ITransmission inet::physicallayer::ITransmissionAnalogModel inet::IPrintableObject inet::physicallayer::ISignalAnalogModel inet::IPrintableObject inet::physicallayer::Ieee80211UnitDiskTransmission

Public Member Functions

 UnitDiskTransmission (const IRadio *transmitter, const Packet *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 Quaternion &startOrientation, const Quaternion &endOrientation, m communicationRange, m interferenceRange, m detectionRange)
 
virtual std::ostream & printToStream (std::ostream &stream, int level, int evFlags=0) const override
 Prints this object to the provided output stream. More...
 
virtual m getCommunicationRange () const
 
virtual m getInterferenceRange () const
 
virtual m getDetectionRange () const
 
- Public Member Functions inherited from inet::physicallayer::TransmissionBase
 TransmissionBase (const IRadio *transmitter, const Packet *packet, 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 Quaternion &startOrientation, const Quaternion &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 const IRadiogetTransmitter () const override
 Returns the transmitter that transmitted this radio signal on the radio channel. More...
 
virtual int getTransmitterId () const override
 Returns the transmitter's id that transmitted this radio signal on the radio channel. More...
 
virtual const IAntennaGaingetTransmitterAntennaGain () const override
 Returns the gain of the transmitting antenna. More...
 
virtual const IRadioMediumgetMedium () const override
 Returns the radio medium used for this transmission. More...
 
virtual const PacketgetPacket () const override
 Returns the packet 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 CoordgetStartPosition () const override
 Returns the antenna's position when the transmitter started this transmission. More...
 
virtual const CoordgetEndPosition () const override
 Returns the antenna's position when the transmitter ended this transmission. More...
 
virtual const QuaterniongetStartOrientation () const override
 Returns the antenna's orientation when the transmitter started this transmission. More...
 
virtual const QuaterniongetEndOrientation () const override
 Returns the antenna's orientation when the transmitter ended this transmission. More...
 
virtual const ITransmissionAnalogModelgetAnalogModel () const override
 Returns the analog model of the transmitted signal. 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 Attributes

const m communicationRange
 
const m interferenceRange
 
const m detectionRange
 
- Protected Attributes inherited from inet::physicallayer::TransmissionBase
const int id
 
const IRadioMediumradioMedium
 
const int transmitterId
 
Ptr< const IAntennaGaintransmitterGain
 
const Packetpacket
 
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 Quaternion startOrientation
 
const Quaternion endOrientation
 

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

Detailed Description

This model characterizes transmissions with the communication range, interference range, and detection range.

Constructor & Destructor Documentation

◆ UnitDiskTransmission()

inet::physicallayer::UnitDiskTransmission::UnitDiskTransmission ( const IRadio transmitter,
const Packet 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 Quaternion startOrientation,
const Quaternion endOrientation,
m  communicationRange,
m  interferenceRange,
m  detectionRange 
)

Member Function Documentation

◆ getCommunicationRange()

virtual m inet::physicallayer::UnitDiskTransmission::getCommunicationRange ( ) const
inlinevirtual
33 { return communicationRange; }

◆ getDetectionRange()

virtual m inet::physicallayer::UnitDiskTransmission::getDetectionRange ( ) const
inlinevirtual
35 { return detectionRange; }

◆ getInterferenceRange()

virtual m inet::physicallayer::UnitDiskTransmission::getInterferenceRange ( ) const
inlinevirtual
34 { return interferenceRange; }

◆ printToStream()

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

Prints this object to the provided output stream.

Reimplemented from inet::physicallayer::TransmissionBase.

Reimplemented in inet::physicallayer::Ieee80211UnitDiskTransmission.

23 {
24  stream << "UnitDiskTransmission";
25  if (level <= PRINT_LEVEL_INFO)
26  stream << EV_FIELD(communicationRange);
27  if (level <= PRINT_LEVEL_TRACE)
28  stream << EV_FIELD(interferenceRange)
30  return TransmissionBase::printToStream(stream, level);
31 }

Referenced by inet::physicallayer::Ieee80211UnitDiskTransmission::printToStream().

Member Data Documentation

◆ communicationRange

const m inet::physicallayer::UnitDiskTransmission::communicationRange
protected

Referenced by printToStream().

◆ detectionRange

const m inet::physicallayer::UnitDiskTransmission::detectionRange
protected

Referenced by printToStream().

◆ interferenceRange

const m inet::physicallayer::UnitDiskTransmission::interferenceRange
protected

Referenced by printToStream().


The documentation for this class was generated from the following files:
inet::physicallayer::TransmissionBase::preambleDuration
const simtime_t preambleDuration
Definition: TransmissionBase.h:31
inet::physicallayer::TransmissionBase::dataDuration
const simtime_t dataDuration
Definition: TransmissionBase.h:33
inet::IPrintableObject::PRINT_LEVEL_INFO
@ PRINT_LEVEL_INFO
Definition: IPrintableObject.h:25
inet::physicallayer::TransmissionBase::startTime
const simtime_t startTime
Definition: TransmissionBase.h:29
inet::physicallayer::UnitDiskTransmission::interferenceRange
const m interferenceRange
Definition: UnitDiskTransmission.h:25
inet::physicallayer::TransmissionBase::endOrientation
const Quaternion endOrientation
Definition: TransmissionBase.h:37
inet::physicallayer::UnitDiskTransmission::communicationRange
const m communicationRange
Definition: UnitDiskTransmission.h:24
EV_FIELD
#define EV_FIELD(...)
Definition: INETDefs.h:112
inet::physicallayer::TransmissionBase::endPosition
const Coord endPosition
Definition: TransmissionBase.h:35
inet::IPrintableObject::PRINT_LEVEL_TRACE
@ PRINT_LEVEL_TRACE
Definition: IPrintableObject.h:22
inet::physicallayer::TransmissionBase::endTime
const simtime_t endTime
Definition: TransmissionBase.h:30
inet::physicallayer::TransmissionBase::startPosition
const Coord startPosition
Definition: TransmissionBase.h:34
inet::physicallayer::TransmissionBase::printToStream
virtual std::ostream & printToStream(std::ostream &stream, int level, int evFlags=0) const override
Prints this object to the provided output stream.
Definition: TransmissionBase.cc:34
inet::physicallayer::TransmissionBase::startOrientation
const Quaternion startOrientation
Definition: TransmissionBase.h:36
inet::physicallayer::TransmissionBase::TransmissionBase
TransmissionBase(const IRadio *transmitter, const Packet *packet, 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 Quaternion &startOrientation, const Quaternion &endOrientation)
Definition: TransmissionBase.cc:16
inet::physicallayer::TransmissionBase::headerDuration
const simtime_t headerDuration
Definition: TransmissionBase.h:32
inet::physicallayer::UnitDiskTransmission::detectionRange
const m detectionRange
Definition: UnitDiskTransmission.h:26