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

#include <Arrival.h>

Inheritance diagram for inet::physicallayer::Arrival:
inet::physicallayer::IArrival inet::IPrintableObject

Public Member Functions

 Arrival (const simtime_t startPropagationTime, const simtime_t endPropagationTime, 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 std::ostream & printToStream (std::ostream &stream, int level, int evFlags=0) const override
 Prints this object to the provided output stream. More...
 
virtual const simtime_t getStartPropagationTime () const override
 
virtual const simtime_t getEndPropagationTime () const override
 
virtual const simtime_t getStartTime () const override
 
virtual const simtime_t getEndTime () const override
 
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 CoordgetStartPosition () const override
 
virtual const CoordgetEndPosition () const override
 
virtual const QuaterniongetStartOrientation () const override
 
virtual const QuaterniongetEndOrientation () const override
 
- 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 simtime_t startPropagationTime
 
const simtime_t endPropagationTime
 
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) }
 

Constructor & Destructor Documentation

◆ Arrival()

inet::physicallayer::Arrival::Arrival ( const simtime_t  startPropagationTime,
const simtime_t  endPropagationTime,
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 
)

Member Function Documentation

◆ getDataEndTime()

virtual const simtime_t inet::physicallayer::Arrival::getDataEndTime ( ) const
inlineoverridevirtual

Implements inet::physicallayer::IArrival.

50 { return endTime; }

Referenced by getEndTime().

◆ getDataStartTime()

virtual const simtime_t inet::physicallayer::Arrival::getDataStartTime ( ) const
inlineoverridevirtual

Implements inet::physicallayer::IArrival.

49 { return endTime - dataDuration; }

Referenced by getStartTime().

◆ getEndOrientation()

virtual const Quaternion& inet::physicallayer::Arrival::getEndOrientation ( ) const
inlineoverridevirtual

Implements inet::physicallayer::IArrival.

56 { return endOrientation; }

◆ getEndPosition()

virtual const Coord& inet::physicallayer::Arrival::getEndPosition ( ) const
inlineoverridevirtual

Implements inet::physicallayer::IArrival.

53 { return endPosition; }

◆ getEndPropagationTime()

virtual const simtime_t inet::physicallayer::Arrival::getEndPropagationTime ( ) const
inlineoverridevirtual

◆ getEndTime() [1/2]

virtual const simtime_t inet::physicallayer::Arrival::getEndTime ( ) const
inlineoverridevirtual

Implements inet::physicallayer::IArrival.

40 { return endTime; }

Referenced by getEndTime().

◆ getEndTime() [2/2]

const simtime_t inet::physicallayer::Arrival::getEndTime ( IRadioSignal::SignalPart  part) const
overridevirtual

Implements inet::physicallayer::IArrival.

63 {
64  switch (part) {
66  return getEndTime();
68  return getPreambleEndTime();
70  return getHeaderEndTime();
72  return getDataEndTime();
73  default:
74  throw cRuntimeError("Unknown signal part: '%s'", IRadioSignal::getSignalPartName(part));
75  }
76 }

◆ getHeaderEndTime()

virtual const simtime_t inet::physicallayer::Arrival::getHeaderEndTime ( ) const
inlineoverridevirtual

Implements inet::physicallayer::IArrival.

48 { return endTime - dataDuration; }

Referenced by getEndTime().

◆ getHeaderStartTime()

virtual const simtime_t inet::physicallayer::Arrival::getHeaderStartTime ( ) const
inlineoverridevirtual

Implements inet::physicallayer::IArrival.

47 { return startTime + preambleDuration; }

Referenced by getStartTime().

◆ getPreambleEndTime()

virtual const simtime_t inet::physicallayer::Arrival::getPreambleEndTime ( ) const
inlineoverridevirtual

Implements inet::physicallayer::IArrival.

46 { return startTime + preambleDuration; }

Referenced by getEndTime().

◆ getPreambleStartTime()

virtual const simtime_t inet::physicallayer::Arrival::getPreambleStartTime ( ) const
inlineoverridevirtual

Implements inet::physicallayer::IArrival.

45 { return startTime; }

Referenced by getStartTime().

◆ getStartOrientation()

virtual const Quaternion& inet::physicallayer::Arrival::getStartOrientation ( ) const
inlineoverridevirtual

Implements inet::physicallayer::IArrival.

55 { return startOrientation; }

◆ getStartPosition()

virtual const Coord& inet::physicallayer::Arrival::getStartPosition ( ) const
inlineoverridevirtual

Implements inet::physicallayer::IArrival.

52 { return startPosition; }

◆ getStartPropagationTime()

virtual const simtime_t inet::physicallayer::Arrival::getStartPropagationTime ( ) const
inlineoverridevirtual

◆ getStartTime() [1/2]

virtual const simtime_t inet::physicallayer::Arrival::getStartTime ( ) const
inlineoverridevirtual

Implements inet::physicallayer::IArrival.

39 { return startTime; }

Referenced by getStartTime().

◆ getStartTime() [2/2]

const simtime_t inet::physicallayer::Arrival::getStartTime ( IRadioSignal::SignalPart  part) const
overridevirtual

Implements inet::physicallayer::IArrival.

