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

Carma downconverter CAN module control interface. More...

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

Inheritance diagram for carma::downconverter::DownconverterControl:
carma::canbus::devices::DeviceControl carma::downconverter::SpectralDownconverterControl

Public Types

enum  FilterType {
  FILTER_490MHZ, FILTER_240MHZ, FILTER_119MHZ, FILTER_58MHZ,
  FILTER_280MHZ
}
 Valid output bandwidth filter types. More...
 
enum  SidebandType { UPPER_SIDEBAND, LOWER_SIDEBAND }
 Sideband type. More...
 

Public Member Functions

boolean checkIfOutputPower (in float power, in float delta) raises (carma::util::UserException)
 Check that IF Output power is within a specified range. More...
 
void enableIfOutAlc (in boolean enable) raises (carma::util::UserException)
 Enable IF output Automatic Level Control (ALC). More...
 
void enableRfInputAmp (in boolean enable) raises (carma::util::UserException)
 Turn RF input amplifier on or off. More...
 
void setIfOut (in float ifout) raises (carma::util::UserException)
 Set IF output power to requested level. More...
 
void setIfOutAtten (in float atten) raises (carma::util::UserException)
 Set IF output attenuation to requested level. More...
 
void setIfOutPreset () raises (carma::util::UserException)
 Set IF output power to preset level. More...
 
void setPsys (in float psys) raises (carma::util::UserException)
 Set the psys power level to indicated level. More...
 
void setPsysAtten (in float atten) raises (carma::util::UserException)
 Set psys attenutation to indicated level. More...
 
void setPsysPreset () raises (carma::util::UserException)
 Set the psys power level 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 CAN module control interface.

Both the Wideband and Spectral-line downconverter CAN modules will share this control interface. It is likely that the Spectral-line system will inherit from it and define additional functionality.

Definition at line 25 of file DownconverterControl.idl.

Member Enumeration Documentation

Valid output bandwidth filter types.

Not all modules are equipped with all filters.

Definition at line 40 of file DownconverterControl.idl.

Sideband type.

Currently used on Spectral Line Downconverter only.

Definition at line 31 of file DownconverterControl.idl.

Member Function Documentation

boolean carma::downconverter::DownconverterControl::checkIfOutputPower ( in float  power,
in float  delta 
)
raises (carma::util::UserException
)

Check that IF Output power is within a specified range.

This command is for engineering use only!

Parameters
powercenter IF Output power
deltavalue around IF Output power
Returns
true if within boundaries false otherwise.
Exceptions
carma::util::UserExceptionif module is OFFLINE.
void carma::downconverter::DownconverterControl::enableIfOutAlc ( in boolean  enable)
raises (carma::util::UserException
)

Enable IF output Automatic Level Control (ALC).

Parameters
enabletrue for on false for off.
Exceptions
carma::util::UserExceptionon failure.
void carma::downconverter::DownconverterControl::enableRfInputAmp ( in boolean  enable)
raises (carma::util::UserException
)

Turn RF input amplifier on or off.

Parameters
enabletrue for on false for off.
Exceptions
carma::util::UserExceptionon failure.
void carma::downconverter::DownconverterControl::setIfOut ( in float  ifout)
raises (carma::util::UserException
)

Set IF output power to requested level.

Parameters
ifoutrequested ifout power level.
Exceptions
carma::util::UserExceptionon failure.
void carma::downconverter::DownconverterControl::setIfOutAtten ( in float  atten)
raises (carma::util::UserException
)

Set IF output attenuation to requested level.

Parameters
attenrequest ifout attenuation level.
Exceptions
carma::util::UserExceptionon failure.
void carma::downconverter::DownconverterControl::setIfOutPreset ( )
raises (carma::util::UserException
)

Set IF output power to preset level.

Exceptions
carma::util::UserExceptionon failure.
void carma::downconverter::DownconverterControl::setPsys ( in float  psys)
raises (carma::util::UserException
)

Set the psys power level to indicated level.

Exceptions
carma::util::UserExceptionon failure.
void carma::downconverter::DownconverterControl::setPsysAtten ( in float  atten)
raises (carma::util::UserException
)

Set psys attenutation to indicated level.

Exceptions
carma::util::UserExceptionon failure.
void carma::downconverter::DownconverterControl::setPsysPreset ( )
raises (carma::util::UserException
)

Set the psys power level to preset level.

Exceptions
carma::util::UserExceptionon failure.

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