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

This model characterizes receptions with a simplified reception power that falls into one of the categories: receivable, interfering, detectable, and undetectable. More...

#include <UnitDiskReception.h>

Inheritance diagram for inet::physicallayer::UnitDiskReception:
inet::physicallayer::ReceptionBase inet::physicallayer::IReception inet::physicallayer::IReceptionAnalogModel inet::IPrintableObject inet::physicallayer::ISignalAnalogModel inet::IPrintableObject

Public Types

enum  Power { POWER_UNDETECTABLE, POWER_DETECTABLE, POWER_INTERFERING, POWER_RECEIVABLE }
 
- 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) }
 

Public Member Functions

 UnitDiskReception (const IRadio *radio, const ITransmission *transmission, const simtime_t startTime, const simtime_t endTime, const Coord &startPosition, const Coord &endPosition, const Quaternion &startOrientation, const Quaternion &endOrientation, const Power power)
 
virtual std::ostream & printToStream (std::ostream &stream, int level, int evFlags=0) const override
 Prints this object to the provided output stream. More...
 
virtual Power getPower () const
 
- Public Member Functions inherited from inet::physicallayer::ReceptionBase
 ReceptionBase (const IRadio *receiver, const ITransmission *transmission, const simtime_t startTime, const simtime_t endTime, const Coord &startPosition, const Coord &endPosition, const Quaternion &startOrientation, const Quaternion &endOrientation)
 
virtual const IRadiogetReceiver () const override
 Returns the receiver that received the corresponding transmission from the radio medium. More...
 
virtual const ITransmissiongetTransmission () const override
 Returns the transmission that corresponds to this reception at the receiver. More...
 
virtual const simtime_t getStartTime () const override
 Returns the time when the receiver started to receive the corresponding transmission. More...
 
virtual const simtime_t getEndTime () const override
 Returns the time when the receiver ended to receive the corresponding 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 reception. More...
 
virtual const simtime_t getDuration (IRadioSignal::SignalPart part) const override
 Returns the length of the provided part of this reception. More...
 
virtual const simtime_t getPreambleDuration () const override
 Returns the length of the preamble part of this reception. More...
 
virtual const simtime_t getHeaderDuration () const override
 Returns the length of the header part of this reception. More...
 
virtual const simtime_t getDataDuration () const override
 Returns the length of the data part of this reception. More...
 
virtual const CoordgetStartPosition () const override
 Returns the antenna's position when the receiver started to receive the corresponding transmission. More...
 
virtual const CoordgetEndPosition () const override
 Returns the antenna's position when the receiver ended to receive the corresponding transmission. More...
 
virtual const QuaterniongetStartOrientation () const override
 Returns the antenna's orientation when the receiver started to receive the corresponding transmission. More...
 
virtual const QuaterniongetEndOrientation () const override
 Returns the antenna's orientation when the receiver ended to receive the corresponding transmission. More...
 
virtual const IReceptionAnalogModelgetAnalogModel () const override
 Returns the analog model of the received 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 Power power
 
- Protected Attributes inherited from inet::physicallayer::ReceptionBase
const IRadioreceiver
 
const ITransmissiontransmission
 
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
 

Detailed Description

This model characterizes receptions with a simplified reception power that falls into one of the categories: receivable, interfering, detectable, and undetectable.

Member Enumeration Documentation

◆ Power

Enumerator
POWER_UNDETECTABLE 
POWER_DETECTABLE 
POWER_INTERFERING 
POWER_RECEIVABLE 

Constructor & Destructor Documentation

◆ UnitDiskReception()

inet::physicallayer::UnitDiskReception::UnitDiskReception ( const IRadio radio,
const ITransmission transmission,
const simtime_t  startTime,
const simtime_t  endTime,
const Coord startPosition,
const Coord endPosition,
const Quaternion startOrientation,
const Quaternion endOrientation,
const Power  power 
)

Member Function Documentation

◆ getPower()

virtual Power inet::physicallayer::UnitDiskReception::getPower ( ) const
inlinevirtual
39 { return power; }

◆ printToStream()

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

Prints this object to the provided output stream.

Reimplemented from inet::physicallayer::ReceptionBase.

27 {
28  stream << "UnitDiskReception";
29  if (level <= PRINT_LEVEL_INFO)
30  stream << EV_FIELD(power, cEnum::get(opp_typename(typeid(UnitDiskReception::Power)))->getStringFor(power) + 6);
31  return ReceptionBase::printToStream(stream, level);
32 }

Member Data Documentation

◆ power

const Power inet::physicallayer::UnitDiskReception::power
protected

Referenced by printToStream().


The documentation for this class was generated from the following files:
inet::physicallayer::ReceptionBase::endPosition
const Coord endPosition
Definition: ReceptionBase.h:30
inet::physicallayer::ReceptionBase::transmission
const ITransmission * transmission
Definition: ReceptionBase.h:23
inet::physicallayer::UnitDiskReception::power
const Power power
Definition: UnitDiskReception.h:33
inet::physicallayer::ReceptionBase::startTime
const simtime_t startTime
Definition: ReceptionBase.h:24
inet::physicallayer::ReceptionBase::startOrientation
const Quaternion startOrientation
Definition: ReceptionBase.h:31
inet::IPrintableObject::PRINT_LEVEL_INFO
@ PRINT_LEVEL_INFO
Definition: IPrintableObject.h:25
inet::physicallayer::ReceptionBase::ReceptionBase
ReceptionBase(const IRadio *receiver, const ITransmission *transmission, const simtime_t startTime, const simtime_t endTime, const Coord &startPosition, const Coord &endPosition, const Quaternion &startOrientation, const Quaternion &endOrientation)
Definition: ReceptionBase.cc:14
inet::physicallayer::UnitDiskReception::Power
Power
Definition: UnitDiskReception.h:25
inet::physicallayer::ReceptionBase::endTime
const simtime_t endTime
Definition: ReceptionBase.h:25
inet::physicallayer::ReceptionBase::endOrientation
const Quaternion endOrientation
Definition: ReceptionBase.h:32
EV_FIELD
#define EV_FIELD(...)
Definition: INETDefs.h:112
inet::physicallayer::UnitDiskReception::POWER_DETECTABLE
@ POWER_DETECTABLE
Definition: UnitDiskReception.h:27
inet::physicallayer::UnitDiskReception::POWER_INTERFERING
@ POWER_INTERFERING
Definition: UnitDiskReception.h:28
inet::physicallayer::ReceptionBase::printToStream
virtual std::ostream & printToStream(std::ostream &stream, int level, int evFlags=0) const override
Prints this object to the provided output stream.
Definition: ReceptionBase.cc:29
inet::physicallayer::ReceptionBase::startPosition
const Coord startPosition
Definition: ReceptionBase.h:29
inet::physicallayer::UnitDiskReception::POWER_UNDETECTABLE
@ POWER_UNDETECTABLE
Definition: UnitDiskReception.h:26
inet::physicallayer::UnitDiskReception::POWER_RECEIVABLE
@ POWER_RECEIVABLE
Definition: UnitDiskReception.h:29