47 {
48  switch (part) {
50  return getStartTime();
52  return getPreambleStartTime();
54  return getHeaderStartTime();
56  return getDataStartTime();
57  default:
58  throw cRuntimeError("Unknown signal part: '%s'", IRadioSignal::getSignalPartName(part));
59  }
60 }

◆ printToStream()

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

Prints this object to the provided output stream.

Reimplemented from inet::IPrintableObject.

29 {
30  stream << "Arrival";
31  if (level <= PRINT_LEVEL_TRACE)
35  << EV_FIELD(endTime)
43  return stream;
44 }

Member Data Documentation

◆ dataDuration

const simtime_t inet::physicallayer::Arrival::dataDuration
protected

Referenced by printToStream().

◆ endOrientation

const Quaternion inet::physicallayer::Arrival::endOrientation
protected

Referenced by printToStream().

◆ endPosition

const Coord inet::physicallayer::Arrival::endPosition
protected

Referenced by printToStream().

◆ endPropagationTime

const simtime_t inet::physicallayer::Arrival::endPropagationTime
protected

Referenced by printToStream().

◆ endTime

const simtime_t inet::physicallayer::Arrival::endTime
protected

Referenced by printToStream().

◆ headerDuration

const simtime_t inet::physicallayer::Arrival::headerDuration
protected

Referenced by printToStream().

◆ preambleDuration

const simtime_t inet::physicallayer::Arrival::preambleDuration
protected

Referenced by printToStream().

◆ startOrientation

const Quaternion inet::physicallayer::Arrival::startOrientation
protected

Referenced by printToStream().

◆ startPosition

const Coord inet::physicallayer::Arrival::startPosition
protected

Referenced by printToStream().

◆ startPropagationTime

const simtime_t inet::physicallayer::Arrival::startPropagationTime
protected

Referenced by printToStream().

◆ startTime

const simtime_t inet::physicallayer::Arrival::startTime
protected

Referenced by printToStream().


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::Arrival::getDataStartTime
virtual const simtime_t getDataStartTime() const override
Definition: Arrival.h:49
inet::physicallayer::Arrival::endOrientation
const Quaternion endOrientation
Definition: Arrival.h:29
inet::physicallayer::Arrival::startPosition
const Coord startPosition
Definition: Arrival.h:26
inet::physicallayer::Arrival::preambleDuration
const simtime_t preambleDuration
Definition: Arrival.h:23
inet::physicallayer::Arrival::startPropagationTime
const simtime_t startPropagationTime
Definition: Arrival.h:19
inet::physicallayer::Arrival::getHeaderEndTime
virtual const simtime_t getHeaderEndTime() const override
Definition: Arrival.h:48
inet::physicallayer::Arrival::getEndTime
virtual const simtime_t getEndTime() const override
Definition: Arrival.h:40
inet::physicallayer::Arrival::getStartTime
virtual const simtime_t getStartTime() const override
Definition: Arrival.h:39
inet::physicallayer::Arrival::getPreambleEndTime
virtual const simtime_t getPreambleEndTime() const override
Definition: Arrival.h:46
inet::physicallayer::Arrival::getHeaderStartTime
virtual const simtime_t getHeaderStartTime() const override
Definition: Arrival.h:47
inet::physicallayer::IRadioSignal::SIGNAL_PART_HEADER
@ SIGNAL_PART_HEADER
Definition: IRadioSignal.h:28
inet::physicallayer::Arrival::dataDuration
const simtime_t dataDuration
Definition: Arrival.h:25
inet::physicallayer::IRadioSignal::SIGNAL_PART_PREAMBLE
@ SIGNAL_PART_PREAMBLE
Definition: IRadioSignal.h:27
EV_FIELD
#define EV_FIELD(...)
Definition: INETDefs.h:112
inet::physicallayer::Arrival::startOrientation
const Quaternion startOrientation
Definition: Arrival.h:28
inet::physicallayer::Arrival::endPropagationTime
const simtime_t endPropagationTime
Definition: Arrival.h:20
inet::IPrintableObject::PRINT_LEVEL_TRACE
@ PRINT_LEVEL_TRACE
Definition: IPrintableObject.h:22
inet::physicallayer::IRadioSignal::getSignalPartName
static const char * getSignalPartName(SignalPart signalPart)
Returns the name of the provided signal part.
Definition: IRadioSignal.cc:23
inet::physicallayer::IRadioSignal::SIGNAL_PART_DATA
@ SIGNAL_PART_DATA
Definition: IRadioSignal.h:29
inet::physicallayer::Arrival::startTime
const simtime_t startTime
Definition: Arrival.h:21
inet::physicallayer::Arrival::endTime
const simtime_t endTime
Definition: Arrival.h:22
inet::physicallayer::Arrival::endPosition
const Coord endPosition
Definition: Arrival.h:27
inet::physicallayer::Arrival::getPreambleStartTime
virtual const simtime_t getPreambleStartTime() const override
Definition: Arrival.h:45
inet::physicallayer::Arrival::headerDuration
const simtime_t headerDuration
Definition: Arrival.h:24
inet::physicallayer::Arrival::getDataEndTime
virtual const simtime_t getDataEndTime() const override
Definition: Arrival.h:50