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

Carma Downconverter system access interface. More...

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

Public Member Functions

carma::downconverter::BlockDownconverterControl BlockDownconverter (in short inputNo) raises ( carma::util::UserException )
 Retrieve control DO for specified block downconverter. More...
 
carma::downconverter::DownconverterControl Downconverter (in short input, in short band) raises (carma::util::UserException)
 Retrieve control object for individual downconverter CAN devices. More...
 
carma::downconverter::BlockDownconverterControl GlobalBlockDownconverter () raises ( carma::util::UserException )
 Retrieve control DO for global block downconverter. More...
 
carma::downconverter::DownconverterControl GlobalDownconverter () raises (carma::util::UserException)
 Retrieve control object for all downconverters. More...
 
carma::downconverter::LoMonitorControl GlobalLoMonitor () raises (carma::util::UserException)
 Retrieve control object for global control of LoMonitor device. More...
 
carma::downconverter::NoiseSourceControl GlobalNoiseSource () raises (carma::util::UserException)
 Retrieve control object for global control of NoiseSource device. More...
 
carma::downconverter::QuadModControl GlobalQuadMod () raises (carma::util::UserException)
 Retrieve single control object for all quadrature modulators. More...
 
carma::downconverter::SldcLoControl LoControl () raises ( carma::util::UserException )
 Retrieve SldcLoControl object. More...
 
carma::downconverter::LoMonitorControl LoMonitor () raises (carma::util::UserException)
 Retrieve control object for lo monitor module. More...
 
carma::downconverter::NoiseSourceControl NoiseSource () raises (carma::util::UserException)
 Retrieve control object for noise source module. More...
 
carma::downconverter::QuadModControl QuadMod (in short input) raises (carma::util::UserException)
 Retrieve control object for individual quadrature modulator CAN devices. More...
 
void quit () raises (carma::util::UserException)
 Quit. More...
 
void reset () raises (carma::util::UserException)
 Reset all modules. More...
 
void selectFilter (in DownconverterControl::FilterType filter, in unsigned short bandNo) raises (carma::util::UserException)
 Select spectral line filter an a per-band basis. More...
 
void selectSidebandFrequency (in DownconverterControl::SidebandType sideband, in double lofreq, in unsigned short bandNo) raises (carma::util::UserException)
 Select sideband and frequency on a band of spectral-line downconverters. More...
 
void setPsys (in float psys, in unsigned short inputNo, in unsigned short bandNo) raises ( carma::util::UserException )
 Set psys on a per input (antenna) basis. More...
 
void setPsysPreset (in unsigned short inputNo, in unsigned short bandNo) raises ( carma::util::UserException )
 Set psysPreset on a per input (antenna) basis. More...
 
void softReset () raises (carma::util::UserException)
 Reset all modules. More...
 
carma::downconverter::SpectralDownconverterControl SpectralDownconverter (in short input, in short band) raises (carma::util::UserException)
 Retrieve control object for individual spectral downconverter devices. More...
 

Detailed Description

Carma Downconverter system access interface.

This interface declares the access and control interface for the downconverter Wideband and Spectral-line subsystems. It serves as a single entry point from which to access CAN device control object references. In addition it provides methods which act on the CANbuss as a whole such as the reset method. It is intended that this interface will be shared between both systems (Wideband and Spectral-line) as is. However, the Spectral-line downconverter CAN modules will probably have a different control interface than their wideband counterpart which may warrant slight changes to this interface or perhaps a seperation into a base System interface and inherited Wideband and Spectral-line versions.

Definition at line 62 of file downconverterSystem.idl.

Member Function Documentation

carma::downconverter::BlockDownconverterControl carma::downconverter::System::BlockDownconverter ( in short  inputNo)
raises (carma::util::UserException
)

Retrieve control DO for specified block downconverter.

This is only implemented on the spectral line system, calling it from the wideband system will throw an exception.

Parameters
inputIF antenna input (1-8 for Wideband, 1-15 for Spectral).
Returns
Block downconverter DO.
carma::downconverter::DownconverterControl carma::downconverter::System::Downconverter ( in short  input,
in short  band 
)
raises (carma::util::UserException
)

Retrieve control object for individual downconverter CAN devices.

The downconverter control object returned from this routine is responsible for controlling the single downconverter specified at the given input and band.

Parameters
inputIF antenna input (1-8 for Wideband, 1-15 for Spectral-line).
bandIF band (1-16 for Wideband, 1-8 for Spectral-line).
Exceptions
carma::util::UserExceptionon failure.
carma::downconverter::BlockDownconverterControl carma::downconverter::System::GlobalBlockDownconverter ( )
raises (carma::util::UserException
)

Retrieve control DO for global block downconverter.

The global block downconverter DO controls all block downconverters. This is only implemented on the spectral line system, calling it from the wideband system will throw an exception.

Parameters
inputIF antenna input (1-8 for Wideband, 1-15 for Spectral).
Returns
Block downconverter DO.
carma::downconverter::DownconverterControl carma::downconverter::System::GlobalDownconverter ( )
raises (carma::util::UserException
)

Retrieve control object for all downconverters.

