CARMA C++
carma::downconverter::QuadModControl Interface Reference

Carma downconverter quadrature modulator control interface. More...

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

Inheritance diagram for carma::downconverter::QuadModControl:
carma::canbus::devices::DeviceControl

Public Member Functions

boolean checkIfInPower (in double power, in double delta) raises (carma::util::UserException)
 Check that IF Input power is within a specified boundary. More...
 
boolean checkIfOutPower (in double power, in double delta) raises (carma::util::UserException)
 Check that IF Output power is within a specified boundary. More...
 
void enableModulationOnly (in boolean enable) raises (carma::util::UserException)
 Enable or disable modulation of the noise source sans attenuation. More...
 
void enableQuadMod (in boolean enable) raises (carma::util::UserException)
 Enable quadrature modulation and set output attenuation. More...
 
boolean isEnabled ()
 Is quadrature modulation enabled? This command is for engineering purposes only! More...
 
void loadWalshSequence (in WalshSequence walshSeq) raises (carma::util::UserException)
 Load a Walsh sequence. More...
 
void setPout (in double pout) raises (carma::util::UserException)
 Set output power to requested level. More...
 
void setPoutAtten (in unsigned short atten) raises (carma::util::UserException)
 Set output power attenuation level. More...
 
void setPoutPreset () raises (carma::util::UserException)
 Set output power 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 downconverter quadrature modulator control interface.

Both the wideband and spectral-line downconverter systems will use this interface.

Definition at line 25 of file QuadModControl.idl.

Member Function Documentation

boolean carma::downconverter::QuadModControl::checkIfInPower ( in double  power,
in double  delta 
)
raises (carma::util::UserException
)

Check that IF Input power is within a specified boundary.

This command is for engineering purposes only!

Returns
true if it is, false otherwise.
Exceptions
carma::util::UserExceptionif device is OFFLINE when this was invoked.
boolean carma::downconverter::QuadModControl::checkIfOutPower ( in double  power,
in double  delta 
)
raises (carma::util::UserException
)

Check that IF Output power is within a specified boundary.

This command is for engineering purposes only!

Returns
true if it is, false otherwise.
Exceptions
carma::util::UserExceptionif device is OFFLINE when this was invoked.
void carma::downconverter::QuadModControl::enableModulationOnly ( in boolean  enable)
raises (carma::util::UserException
)

Enable or disable modulation of the noise source sans attenuation.

Enables or disabled noise source modulation but does not change output attenuation.

Parameters
enabletrue to enable quadrature modulation, false to disable.
void carma::downconverter::QuadModControl::enableQuadMod ( in boolean  enable)
raises (carma::util::UserException
)

Enable quadrature modulation and set output attenuation.

Enables or disables the noise source gain and the Walsh modulation.

Parameters
enabletrue to enable quadrature modulation, false to disable.
Exceptions
carma::util::UserExceptionon failure.
boolean carma::downconverter::QuadModControl::isEnabled ( )

Is quadrature modulation enabled? This command is for engineering purposes only!

Returns
true if enabled false otherwise
Exceptions
carma::util::UserExceptionif device is OFFLINE when this was invoked.
void carma::downconverter::QuadModControl::loadWalshSequence ( in WalshSequence  walshSeq)
raises (carma::util::UserException
)

Load a Walsh sequence.

A single Walsh sequence consists of a sequence of phases: 0, 90, 180 or 270 degrees. These phases are mapped to 2-bit pairs as denoted by the assignments below. The loberotator generates the columns and sends them to the appropriate quad mod. The individual sequence entries are not indexed; it is assumed that all phase switch operations will commence at the beginning of the Walsh table column - which coincides with the next slow phase switch and not at a later point. The nominal Walsh table column length is 1024 entries.

Parameters
walshSeqSequence of subsequent 2 bit segments where 00b=0, 01b=90, 10b=180 and 11b=270 degrees packed 4 to an octet.
void carma::downconverter::QuadModControl::setPout ( in double  pout)
raises (carma::util::UserException
)

Set output power to requested level.

Parameters
poutrequested power level.
Exceptions
carma::util::UserExceptionon failure.
void carma::downconverter::QuadModControl::setPoutAtten ( in unsigned short  atten)
raises (carma::util::UserException
)

Set output power attenuation level.

The attenuation level should be in the range of 0-31 dB. Values outside of this range are ignored by the XAC.

Parameters
attenrequested output power attenuation.
Exceptions
carma::util::UserExceptionon failure.
void carma::downconverter::QuadModControl::setPoutPreset ( )
raises (carma::util::UserException
)

Set output power to preset level.

Exceptions
carma::util::UserExceptionon failure.

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