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

#include <ReceptionResult.h>

Inheritance diagram for inet::physicallayer::ReceptionResult:
inet::physicallayer::IReceptionResult inet::IPrintableObject inet::physicallayer::LayeredReceptionResult

Public Member Functions

 ReceptionResult (const IReception *reception, const std::vector< const IReceptionDecision * > *decisions, const Packet *packet)
 
virtual ~ReceptionResult ()
 
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 IReceptiongetReception () const override
 Returns the corresponding reception that also specifies the receiver and the received transmission. More...
 
virtual const std::vector< const IReceptionDecision * > * getDecisions () const override
 Returns the reception decisions made by the receiver in the order of received signal parts. More...
 
virtual const PacketgetPacket () const override
 Returns the packet corresponding to this reception. 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 IReceptionreception
 
const std::vector< const IReceptionDecision * > * decisions
 
const Packetpacket
 

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

◆ ReceptionResult()

inet::physicallayer::ReceptionResult::ReceptionResult ( const IReception reception,
const std::vector< const IReceptionDecision * > *  decisions,
const Packet packet 
)
13  :
16  packet(packet)
17 {
18 }

◆ ~ReceptionResult()

inet::physicallayer::ReceptionResult::~ReceptionResult ( )
virtual
21 {
22  delete packet;
23  delete decisions;
24 }

Member Function Documentation

◆ getDecisions()

virtual const std::vector<const IReceptionDecision *>* inet::physicallayer::ReceptionResult::getDecisions ( ) const
inlineoverridevirtual

Returns the reception decisions made by the receiver in the order of received signal parts.

This function never returns an empty vector.

Implements inet::physicallayer::IReceptionResult.

31 { return decisions; }

◆ getPacket()

const Packet * inet::physicallayer::ReceptionResult::getPacket ( ) const
overridevirtual

Returns the packet corresponding to this reception.

This function never returns nullptr.

Implements inet::physicallayer::IReceptionResult.

Reimplemented in inet::physicallayer::LayeredReceptionResult.

33 {
34  return packet;
35 }

◆ getReception()

virtual const IReception* inet::physicallayer::ReceptionResult::getReception ( ) const
inlineoverridevirtual

Returns the corresponding reception that also specifies the receiver and the received transmission.

This function never returns nullptr.

Implements inet::physicallayer::IReceptionResult.

30 { return reception; }

◆ printToStream()

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

Prints this object to the provided output stream.

Reimplemented from inet::IPrintableObject.

Reimplemented in inet::physicallayer::LayeredReceptionResult.

27 {
28  stream << "ReceptionResult";
29  return stream;
30 }

Member Data Documentation

◆ decisions

const std::vector<const IReceptionDecision *>* inet::physicallayer::ReceptionResult::decisions
protected

Referenced by ~ReceptionResult().

◆ packet

const Packet* inet::physicallayer::ReceptionResult::packet
protected

Referenced by getPacket(), and ~ReceptionResult().

◆ reception

const IReception* inet::physicallayer::ReceptionResult::reception
protected

The documentation for this class was generated from the following files:
inet::physicallayer::ReceptionResult::reception
const IReception * reception
Definition: ReceptionResult.h:20
inet::physicallayer::ReceptionResult::decisions
const std::vector< const IReceptionDecision * > * decisions
Definition: ReceptionResult.h:21
inet::physicallayer::ReceptionResult::packet
const Packet * packet
Definition: ReceptionResult.h:22