User Manual, Developers Guide and API Documentation

rise::SCReceiver Class Reference
[Transceiver]

Allows a Station to listen to one PhysicalResource.

#include <transceiver/SCReceiver.hpp>

Inheritance diagram for rise::SCReceiver:

Inheritance graph
[legend]
Collaboration diagram for rise::SCReceiver:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual bool contains (TransmissionObjectPtr)
 Returns true if TransmissionObject is active.
virtual double getFrequency ()
virtual wns::Power getInterference (const TransmissionObjectPtr &t)
 Returns the interference for this TransmissionObject.
virtual wns::Ratio getLoss (Transmitter *t)
 Returns the total loss between the Receiver and a given Transmitter.
virtual wns::Power getNoise ()
 return receiver noise power
virtual wns::Power getRxPower (const TransmissionObjectPtr &t)
 Returns the received signal power of this transmission.
virtual wns::Power getTotalRxPower ()
 Returns the total received signal power of the PhysicalResource the.
virtual void notify (TransmissionObjectPtr transmissionObject)
 Called by the PhysicalResource to notify the Receiver of a change.
 SCReceiver (const wns::pyconfig::View &config, Station *s, antenna::Antenna *a, Demodulator *demodulator, Decoder *decoder, wns::Ratio rnf)
 Constructor.
virtual void startReceiving ()
 listen to a specific PhysicalResource
virtual void stopReceiving ()
 stop listening to a specific PhysicalResource
virtual void tune (double f, double b)
virtual ~SCReceiver ()
 Default destructor.


Detailed Description

Definition at line 62 of file SCReceiver.hpp.


Constructor & Destructor Documentation

SCReceiver::SCReceiver ( const wns::pyconfig::View config,
Station s,
antenna::Antenna a,
Demodulator demodulator,
Decoder decoder,
wns::Ratio  rnf 
)

Initializes the following attributes of the SCReceiver with the given parameters:

  • Station* station
  • Antenna* antenna
  • Demodulator* demodulator
  • Decoder* decoder
  • wns::Ratio receiverNoiseFigure

Definition at line 54 of file SCReceiver.cpp.

SCReceiver::~SCReceiver (  )  [virtual]

Definition at line 64 of file SCReceiver.cpp.


Member Function Documentation

bool SCReceiver::contains ( TransmissionObjectPtr  t  )  [virtual]

Function checks if the list 'TransmissionObjects' contains the given TransmissionObject.

Reimplemented from rise::ReceiverBase.

Definition at line 163 of file SCReceiver.cpp.

double SCReceiver::getFrequency (  )  [virtual]

Definition at line 173 of file SCReceiver.cpp.

wns::Power SCReceiver::getInterference ( const TransmissionObjectPtr t  )  [virtual]

The interference is here defined as: the total received signal power

Reimplemented from rise::ReceiverBase.

Definition at line 118 of file SCReceiver.cpp.

wns::Ratio SCReceiver::getLoss ( Transmitter t  )  [virtual]

Todo:
Die mittenfrequenzen der sub-b�nder aufzuaddieren ist nicht so eine tolle idee!

Reimplemented from rise::Receiver.

Definition at line 133 of file SCReceiver.cpp.

wns::Power SCReceiver::getNoise (  )  [virtual]

Reimplemented from rise::ReceiverBase.

Definition at line 140 of file SCReceiver.cpp.

wns::Power SCReceiver::getRxPower ( const TransmissionObjectPtr t  )  [virtual]

Reimplemented from rise::ReceiverBase.

Definition at line 126 of file SCReceiver.cpp.

wns::Power SCReceiver::getTotalRxPower (  )  [virtual]

NOTE: This is a very simple implementation. It assumes your receiver is working on the whole bandwidth of the PhysicalResource. If you need something sophisticated please go ahead and implement something on your own (that's why the method is virtual).

Reimplemented from rise::ReceiverBase.

Definition at line 103 of file SCReceiver.cpp.

void SCReceiver::notify ( TransmissionObjectPtr  transmissionObject  )  [virtual]

This method is part of publish-subscriber design pattern. The PhysicalResource will call this function of every Receiver attached to itsself,if a change on the PhysicalResource has happend (e.g, a Transmitter started a Transmission). The Receiver may then decide what to do.

Implements rise::PhysicalResourceObserver.

Definition at line 87 of file SCReceiver.cpp.

void SCReceiver::startReceiving (  )  [virtual]

Sets receiving to true. The Receiver is attached to a PhysicalResource (via PhysicalResource::attachReceiver()). If the Receiver has no PhysicalResource, the function will fail. If the Receiver is already listening on a PhysicalResource the function will do nothing.

Reimplemented from rise::ReceiverBase.

Definition at line 68 of file SCReceiver.cpp.

void SCReceiver::stopReceiving (  )  [virtual]

Sets receiving to false. The Receiver is detached from a PhysicalResource (via PhysicalResource::detachReceiver()). If the Receiver has no PhysicalResource, the function will fail. If the Receiver was not listening on a PhysicalResource the function will do nothing.

Reimplemented from rise::ReceiverBase.

Definition at line 76 of file SCReceiver.cpp.

void SCReceiver::tune ( double  f,
double  b 
) [virtual]

Definition at line 149 of file SCReceiver.cpp.


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

Generated on Sat May 26 03:32:36 2012 for openWNS by  doxygen 1.5.5