Model control functionality. More...

Collaboration diagram for Model Control:

Classes
struct	AbsModelInfo
	Information about a model. Strings are null-terminated. More...

Macros
#define	ABS_MODEL_STATUS_RUNNING (0x01)
	Model is running.

#define	ABS_MODEL_STATUS_LOADED (0x02)
	Model is loaded.

#define	ABS_MODEL_STATUS_ERRORED (0x04)
	Model has errored.

Functions
int	AbsScpiClient_GetModelStatus (AbsScpiClientHandle handle, uint8_t *status_out)
	Query the model status.

int	AbsScpiClient_LoadModel (AbsScpiClientHandle handle)
	Load the model configuration on the device.

int	AbsScpiClient_StartModel (AbsScpiClientHandle handle)
	Start modeling.

int	AbsScpiClient_StopModel (AbsScpiClientHandle handle)
	Stop modeling.

int	AbsScpiClient_UnloadModel (AbsScpiClientHandle handle)
	Unload the model configuration.

int	AbsScpiClient_GetModelInfo (AbsScpiClientHandle handle, AbsModelInfo *model_info_out)
	Query information about the loaded model.

int	AbsScpiClient_GetModelId (AbsScpiClientHandle handle, char id_buf[], unsigned int buf_len)
	Query the ID of the currently loaded model.

int	AbsScpiClient_SetGlobalModelInput (AbsScpiClientHandle handle, unsigned int index, float value)
	Set a single global model input.

int	AbsScpiClient_SetAllGlobalModelInputs (AbsScpiClientHandle handle, const float values[], unsigned int count)
	Set multiple global model inputs.

int	AbsScpiClient_GetGlobalModelInput (AbsScpiClientHandle handle, unsigned int index, float *value_out)
	Query the value of a single global model input.

int	AbsScpiClient_GetAllGlobalModelInputs (AbsScpiClientHandle handle, float values_out[], unsigned int count)
	Query the values of multiple global model inputs.

int	AbsScpiClient_SetLocalModelInput (AbsScpiClientHandle handle, unsigned int index, float value)
	Set a single local model input.

int	AbsScpiClient_SetAllLocalModelInputs (AbsScpiClientHandle handle, const float values[], unsigned int count)
	Set multiple local model inputs.

int	AbsScpiClient_GetLocalModelInput (AbsScpiClientHandle handle, unsigned int index, float *value_out)
	Query the value of a single local model input.

int	AbsScpiClient_GetAllLocalModelInputs (AbsScpiClientHandle handle, float values_out[], unsigned int count)
	Query the values of multiple local model inputs.

int	AbsScpiClient_GetModelOutput (AbsScpiClientHandle handle, unsigned int index, float *value_out)
	Query a single model output.

int	AbsScpiClient_GetAllModelOutputs (AbsScpiClientHandle handle, float values_out[], unsigned int count)
	Query multiple model outputs.

Detailed Description

Model control functionality.

Function Documentation

◆ AbsScpiClient_GetAllGlobalModelInputs()

int AbsScpiClient_GetAllGlobalModelInputs	(	AbsScpiClientHandle	handle,
		float	values_out[],
		unsigned int	count
	)

Query the values of multiple global model inputs.

Parameters

[in]	handle	SCPI client
[out]	values_out	array of returned values, one per input
[in]	count	length of the array (must not be longer than the total input count)

Returns: 0 on success or a negative error code.

◆ AbsScpiClient_GetAllLocalModelInputs()

int AbsScpiClient_GetAllLocalModelInputs	(	AbsScpiClientHandle	handle,
		float	values_out[],
		unsigned int	count
	)

Query the values of multiple local model inputs.

Parameters

[in]	handle	SCPI client
[out]	values_out	array of returned values, one per input
[in]	count	length of the array (must not be longer than the total input count)

Returns: 0 on success or a negative error code.

◆ AbsScpiClient_GetAllModelOutputs()

int AbsScpiClient_GetAllModelOutputs	(	AbsScpiClientHandle	handle,
		float	values_out[],
		unsigned int	count
	)

Query multiple model outputs.

Parameters

[in]	handle	SCPI client
[out]	values_out	array of returned outputs
[in]	count	length of the array (must not be greater than the total model output count)

Returns: 0 on success or a negative error code.

◆ AbsScpiClient_GetGlobalModelInput()

int AbsScpiClient_GetGlobalModelInput	(	AbsScpiClientHandle	handle,
		unsigned int	index,
		float *	value_out
	)

Query the value of a single global model input.

Parameters

[in]	handle	SCPI client
[in]	index	index of the input, 0-7
[out]	value_out	pointer to the returned value

Returns: 0 on success or a negative error code.

◆ AbsScpiClient_GetLocalModelInput()

int AbsScpiClient_GetLocalModelInput	(	AbsScpiClientHandle	handle,
		unsigned int	index,
		float *	value_out
	)

Query the value of a single local model input.

Parameters

[in]	handle	SCPI client
[in]	index	index of the input, 0-7
[out]	value_out	pointer to the returned value

Returns: 0 on success or a negative error code.

◆ AbsScpiClient_GetModelId()

