inet::physicallayer::IReceptionResult Class Reference

This interface represents the result of a receiver's reception process. More...

#include <IReceptionResult.h>

Inheritance diagram for inet::physicallayer::IReceptionResult:

Public Member Functions
virtual const IReception *	getReception () const =0
	Returns the corresponding reception that also specifies the receiver and the received transmission. More...
virtual const std::vector< const IReceptionDecision * > *	getDecisions () const =0
	Returns the reception decisions made by the receiver in the order of received signal parts. More...
virtual const ReceptionIndication *	getIndication () const =0
	Returns the physical properties of the reception. More...
virtual const cPacket *	getPhyFrame () const =0
	Returns the PHY frame corresponding to the reception. More...
virtual const cPacket *	getMacFrame () const =0
	Returns the MAC frame corresponding to this reception. More...
Public Member Functions inherited from inet::physicallayer::IPrintableObject
virtual	~IPrintableObject ()
virtual std::ostream &	printToStream (std::ostream &stream, int level) const
	Prints this object to the provided output stream. More...
virtual std::string	getInfoStringRepresentation () const
virtual std::string	getDetailStringRepresentation () const
virtual std::string	getDebugStringRepresentation () const
virtual std::string	getTraceStringRepresentation () const
virtual std::string	getCompleteStringRepresentation () const

Additional Inherited Members
Public Types inherited from inet::physicallayer::IPrintableObject
enum	PrintLevel {   PRINT_LEVEL_TRACE, PRINT_LEVEL_DEBUG, PRINT_LEVEL_DETAIL, PRINT_LEVEL_INFO,   PRINT_LEVEL_COMPLETE = INT_MIN }

Detailed Description

This interface represents the result of a receiver's reception process.

This interface is strictly immutable to safely support parallel computation.

Member Function Documentation

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

pure virtual

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

This function never returns an empty vector.

Implemented in inet::physicallayer::ReceptionResult.

virtual const ReceptionIndication* inet::physicallayer::IReceptionResult::getIndication ( ) const

pure virtual

Returns the physical properties of the reception.

This function never returns nullptr.

Implemented in inet::physicallayer::ReceptionResult.

Referenced by inet::physicallayer::RadioMedium::receivePacket().

virtual const cPacket* inet::physicallayer::IReceptionResult::getMacFrame ( ) const

pure virtual

Returns the MAC frame corresponding to this reception.

This function may return nullptr.

Implemented in inet::physicallayer::LayeredReceptionResult, and inet::physicallayer::ReceptionResult.

Referenced by inet::physicallayer::RadioMedium::receivePacket().

virtual const cPacket* inet::physicallayer::IReceptionResult::getPhyFrame ( ) const

pure virtual

Returns the PHY frame corresponding to the reception.

This function may return nullptr.

Implemented in inet::physicallayer::LayeredReceptionResult, and inet::physicallayer::ReceptionResult.

virtual const IReception* inet::physicallayer::IReceptionResult::getReception ( ) const

pure virtual

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

This function never returns nullptr.

Implemented in inet::physicallayer::ReceptionResult.

Referenced by inet::physicallayer::RadioMedium::getReceptionResult().

---

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

• IReceptionResult.h