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

#include <ApskScalarReceiver.h>

Inheritance diagram for inet::physicallayer::ApskScalarReceiver:
inet::physicallayer::FlatReceiverBase inet::physicallayer::NarrowbandReceiverBase inet::physicallayer::SnirReceiverBase inet::physicallayer::ReceiverBase inet::physicallayer::IReceiver inet::IPrintableObject

Public Member Functions

 ApskScalarReceiver ()
 
virtual std::ostream & printToStream (std::ostream &stream, int level, int evFlags=0) const override
 Prints this object to the provided output stream. More...
 
- Public Member Functions inherited from inet::physicallayer::FlatReceiverBase
 FlatReceiverBase ()
 
virtual W getMinReceptionPower () const override
 Returns the minimum reception power below which successful reception is definitely not possible. More...
 
virtual const IListeningDecisioncomputeListeningDecision (const IListening *listening, const IInterference *interference) const override
 Returns the result of the listening process specifying the reception state of the receiver. More...
 
virtual const IReceptionResultcomputeReceptionResult (const IListening *listening, const IReception *reception, const IInterference *interference, const ISnir *snir, const std::vector< const IReceptionDecision * > *decisions) const override
 Returns the complete result of the reception process for the provided reception. More...
 
virtual const IErrorModelgetErrorModel () const
 
virtual W getEnergyDetection () const
 
virtual void setEnergyDetection (W energyDetection)
 
virtual W getSensitivity () const
 
virtual void setSensitivity (W sensitivity)
 
- Public Member Functions inherited from inet::physicallayer::NarrowbandReceiverBase
 NarrowbandReceiverBase ()
 
virtual const IListeningcreateListening (const IRadio *radio, const simtime_t startTime, const simtime_t endTime, const Coord &startPosition, const Coord &endPosition) const override
 Returns a description of how the receiver is listening on the medium. More...
 
virtual const IReceptionDecisioncomputeReceptionDecision (const IListening *listening, const IReception *reception, IRadioSignal::SignalPart part, const IInterference *interference, const ISnir *snir) const override
 Returns the reception decision for the transmission part that specifies whether the reception is possible, attempted, and successful. More...
 
virtual const IModulationgetModulation () const
 
virtual void setModulation (const IModulation *modulation)
 
virtual Hz getCenterFrequency () const
 
virtual void setCenterFrequency (Hz centerFrequency)
 
virtual Hz getBandwidth () const
 
virtual void setBandwidth (Hz bandwidth)
 
- Public Member Functions inherited from inet::physicallayer::SnirReceiverBase
virtual double getSNIRThreshold () const
 
- Public Member Functions inherited from inet::physicallayer::ReceiverBase
 ReceiverBase ()
 
virtual W getMinInterferencePower () const override
 Returns the minimum interference power below which receptions are to be ignored while computing the interference. More...
 
virtual bool computeIsReceptionAttempted (const IListening *listening, const IReception *reception, IRadioSignal::SignalPart part, const IInterference *interference) const override
 Returns whether the reception of the provided part is actually attempted or ignored by the receiver. 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 Member Functions

virtual bool computeIsReceptionPossible (const IListening *listening, const ITransmission *transmission) const override
 Returns whether the reception of the provided transmission is possible or not independently of the reception conditions. More...
 
virtual bool computeIsReceptionPossible (const IListening *listening, const IReception *reception, IRadioSignal::SignalPart part) const override
 Returns whether the reception of the provided part is possible or not. More...
 
- Protected Member Functions inherited from inet::physicallayer::FlatReceiverBase
virtual void initialize (int stage) override
 
virtual bool computeIsReceptionSuccessful (const IListening *listening, const IReception *reception, IRadioSignal::SignalPart part, const IInterference *interference, const ISnir *snir) const override
 Returns whether the reception of the provided part is actually successful or failed by the receiver. More...
 
virtual PacketcomputeReceivedPacket (const ISnir *snir, bool isReceptionSuccessful) const override
 
virtual bool computeIsReceptionPossible (const IListening *listening, const ITransmission *transmission) const override
 
virtual bool computeIsReceptionPossible (const IListening *listening, const IReception *reception, IRadioSignal::SignalPart part) const override
 
