Carma dowconverter noise source control interface. More...

import "carma/downconverter/common/NoiseSourceControl.idl";

Inheritance diagram for carma::downconverter::NoiseSourceControl:

Public Member Functions
void	enableNoiseSource (in boolean enable) raises (carma::util::UserException)
	Enable noise source. More...

void	enableToneSource (in boolean enable) raises (carma::util::UserException)
	Enable tone source. More...

boolean	isEnabled ()
	Is NoiseSource enabled. More...

void	setNoiseAttenuation (in unsigned short atten) raises (carma::util::UserException)
	Set output power attenuation to indicated level. More...

void	setNoiseOutput (in double pout) raises (carma::util::UserException)
	Set output power to indicated level. More...

void	setNoiseOutputToPreset () raises (carma::util::UserException)
	Set noise output power to preset level. More...

void	setToneAttenuation (in unsigned short atten) raises (carma::util::UserException)
	Set tone attenuation to indicated level. More...

void	setToneOutput (in double powerIndBm) raises ( carma::util::UserException )
	Set tone output to requested level. More...

void	setToneOutputToPreset () raises ( carma::util::UserException )
	Set tone output to preset level. More...

Public Member Functions inherited from carma::canbus::devices::DeviceControl
boolean	isOnline () raises (carma::util::UserException)
	Is device ONLINE? A device is considered ONLINE if it is actively sending monitor packets on the frame timescale. More...

void	reset () raises (carma::util::UserException)
	Reset the module via CAN reset message. More...

void	startChannelOneFastSampling (in unsigned short fastItem) raises (carma::util::UserException)
	Start fast sampling data from this node on channel 1. More...

void	startChannelTwoFastSampling (in unsigned short fastItem) raises (carma::util::UserException)
	Start fast sampling data from this node on channel 2. More...

void	stopChannelOneFastSampling () raises (carma::util::UserException)
	Stop fast sampling on channel 1 for any device. More...

void	stopChannelTwoFastSampling () raises (carma::util::UserException)
	Stop fast sampling on channel 2 for any device. More...

Detailed Description

Carma dowconverter noise source control interface.

Both the wideband and spectral line downconverter will use the same noise source CAN modules and thus share this interface.

Definition at line 23 of file NoiseSourceControl.idl.

Member Function Documentation

void carma::downconverter::NoiseSourceControl::enableNoiseSource	(	in boolean	enable	)
raises	(	carma::util::UserException
	)

Enable noise source.

Parameters

enable true for enable false disable.

Exceptions

carma::util::UserException on failure.

void carma::downconverter::NoiseSourceControl::enableToneSource	(	in boolean	enable	)
raises	(	carma::util::UserException
	)

Enable tone source.

Parameters

enable true for enable false for disable.

Exceptions

carma::util::UserException on failure.

boolean carma::downconverter::NoiseSourceControl::isEnabled ( )

Is NoiseSource enabled.

This command is for Engineering purposes only! This method indicates if the noise source is enabled.

Returns: true if noise source is enabled, false otherwise.

void carma::downconverter::NoiseSourceControl::setNoiseAttenuation	(	in unsigned short	atten	)
raises	(	carma::util::UserException
	)

Set output power attenuation to indicated level.

The attenuation range is 0-31 dB in integral steps. Numbers outside of this range are ignored by the XAC.

Parameters

atten desired output power attenuation.

Exceptions

carma::util::UserException on failure.

void carma::downconverter::NoiseSourceControl::setNoiseOutput	(	in double	pout	)
raises	(	carma::util::UserException
	)

Set output power to indicated level.

Parameters

pout	desired output power level.

Exceptions

carma::util::UserException on failure.

void carma::downconverter::NoiseSourceControl::setNoiseOutputToPreset	(		)
raises	(	carma::util::UserException
	)

Set noise output power to preset level.

Exceptions

carma::util::UserException on failure.

void carma::downconverter::NoiseSourceControl::setToneAttenuation	(	in unsigned short	atten	)
raises	(	carma::util::UserException
	)

Set tone attenuation to indicated level.

Parameters

atten desired tone attenuation.

Exceptions

carma::util::UserException on failure.

void carma::downconverter::NoiseSourceControl::setToneOutput	(	in double	powerIndBm	)
raises	(	carma::util::UserException
	)

Set tone output to requested level.

Turns tone source on, noise source off and commands the output power level to the value specified in the message.

Parameters

powerIndBm Output tone power level in dBm.

void carma::downconverter::NoiseSourceControl::setToneOutputToPreset	(		)
raises	(	carma::util::UserException
	)

Set tone output to preset level.

Turns tone source on, noise source off and command the output power level to the preset value stored in the modules EEPROM.

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

carma/downconverter/common/NoiseSourceControl.idl

Public Member Functions

Detailed Description

Member Function Documentation