Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Standard Operation Functions
NAI Board Library - Module Functions » PT Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_PT_SetClockOutEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_pt_clock_out_enable_t clock_mode)
 Sets the clock out enable to differential, single ended or disabled.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PT_GetClockOutEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_pt_clock_out_enable_t *p_outclock)
 Retrieves the clock out enable as differential, single ended or disabled.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PT_SetOutputEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_pt_output_type_t output_type)
 Sets the state of the outputs.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PT_GetOutputEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_pt_output_type_t *p_output_type)
 Retrieves the state of the outputs.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PT_SetInputFormat (int32_t cardIndex, int32_t module, int32_t channel, naibrd_pt_input_format_t input_select)
 Sets the state of IO format control bit.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PT_GetInputFormat (int32_t cardIndex, int32_t module, int32_t channel, naibrd_pt_input_format_t *input_select)
 Retreives the state of IO format control bit.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PT_SetInputTermination (int32_t cardIndex, int32_t module, int32_t channel, naibrd_pt_input_termination_t input_term)
 Sets the input termination to 0, 50, 75, or 100 Ohms.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PT_GetInputTermination (int32_t cardIndex, int32_t module, int32_t channel, naibrd_pt_input_termination_t *input_term)
 Retrieves the input termination from 0, 50, 75, or 100 Ohms.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PT_SetCrossingThreshold (int32_t cardIndex, int32_t module, int32_t channel, float64_t cross_thresh)
 Sets the Input Single-Ended Crossing Threshold. LSB = 12V/2^11 = 5.862mV.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_PT_GetCrossingThreshold (int32_t cardIndex, int32_t module, int32_t channel, float64_t *cross_thresh)
 Retrieves the Input Single-Ended Crossing Threshold. LSB = 12V/2^11 = 5.862mV.
 

Detailed Description

Function Documentation

◆ naibrd_PT_GetClockOutEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PT_GetClockOutEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_pt_clock_out_enable_t * p_outclock )

Retrieves the clock out enable as differential, single ended or disabled.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel number (1 - [max channel for module]).
p_outclock: (Output) NAIBRD_PT_CLOCK_DISABLE, NAIBRD_PT_CLOCK_SINGLEENDED, NAIBRD_PT_CLOCK_DIFF
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PT_GetCrossingThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PT_GetCrossingThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * cross_thresh )

Retrieves the Input Single-Ended Crossing Threshold. LSB = 12V/2^11 = 5.862mV.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel number (1 - [max channel for module]).
cross_thresh: (Input) 0xFFFF F800 to 0x7FF (-12V to 12V)
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PT_GetInputFormat()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PT_GetInputFormat ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_pt_input_format_t * input_select )

Retreives the state of IO format control bit.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel number (1 - [max channel for module]).
io_select: (Input) NAIBRD_PT_IO_INPUT, NAIBRD_PT_IO_SINGLEENDED, NAIBRD_PT_IO_DIFF,NAIBRD_PT_IO_SMA.
enable: (Output) reports the status of the io format control type paseed in.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid channel or naibrd_pt_io_format_t parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PT_GetInputTermination()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PT_GetInputTermination ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_pt_input_termination_t * input_term )

Retrieves the input termination from 0, 50, 75, or 100 Ohms.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel number (1 - [max channel for module]).
input_term: (Output) NAIBRD_PT_INPUT_DISABLED, NAIBRD_PT_INPUT_50_OHM, NAIBRD_PT_INPUT_75_OHM, NAIBRD_PT_INPUT_100_OHM
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PT_GetOutputEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PT_GetOutputEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_pt_output_type_t * p_output_type )

Retrieves the state of the outputs.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel number (1 - [max channel for module]).
p_output_type: (Output) NAIBRD_PT_OUTPUT_DISABLE, NAIBRD_PT_OUTPUT_5V, NAIBRD_PT_OUTPUT_12V,NAIBRD_PT_OUTPUT_5V_AND_12V
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PT_SetClockOutEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PT_SetClockOutEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_pt_clock_out_enable_t clock_mode )

Sets the clock out enable to differential, single ended or disabled.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel number (1 - [max channel for module]).
clock_mode: (Input) NAIBRD_PT_CLOCK_DISABLE, NAIBRD_PT_CLOCK_SINGLEENDED, NAIBRD_PT_CLOCK_DIFF
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PT_SetCrossingThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PT_SetCrossingThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t cross_thresh )

Sets the Input Single-Ended Crossing Threshold. LSB = 12V/2^11 = 5.862mV.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel number (1 - [max channel for module]).
cross_thresh: (Input) 0xFFFF F800 to 0x7FF (-12V to 12V)
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PT_SetInputFormat()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PT_SetInputFormat ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_pt_input_format_t input_select )

Sets the state of IO format control bit.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel number (1 - [max channel for module]).
io_select: (Input) NAIBRD_PT_IO_INPUT, NAIBRD_PT_IO_SINGLEENDED, NAIBRD_PT_IO_DIFF,NAIBRD_PT_IO_SMA.
enable: (Input)enables/disables the functionality of the io format control type paseed in.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid channel or naibrd_pt_io_format_t parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PT_SetInputTermination()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PT_SetInputTermination ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_pt_input_termination_t input_term )

Sets the input termination to 0, 50, 75, or 100 Ohms.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel number (1 - [max channel for module]).
input_term: (Input) NAIBRD_PT_INPUT_DISABLED, NAIBRD_PT_INPUT_50_OHM, NAIBRD_PT_INPUT_75_OHM, NAIBRD_PT_INPUT_100_OHM
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_PT_SetOutputEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_PT_SetOutputEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_pt_output_type_t output_type )

Sets the state of the outputs.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel number (1 - [max channel for module]).
output_type: (Output) NAIBRD_PT_OUTPUT_DISABLE, NAIBRD_PT_OUTPUT_5V, NAIBRD_PT_OUTPUT_12V,NAIBRD_PT_OUTPUT_5V_AND_12V
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.