rise::SCTransmitter Class Reference
[Transceiver]

Allows a Station to transmit on a Single Carrier Transmitter.

#include <transceiver/SCTransmitter.hpp>

Inheritance diagram for rise::SCTransmitter:

[legend]

Collaboration diagram for rise::SCTransmitter:

[legend]

List of all members.

Public Member Functions
virtual double	getFrequency ()
virtual bool	isActive () const
virtual void	mobilityUpdate ()
	called if Transmitter moved
	SCTransmitter (const wns::pyconfig::View &config, Station *s, antenna::Antenna *a)
	Constructor that creates Transmitter with given Station and Antenna.
virtual void	startTransmitting (TransmissionObjectPtr transmissionObject)
	Used to start a transmisson.
virtual void	stopTransmitting (TransmissionObjectPtr transmissionObject)
	Used to stop a transmisson.
virtual void	tune (double f, double b)
	Tune the Transceiver to a PhysicalResource.
virtual	~SCTransmitter ()
	Default destructor.
Private Attributes
bool	active

---

Detailed Description

Definition at line 47 of file SCTransmitter.hpp.

---

Constructor & Destructor Documentation

SCTransmitter::SCTransmitter	(	const wns::pyconfig::View &	config,
		Station *	s,
		antenna::Antenna *	a
	)

Definition at line 37 of file SCTransmitter.cpp.

SCTransmitter::~SCTransmitter

(

)

[virtual]

Definition at line 43 of file SCTransmitter.cpp.

---

Member Function Documentation

double SCTransmitter::getFrequency

(

)

[virtual]

Definition at line 73 of file SCTransmitter.cpp.

bool SCTransmitter::isActive

(

)

const [virtual]

Definition at line 79 of file SCTransmitter.cpp.

void SCTransmitter::mobilityUpdate

(

)

[virtual]

Definition at line 67 of file SCTransmitter.cpp.

void SCTransmitter::startTransmitting

(

TransmissionObjectPtr

transmissionObject

)

[virtual]

startTransmitting() will fail if the Transmitter has no PhysicalResource. A PhysicalResource may be assigned to the Transmitter by using tune(frequency, bandwidth). active is set true. If the Transmitter is already in state active, the function will fail.

Definition at line 47 of file SCTransmitter.cpp.

void SCTransmitter::stopTransmitting

(

TransmissionObjectPtr

transmissionObject

)

[virtual]

stopTransmitting() will fail if the Transmitter is not active.

Reimplemented from rise::Transmitter.

Definition at line 55 of file SCTransmitter.cpp.

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

Definition at line 62 of file SCTransmitter.cpp.

---

Member Data Documentation

bool rise::SCTransmitter::active [private]

Reimplemented from rise::Transmitter.

Definition at line 80 of file SCTransmitter.hpp.

---

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

• framework/rise/src/transceiver/SCTransmitter.hpp
• framework/rise/src/transceiver/SCTransmitter.cpp