INET Framework for OMNeT++/OMNEST
inet::physicallayer::IRadioSignal Class Referenceabstract

#include <IRadioSignal.h>

Public Types

enum  SignalPart {
  SIGNAL_PART_NONE = -1, SIGNAL_PART_WHOLE, SIGNAL_PART_PREAMBLE, SIGNAL_PART_HEADER,
  SIGNAL_PART_DATA
}
 This enumeration specifies a part of a radio signal. More...
 

Public Member Functions

virtual const simtime_t getStartTime () const =0
 Returns the time when the signal starts at the start position. More...
 
virtual const simtime_t getEndTime () const =0
 Returns the time when the signal ends at the end position. More...
 
virtual const Coord getStartPosition () const =0
 Returns the position where the signal starts at the start time. More...
 
virtual const Coord getEndPosition () const =0
 Returns the position where the signal ends at the end time. More...
 

Static Public Member Functions

static const char * getSignalPartName (SignalPart signalPart)
 Returns the name of the provided signal part. More...
 

Static Protected Attributes

static cEnum * signalPartEnum = nullptr
 The enumeration registered for signal part. More...
 

Member Enumeration Documentation

This enumeration specifies a part of a radio signal.

Enumerator
SIGNAL_PART_NONE 
SIGNAL_PART_WHOLE 
SIGNAL_PART_PREAMBLE 
SIGNAL_PART_HEADER 
SIGNAL_PART_DATA 

Member Function Documentation

virtual const Coord inet::physicallayer::IRadioSignal::getEndPosition ( ) const
pure virtual

Returns the position where the signal ends at the end time.

virtual const simtime_t inet::physicallayer::IRadioSignal::getEndTime ( ) const
pure virtual

Returns the time when the signal ends at the end position.

const char * inet::physicallayer::IRadioSignal::getSignalPartName ( SignalPart  signalPart)
static

Returns the name of the provided signal part.

Referenced by inet::physicallayer::Radio::abortReception(), inet::physicallayer::Radio::abortTransmission(), inet::physicallayer::APSKErrorModel::computePacketErrorRate(), inet::physicallayer::Ieee80211ErrorModelBase::computePacketErrorRate(), inet::physicallayer::StochasticErrorModel::computePacketErrorRate(), inet::physicallayer::Radio::continueReception(), inet::physicallayer::Radio::continueTransmission(), inet::physicallayer::Radio::endReception(), inet::physicallayer::Radio::endTransmission(), inet::physicallayer::ReceptionBase::getDuration(), inet::physicallayer::TransmissionBase::getDuration(), inet::physicallayer::Arrival::getEndTime(), inet::physicallayer::ReceptionBase::getEndTime(), inet::physicallayer::TransmissionBase::getEndTime(), inet::physicallayer::Arrival::getStartTime(), inet::physicallayer::ReceptionBase::getStartTime(), inet::physicallayer::TransmissionBase::getStartTime(), inet::physicallayer::Radio::startReception(), inet::physicallayer::Radio::startTransmission(), and inet::physicallayer::Radio::updateTransceiverPart().

34 {
35  if (signalPartEnum == nullptr)
36  signalPartEnum = cEnum::get(opp_typename(typeid(IRadioSignal::SignalPart)));
37  return signalPartEnum->getStringFor(signalPart) + 12;
38 }
SignalPart
This enumeration specifies a part of a radio signal.
Definition: IRadioSignal.h:36
static cEnum * signalPartEnum
The enumeration registered for signal part.
Definition: IRadioSignal.h:49
virtual const Coord inet::physicallayer::IRadioSignal::getStartPosition ( ) const
pure virtual

Returns the position where the signal starts at the start time.

virtual const simtime_t inet::physicallayer::IRadioSignal::getStartTime ( ) const
pure virtual

Returns the time when the signal starts at the start position.

Member Data Documentation

cEnum * inet::physicallayer::IRadioSignal::signalPartEnum = nullptr
staticprotected

The enumeration registered for signal part.

Referenced by getSignalPartName().


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