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 CoordgetStartPosition () const =0
 Returns the position where the signal starts at the start time. More...
 
virtual const CoordgetEndPosition () 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

◆ SignalPart

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

◆ getEndPosition()

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

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

◆ getEndTime()

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

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

◆ getSignalPartName()

◆ getStartPosition()

virtual const Coord& inet::physicallayer::IRadioSignal::getStartPosition ( ) const
pure virtual

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

◆ getStartTime()

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

◆ signalPartEnum

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:
inet::physicallayer::IRadioSignal::SIGNAL_PART_WHOLE
@ SIGNAL_PART_WHOLE
Definition: IRadioSignal.h:26
inet::physicallayer::IRadioSignal::SIGNAL_PART_NONE
@ SIGNAL_PART_NONE
Definition: IRadioSignal.h:25
inet::physicallayer::IRadioSignal::SIGNAL_PART_HEADER
@ SIGNAL_PART_HEADER
Definition: IRadioSignal.h:28
inet::physicallayer::IRadioSignal::SIGNAL_PART_PREAMBLE
@ SIGNAL_PART_PREAMBLE
Definition: IRadioSignal.h:27
inet::physicallayer::IRadioSignal::signalPartEnum
static cEnum * signalPartEnum
The enumeration registered for signal part.
Definition: IRadioSignal.h:36
inet::physicallayer::IRadioSignal::SignalPart
SignalPart
This enumeration specifies a part of a radio signal.
Definition: IRadioSignal.h:24
inet::physicallayer::IRadioSignal::SIGNAL_PART_DATA
@ SIGNAL_PART_DATA
Definition: IRadioSignal.h:29