- Protected Member Functions inherited from inet::physicallayer::ReceiverBase
virtual int numInitStages () const override
 
virtual W computeSignalPower (const IListening *listening, const ISnir *snir, const IInterference *interference) const
 

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) }
 
- Protected Types inherited from inet::physicallayer::SnirReceiverBase
enum  SnirThresholdMode { SnirThresholdMode::STM_UNDEFINED = -1, SnirThresholdMode::STM_MIN, SnirThresholdMode::STM_MEAN }
 
- Protected Attributes inherited from inet::physicallayer::FlatReceiverBase
const IErrorModelerrorModel
 
W energyDetection
 
W sensitivity
 
- Protected Attributes inherited from inet::physicallayer::NarrowbandReceiverBase
const IModulationmodulation
 
Hz centerFrequency
 
Hz bandwidth
 
- Protected Attributes inherited from inet::physicallayer::SnirReceiverBase
double snirThreshold = NaN
 
SnirThresholdMode snirThresholdMode = SnirThresholdMode::STM_UNDEFINED
 

Constructor & Destructor Documentation

◆ ApskScalarReceiver()

inet::physicallayer::ApskScalarReceiver::ApskScalarReceiver ( )
22  :
24 {
25 }

Member Function Documentation

◆ computeIsReceptionPossible() [1/2]

bool inet::physicallayer::ApskScalarReceiver::computeIsReceptionPossible ( const IListening listening,
const IReception reception,
IRadioSignal::SignalPart  part 
) const
overrideprotectedvirtual

Returns whether the reception of the provided part is possible or not.

For example, it might check if the reception power is above sensitivity.

This function may be called before the reception actually starts at the receiver, thus it must be purely functional and support optimistic parallel computation.

Reimplemented from inet::physicallayer::FlatReceiverBase.

40 {
41  auto apksTransmission = dynamic_cast<const ApskScalarTransmission *>(reception->getTransmission());
42  return apksTransmission && FlatReceiverBase::computeIsReceptionPossible(listening, reception, part);
43 }

◆ computeIsReceptionPossible() [2/2]

bool inet::physicallayer::ApskScalarReceiver::computeIsReceptionPossible ( const IListening listening,
const ITransmission transmission 
) const
overrideprotectedvirtual

Returns whether the reception of the provided transmission is possible or not independently of the reception conditions.

For example, it might check if the carrier frequency and the modulation of the transmission matches how the receiver is listening on the medium.

This function may be called before the reception actually starts at the receiver, thus it must be purely functional and support optimistic parallel computation.

Reimplemented from inet::physicallayer::NarrowbandReceiverBase.

34 {
35  auto apskTransmission = dynamic_cast<const ApskScalarTransmission *>(transmission);
36  return apskTransmission && NarrowbandReceiverBase::computeIsReceptionPossible(listening, transmission);
37 }

◆ printToStream()

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

Prints this object to the provided output stream.

Reimplemented from inet::physicallayer::FlatReceiverBase.

28 {
29  stream << "ApskScalarReceiver";
30  return FlatReceiverBase::printToStream(stream, level);
31 }

The documentation for this class was generated from the following files:
inet::physicallayer::FlatReceiverBase::FlatReceiverBase
FlatReceiverBase()
Definition: FlatReceiverBase.cc:22
inet::physicallayer::NarrowbandReceiverBase::computeIsReceptionPossible
virtual bool computeIsReceptionPossible(const IListening *listening, const ITransmission *transmission) const override
Returns whether the reception of the provided transmission is possible or not independently of the re...
Definition: NarrowbandReceiverBase.cc:55
inet::physicallayer::FlatReceiverBase::computeIsReceptionPossible
virtual bool computeIsReceptionPossible(const IListening *listening, const IReception *reception, IRadioSignal::SignalPart part) const override
Returns whether the reception of the provided part is possible or not.
Definition: FlatReceiverBase.cc:65
inet::physicallayer::FlatReceiverBase::printToStream
virtual std::ostream & printToStream(std::ostream &stream, int level, int evFlags=0) const override
Prints this object to the provided output stream.
Definition: FlatReceiverBase.cc:40