inet::physicallayer::ReceptionResult Class Reference

#include <ReceptionResult.h>

Inheritance diagram for inet::physicallayer::ReceptionResult:

Public Member Functions
	ReceptionResult (const IReception *reception, const std::vector< const IReceptionDecision * > *decisions, const ReceptionIndication *indication)
	~ReceptionResult ()
virtual std::ostream &	printToStream (std::ostream &stream, int level) const override
	Prints this object to the provided output stream. More...
virtual const IReception *	getReception () 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 ReceptionIndication *	getIndication () const override
	Returns the physical properties of the reception. More...
virtual const cPacket *	getPhyFrame () const override
	Returns the PHY frame corresponding to the reception. More...
virtual const cPacket *	getMacFrame () const override
	Returns the MAC frame corresponding to this reception. More...
Public Member Functions inherited from inet::physicallayer::IPrintableObject
virtual	~IPrintableObject ()
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

Protected Attributes
const IReception *	reception
const std::vector< const IReceptionDecision * > *	decisions
const ReceptionIndication *	indication
const cPacket *	macFrame

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 }

Constructor & Destructor Documentation

inet::physicallayer::ReceptionResult::ReceptionResult	(	const IReception *	reception,
		const std::vector< const IReceptionDecision * > *	decisions,
		const ReceptionIndication *	indication
	)

                                                                                                                                                           :
    reception(reception),
    decisions(decisions),
    indication(indication),
    macFrame(nullptr)
{
    macFrame = reception->getTransmission()->getMacFrame()->dup();
    bool isReceptionSuccessful = true;
    for (auto decision : *decisions)
        isReceptionSuccessful &= decision->isReceptionSuccessful();
    const_cast<cPacket *>(macFrame)->setBitError(!isReceptionSuccessful);
}

inet::physicallayer::ReceptionResult::~ReceptionResult

(

)

{
    delete macFrame;
    delete decisions;
}

Member Function Documentation

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.

{ return decisions; }

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

inlineoverridevirtual

Returns the physical properties of the reception.

This function never returns nullptr.

Implements inet::physicallayer::IReceptionResult.

{ return indication; }

const cPacket * inet::physicallayer::ReceptionResult::getMacFrame ( ) const

overridevirtual

Returns the MAC frame corresponding to this reception.

This function may return nullptr.

Implements inet::physicallayer::IReceptionResult.

Reimplemented in inet::physicallayer::LayeredReceptionResult.

{
    return macFrame;
}

const cPacket * inet::physicallayer::ReceptionResult::getPhyFrame ( ) const

overridevirtual

Returns the PHY frame corresponding to the reception.

This function may return nullptr.

Implements inet::physicallayer::IReceptionResult.

Reimplemented in inet::physicallayer::LayeredReceptionResult.

{
    return nullptr;
}

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.

{ return reception; }

std::ostream & inet::physicallayer::ReceptionResult::printToStream ( std::ostream &  stream, int  level  ) const

overridevirtual

Prints this object to the provided output stream.

Function calls to operator<< with pointers or references either const or not are all forwarded to this function.

Reimplemented from inet::physicallayer::IPrintableObject.

Reimplemented in inet::physicallayer::LayeredReceptionResult.

{
    stream << "ReceptionResult";
    if (level <= PRINT_LEVEL_DETAIL)
        stream << ", indication = " << indication;
    return stream;
}

Member Data Documentation

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

protected

Referenced by ~ReceptionResult().

const ReceptionIndication* inet::physicallayer::ReceptionResult::indication

protected

Referenced by printToStream().

const cPacket* inet::physicallayer::ReceptionResult::macFrame

protected

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

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

protected

---

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

• ReceptionResult.h
• ReceptionResult.cc