NSCL DDAS  12.1-001
Support for XIA DDAS at FRIB
Public Member Functions | List of all members
CPixieDSPUtilities Class Reference

Read and writes both channel-level and module-level DSP settings. More...

#include <CPixieDSPUtilities.h>

Public Member Functions

int AdjustOffsets (int module)
 Adjust DC offsets of all channels for a single module. More...
 
int WriteChanPar (int module, int channel, char *paramName, double value)
 Write a channel parameter for a single channel. More...
 
int ReadChanPar (int module, int channel, char *paramName, double &value)
 Read a channel parameter for a single channel. More...
 
int WriteModPar (int module, char *paramName, unsigned int value)
 Write a module parameter for a single module. More...
 
int ReadModPar (int module, char *paramName, unsigned int &value)
 Read a module parameter for a single module. More...
 

Detailed Description

Read and writes both channel-level and module-level DSP settings.

The class also contains a function to adjust the DC offsets on a single module, as the DC offset is itself a channel parameter.

Member Function Documentation

◆ AdjustOffsets()

int CPixieDSPUtilities::AdjustOffsets ( int  module)

Adjust DC offsets of all channels for a single module.

Parameters
moduleModule number.
Returns
int
Return values
0Success.
!=0XIA API error code.

◆ ReadChanPar()

int CPixieDSPUtilities::ReadChanPar ( int  module,
int  channel,
char *  paramName,
double &  value 
)

Read a channel parameter for a single channel.

Parameters
[in]moduleModule number.
[in]channelChannel number on module.
[in]paramNameXIA API channel parameter name.
[in,out]valueReference to read parameter value.
Returns
int
Return values
0Success.
!=0XIA API error code.

Channel parameters are doubles. For a list of parameters and their units, see the Pixie-16 Programmers Manual, pgs. 60-61.

◆ ReadModPar()

int CPixieDSPUtilities::ReadModPar ( int  module,
char *  paramName,
unsigned int &  value 
)

Read a module parameter for a single module.

Parameters
[in]moduleModule number.
[in]paramNameXIA API chanel parameter name.
[in,out]valueReference to read parameter value.
Returns
int
Return values
0Success.
!=0XIA API error code.

Module parameters are unsigned ints. For a list of parameters and their units, see the Pixie-16 Programmers Manual, pgs. 62-63.

◆ WriteChanPar()

int CPixieDSPUtilities::WriteChanPar ( int  module,
int  channel,
char *  paramName,
double  value 
)

Write a channel parameter for a single channel.

Parameters
moduleModule number.
channelChannel number on module.
paramNameXIA API chanel parameter name.
valueParameter value to write.
Returns
int
Return values
0Success.
!=0XIA API error code.

Channel parameters are doubles. For a list of parameters and their units, see the Pixie-16 Programmers Manual, pgs. 60-61.

◆ WriteModPar()

int CPixieDSPUtilities::WriteModPar ( int  module,
char *  paramName,
unsigned int  value 
)

Write a module parameter for a single module.

Parameters
moduleModule number.
paramNameXIA API chanel parameter name.
valueParameter value to write.
Returns
int
Return values
0Success.
!=0XIA API error code.

Module parameters are unsigned ints. For a list of parameters and their units, see the Pixie-16 Programmers Manual, pgs. 62-63.


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