Internal Access Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_SetInduceBIT (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rly_state_t forceBIT)
	Induces a simulated BIT fault on the specified RLY channel, by inverting the readback from the secondary pole. forceBIT is set to zero under normal conditions, and set to one to force a BIT condition. For test purposes only.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_GetInduceBIT (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rly_state_t *p_outforceBIT)
	Reads the Induce BIT configuration setting for the specified RLY channel.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_RLY_GetRelayType (int32_t cardIndex, int32_t module, naibrd_rly_relaytype_t *p_outtype)
	Returns the relay type designation for the specified RLY Module (fixed by hardware configuration). 0 denotes non-latching, 1 is latching type. For internal reference purposes only.

Detailed Description

Function Documentation

naibrd_RLY_GetInduceBIT()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetInduceBIT	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_rly_state_t *	p_outforceBIT )

Reads the Induce BIT configuration setting for the specified RLY channel.

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 of the channel to access (1 - [max channels for module]).
p_outforceBIT	: (Output) NAIBRD_RLY_STATE_OPEN (normal) or NAIBRD_RLY_STATE_CLOSE (BIT forced).

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_CHANNEL when invalid channel parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_RLY_GetRelayType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_GetRelayType	(	int32_t	cardIndex,
		int32_t	module,
		naibrd_rly_relaytype_t *	p_outtype )

Returns the relay type designation for the specified RLY Module (fixed by hardware configuration). 0 denotes non-latching, 1 is latching type. For internal reference purposes only.

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]).
p_outtype	: (Output) Relay Type (latching or non-latching): refer to naibrd_rly_relaytype_t definitions.

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_RLY_SetInduceBIT()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RLY_SetInduceBIT	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_rly_state_t	forceBIT )

Induces a simulated BIT fault on the specified RLY channel, by inverting the readback from the secondary pole. forceBIT is set to zero under normal conditions, and set to one to force a BIT condition. For test purposes only.

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 of the channel to access (1 - [max channels for module]).
forceBIT	: (Input) NAIBRD_RLY_STATE_OPEN (normal) or NAIBRD_RLY_STATE_CLOSE (BIT forced).

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_CHANNEL when invalid channel parameter is specified.
• NAI_ERROR_INVALID_VALUE when invalid forceBIT parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.