The Downconverter control object returned from this routine is responsible for simultaneously controlling all downconverter CAN modules on the system being controlled via the Node 0 device.

Exceptions
carma::util::UserExceptionon failure.
carma::downconverter::LoMonitorControl carma::downconverter::System::GlobalLoMonitor ( )
raises (carma::util::UserException
)

Retrieve control object for global control of LoMonitor device.

There is only one LoMonitor device in each subsystem, so it can be argued that this isn't necessary. However, it is included for completeness. In practice, it doesn't matter which one is used (the global or single version).

Exceptions
carma::util::UserExceptionon failure.
carma::downconverter::NoiseSourceControl carma::downconverter::System::GlobalNoiseSource ( )
raises (carma::util::UserException
)

Retrieve control object for global control of NoiseSource device.

There is only one Noise Source device in each subsystem, so it can be argued that this isn't necessary. However, it is included for completeness. In practice, it doesn't matter which one is used (the global or single version).

Exceptions
carma::util::UserExceptionon failure.
carma::downconverter::QuadModControl carma::downconverter::System::GlobalQuadMod ( )
raises (carma::util::UserException
)

Retrieve single control object for all quadrature modulators.

Returned control object simultaneously controls all quadrature modulators in the wideband system via Node 0 device.

Exceptions
carma::util::UserExceptionon failure.
carma::downconverter::SldcLoControl carma::downconverter::System::LoControl ( )
raises (carma::util::UserException
)

Retrieve SldcLoControl object.

Returns nill on wideband systems.

carma::downconverter::LoMonitorControl carma::downconverter::System::LoMonitor ( )
raises (carma::util::UserException
)

Retrieve control object for lo monitor module.

There is only one lo monitor module per subsystem hence no global device retrieval method.

Exceptions
carma::util::UserExceptionon failure.
carma::downconverter::NoiseSourceControl carma::downconverter::System::NoiseSource ( )
raises (carma::util::UserException
)

Retrieve control object for noise source module.

There is only one noise source module for both the Wideband and Spectral-line systems hence only a single routine to retrieve the control object.

Exceptions
carma::util::UserExceptionon failure.
carma::downconverter::QuadModControl carma::downconverter::System::QuadMod ( in short  input)
raises (carma::util::UserException
)

Retrieve control object for individual quadrature modulator CAN devices.

The returned quadrature modulator control object is responsible for controlling the quadrature modulator specified at the given input.

Parameters
inputIF antenna input (1-8 for Wideband, 1-15 for Spectral-line).
Exceptions
carma::util::UserExceptionon failure.
void carma::downconverter::System::quit ( )
raises (carma::util::UserException
)

Quit.

Exits host application. FOR DEBUGGING ONLY - It is very likely this will be removed on the producation system (we don't want people accidently terminating our applications).

void carma::downconverter::System::reset ( )
raises (carma::util::UserException
)

Reset all modules.

Resets all modules on all controlled busses via Dio reset lines.

Exceptions
carma::util::UserExceptionon failure.
void carma::downconverter::System::selectFilter ( in DownconverterControl::FilterType  filter,
in unsigned short  bandNo 
)
raises (carma::util::UserException
)

Select spectral line filter an a per-band basis.

Parameters
filterRequested filter.
bandNoBand to invoke upon (1..8).
void carma::downconverter::System::selectSidebandFrequency ( in DownconverterControl::SidebandType  sideband,
in double  lofreq,
in unsigned short  bandNo 
)
raises (carma::util::UserException
)

Select sideband and frequency on a band of spectral-line downconverters.

This command is implemented on the spectral line system only!

Parameters
sidebandRequested sideband.
lofreqRequested frequency in GHz.
bandNoBand to invoke upon (1..8).
void carma::downconverter::System::setPsys ( in float  psys,
in unsigned short  inputNo,
in unsigned short  bandNo 
)
raises (carma::util::UserException
)

Set psys on a per input (antenna) basis.

Parameters
psysDesired psys in dBm.
inputNoCorrelator input number - 0 for all inputs.
bandNoCorrelator band number - 0 for all bands.
void carma::downconverter::System::setPsysPreset ( in unsigned short  inputNo,
in unsigned short  bandNo 
)
raises (carma::util::UserException
)

Set psysPreset on a per input (antenna) basis.

Parameters
inputNoCorrelator input number - 0 for all inputs.
bandNoCorrelator band number - 0 for all bands.
void carma::downconverter::System::softReset ( )
raises (carma::util::UserException
)

Reset all modules.

Resets all modules on all controlled busses via CAN reset message.

Exceptions
carma::util::UserExceptionon failure.
carma::downconverter::SpectralDownconverterControl carma::downconverter::System::SpectralDownconverter ( in short  input,
in short  band 
)
raises (carma::util::UserException
)

Retrieve control object for individual spectral downconverter devices.

The downconverter control object returned from this routine is responsible for controlling the single downconverter specified at the given input and band.

Parameters
inputIF antenna input (1-15 for Spectral-line).
bandIF band (1-8 for Spectral-line).
Exceptions
carma::util::UserExceptionon failure.

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