common::TRX Class Reference

Implementation of a single tunable transmitter/laser or receiver/filter component. More...

#include <trx.h>

List of all members.

Public Member Functions
void	init (int lowRange, int highRange)
	Initialize a new TRX object from the provided information.
bool	isAvailable (long lightpath, int wvlen)
	Check if the Tx/Rx component is available.
long	reset ()
	Reset the component (i.e make the lightpath value = NONE).
long	reset (long lightpath)
	Reset the component (if the provided lightpath is the lightpath that is using this component.
std::string &	toString ()
	Convert this object to string.
	TRX ()
	Construct a new TRX object.
Private Attributes
std::string	_descStr
	Description string.
int	_highRange
	the higher range of tunability
long	_lightpath
	Lightpath using this Transceiver component = NONE if none used.
int	_lowRange
	the lower range of tunability

---

Detailed Description

Implementation of a single tunable transmitter/laser or receiver/filter component.

By specifying the same low-range and hig-range of tuning, a fixed laser (or) filter can be simulated.

Author:

Rama Shenai

Version:

1.0 05/20/2004

---

Constructor & Destructor Documentation

common::TRX::TRX (   )  [inline]

Construct a new TRX object.

---

Member Function Documentation

void common::TRX::init (  int  lowRange, int  highRange )

Initialize a new TRX object from the provided information. Parameters: lowRange  The lowRange of tunability highRange  The highRange of tunability

bool common::TRX::isAvailable (  long  lightpath, int  wvlen )

Check if the Tx/Rx component is available. Two checks are made I. Check if the wavelength is in the supported range II. If this is not being used already. Parameters: lightpath  The lightpath to check for availability wvlen  The wavelength to be checked Returns: The result of the operation.

long common::TRX::reset (  long  lightpath  )

Reset the component (if the provided lightpath is the lightpath that is using this component. Parameters: lightpath  The lightpath Returns: The lightpath that is currently using >=0 -1L if no lightpath is currently using this -2L if another lightpath is currently present

long common::TRX::reset (   )

Reset the component (i.e make the lightpath value = NONE). Returns: The lightpath that is currently using >=0 -1L if no lightpath is currently using this -2L if another lightpath is currently present

std::string& common::TRX::toString (   )

Convert this object to string. Returns: a string representation of this object

---

Member Data Documentation

long common::TRX::_lightpath [private]

Lightpath using this Transceiver component = NONE if none used.

int common::TRX::_lowRange [private]

the lower range of tunability

int common::TRX::_highRange [private]

the higher range of tunability

std::string common::TRX::_descStr [private]

Description string.

---

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

• trx.h

---