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

#include <ReceptionDecision.h>

Inheritance diagram for inet::physicallayer::ReceptionDecision:
inet::physicallayer::IReceptionDecision inet::physicallayer::IPrintableObject

Public Member Functions

 ReceptionDecision (const IReception *reception, IRadioSignal::SignalPart part, bool isReceptionPossible, bool isReceptionAttempted, bool isReceptionSuccessful)
 
virtual std::ostream & printToStream (std::ostream &stream, int level) 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 IRadioSignal::SignalPart getSignalPart () const override
 Returns the signal part of this decision. More...
 
virtual bool isReceptionPossible () const override
 Returns whether reception was possible according to the physical properties of the received radio signal. More...
 
virtual bool isReceptionAttempted () const override
 Returns whether the receiver decided to attempt the reception or it decided to ignore it. More...
 
virtual bool isReceptionSuccessful () const override
 Returns whether the reception was completely successful or not. 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 IReceptionreception
 
IRadioSignal::SignalPart part
 
const bool isReceptionPossible_
 
const bool isReceptionAttempted_
 
const bool isReceptionSuccessful_
 

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::ReceptionDecision::ReceptionDecision ( const IReception reception,
IRadioSignal::SignalPart  part,
bool  isReceptionPossible,
bool  isReceptionAttempted,
bool  isReceptionSuccessful 
)
24  :
26  part(part),
30 {
31 }
virtual bool isReceptionPossible() const override
Returns whether reception was possible according to the physical properties of the received radio sig...
Definition: ReceptionDecision.h:44
const bool isReceptionAttempted_
Definition: ReceptionDecision.h:33
virtual bool isReceptionSuccessful() const override
Returns whether the reception was completely successful or not.
Definition: ReceptionDecision.h:46
IRadioSignal::SignalPart part
Definition: ReceptionDecision.h:31
const bool isReceptionSuccessful_
Definition: ReceptionDecision.h:34
const IReception * reception
Definition: ReceptionDecision.h:30
const bool isReceptionPossible_
Definition: ReceptionDecision.h:32
virtual bool isReceptionAttempted() const override
Returns whether the receiver decided to attempt the reception or it decided to ignore it...
Definition: ReceptionDecision.h:45

Member Function Documentation

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

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

This function never returns nullptr.

Implements inet::physicallayer::IReceptionDecision.

41 { return reception; }
const IReception * reception
Definition: ReceptionDecision.h:30
virtual IRadioSignal::SignalPart inet::physicallayer::ReceptionDecision::getSignalPart ( ) const
inlineoverridevirtual

Returns the signal part of this decision.

Implements inet::physicallayer::IReceptionDecision.

42 { return part; }
IRadioSignal::SignalPart part
Definition: ReceptionDecision.h:31
virtual bool inet::physicallayer::ReceptionDecision::isReceptionAttempted ( ) const
inlineoverridevirtual

Returns whether the receiver decided to attempt the reception or it decided to ignore it.

Implements inet::physicallayer::IReceptionDecision.

45 { return isReceptionAttempted_; }
const bool isReceptionAttempted_
Definition: ReceptionDecision.h:33
virtual bool inet::physicallayer::ReceptionDecision::isReceptionPossible ( ) const
inlineoverridevirtual

Returns whether reception was possible according to the physical properties of the received radio signal.

Implements inet::physicallayer::IReceptionDecision.

44 { return isReceptionPossible_; }
const bool isReceptionPossible_
Definition: ReceptionDecision.h:32
virtual bool inet::physicallayer::ReceptionDecision::isReceptionSuccessful ( ) const
inlineoverridevirtual

Returns whether the reception was completely successful or not.

Implements inet::physicallayer::IReceptionDecision.

46 { return isReceptionSuccessful_; }
const bool isReceptionSuccessful_
Definition: ReceptionDecision.h:34
std::ostream & inet::physicallayer::ReceptionDecision::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.

34 {
35  stream << "ReceptionDecision";
36  if (level <= PRINT_LEVEL_DETAIL)
37  stream << (isReceptionPossible_ ? ", possible" : ", impossible")
38  << (isReceptionAttempted_ ? ", attempted" : ", ignored")
39  << (isReceptionSuccessful_ ? ", successful" : ", unsuccessful");
40  return stream;
41 }
const bool isReceptionAttempted_
Definition: ReceptionDecision.h:33
const bool isReceptionSuccessful_
Definition: ReceptionDecision.h:34
const bool isReceptionPossible_
Definition: ReceptionDecision.h:32

Member Data Documentation

const bool inet::physicallayer::ReceptionDecision::isReceptionAttempted_
protected

Referenced by printToStream().

const bool inet::physicallayer::ReceptionDecision::isReceptionPossible_
protected

Referenced by printToStream().

const bool inet::physicallayer::ReceptionDecision::isReceptionSuccessful_
protected

Referenced by printToStream().

IRadioSignal::SignalPart inet::physicallayer::ReceptionDecision::part
protected
const IReception* inet::physicallayer::ReceptionDecision::reception
protected

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