int AbsScpiClient_GetModelId	(	AbsScpiClientHandle	handle,
		char	id_buf[],
		unsigned int	buf_len
	)

Query the ID of the currently loaded model.

This ID is user-defined and is not used by the unit. It is intended for use by tools.

Parameters

[in]	handle	SCPI client
[out]	id_buf	buffer to store the null-terminated ID
[in]	buf_len	length of id_buf

Returns: 0 on success or a negative error code.

◆ AbsScpiClient_GetModelInfo()

int AbsScpiClient_GetModelInfo	(	AbsScpiClientHandle	handle,
		AbsModelInfo *	model_info_out
	)

Query information about the loaded model.

Parameters

[in]	handle	SCPI client
[out]	model_info_out	pointer to the returned model info

Returns: 0 on success or a negative error code.

◆ AbsScpiClient_GetModelOutput()

int AbsScpiClient_GetModelOutput	(	AbsScpiClientHandle	handle,
		unsigned int	index,
		float *	value_out
	)

Query a single model output.

Parameters

[in]	handle	SCPI client
[in]	index	output index, 0-35
[out]	value_out	pointer to the returned model output

Returns: 0 on success or a negative error code.

◆ AbsScpiClient_GetModelStatus()

int AbsScpiClient_GetModelStatus	(	AbsScpiClientHandle	handle,
		uint8_t *	status_out
	)

Query the model status.

The ABS_MODEL_STATUS_* macros can be used to interpret the status.

Parameters

[in]	handle	SCPI client
[out]	status_out	pointer to the returned status bits

Returns: 0 on success or a negative error code.

◆ AbsScpiClient_LoadModel()

int AbsScpiClient_LoadModel ( AbsScpiClientHandle handle )

Load the model configuration on the device.

Parameters

[in] handle SCPI client

Returns: 0 on success or a negative error code.

◆ AbsScpiClient_SetAllGlobalModelInputs()

int AbsScpiClient_SetAllGlobalModelInputs	(	AbsScpiClientHandle	handle,
		const float	values[],
		unsigned int	count
	)

Set multiple global model inputs.

Particularly useful with multicast to address multiple units at once.

Parameters

[in]	handle	SCPI client
[in]	values	array of values, one per input
[in]	count	number of values to send (must not be greater than the total input count)

Returns: 0 on success or a negative error code.

◆ AbsScpiClient_SetAllLocalModelInputs()

int AbsScpiClient_SetAllLocalModelInputs	(	AbsScpiClientHandle	handle,
		const float	values[],
		unsigned int	count
	)

Set multiple local model inputs.

Parameters

[in]	handle	SCPI client
[in]	values	array of values, one per input
[in]	count	number of values to send (must not be greater than the total input count)

Returns: 0 on success or a negative error code.

◆ AbsScpiClient_SetGlobalModelInput()

int AbsScpiClient_SetGlobalModelInput	(	AbsScpiClientHandle	handle,
		unsigned int	index,
		float	value
	)

Set a single global model input.

Particularly useful with multicast to address multiple units at once.

Parameters

[in]	handle	SCPI client
[in]	index	input index, 0-7
[in]	value	desired input value

Returns: 0 on success or a negative error code.

◆ AbsScpiClient_SetLocalModelInput()

int AbsScpiClient_SetLocalModelInput	(	AbsScpiClientHandle	handle,
		unsigned int	index,
		float	value
	)

Set a single local model input.

Parameters

[in]	handle	SCPI client
[in]	index	input index, 0-7
[in]	value	desired input value

Returns: 0 on success or a negative error code.

◆ AbsScpiClient_StartModel()

int AbsScpiClient_StartModel ( AbsScpiClientHandle handle )

Start modeling.

Parameters

[in] handle SCPI client

Returns: 0 on success or a negative error code.

◆ AbsScpiClient_StopModel()

int AbsScpiClient_StopModel ( AbsScpiClientHandle handle )

Stop modeling.

Parameters

[in] handle SCPI client

Returns: 0 on success or a negative error code.

◆ AbsScpiClient_UnloadModel()

int AbsScpiClient_UnloadModel ( AbsScpiClientHandle handle )

Unload the model configuration.

Parameters

[in] handle SCPI client

Returns: 0 on success or a negative error code.

Classes

Macros

Functions

Detailed Description

Function Documentation

◆ AbsScpiClient_GetAllGlobalModelInputs()

◆ AbsScpiClient_GetAllLocalModelInputs()

◆ AbsScpiClient_GetAllModelOutputs()

◆ AbsScpiClient_GetGlobalModelInput()

◆ AbsScpiClient_GetLocalModelInput()

◆ AbsScpiClient_GetModelId()

◆ AbsScpiClient_GetModelInfo()

◆ AbsScpiClient_GetModelOutput()

◆ AbsScpiClient_GetModelStatus()

◆ AbsScpiClient_LoadModel()

◆ AbsScpiClient_SetAllGlobalModelInputs()

◆ AbsScpiClient_SetAllLocalModelInputs()

◆ AbsScpiClient_SetGlobalModelInput()

◆ AbsScpiClient_SetLocalModelInput()

◆ AbsScpiClient_StartModel()

◆ AbsScpiClient_StopModel()

◆ AbsScpiClient_UnloadModel()