AMU Library 3.0
C/C++ library for communicating with AMU (Aerospace Measurement Unit) devices
Loading...
Searching...
No Matches
parser.h File Reference
#include <string.h>
#include "types.h"

Go to the source code of this file.

Macros

#define SCPI_ResultMnemonic(context, data)
#define SCPI_ResultUInt8Base(c, v, b)
#define SCPI_ResultUInt8(c, v)
#define SCPI_ResultInt8(c, v)
#define SCPI_ResultUInt16Base(c, v, b)
#define SCPI_ResultUInt16(c, v)
#define SCPI_ResultInt16(c, v)
#define SCPI_Result_uint8_t(c, v)
#define SCPI_Result_uint16_t(c, v)
#define SCPI_Result_uint32_t(c, v)
#define SCPI_ResultUInt32(c, v)
#define SCPI_Result_int32_t(c, v)
#define SCPI_ResultUInt64(c, v)
#define SCPI_Result_float(c, v)
#define SCPI_Param_uint32_t(c, v, b)
#define SCPI_Param_uint16_t(c, v, b)
#define SCPI_Param_uint8_t(c, v, b)
#define SCPI_Param_int32_t(c, v, b)
#define SCPI_Param_float(c, v, b)
#define SCPI_ResultIntBase(context, val, base)
#define SCPI_ResultInt(context, val)
#define SCPI_ParamToInt(context, parameter, value)
#define SCPI_ParamToUnsignedInt(context, parameter, value)
#define SCPI_ParamInt(context, value, mandatory)
#define SCPI_ParamUnsignedInt(context, value, mandatory)

Functions

void SCPI_Init (scpi_t *context, const scpi_command_t *def_cmds, scpi_interface_t *interface, const scpi_unit_def_t *units, const char *idn1, const char *idn2, const char *idn3, const char *idn4, char *input_buffer, size_t input_buffer_length, scpi_error_t *error_queue_data, int16_t error_queue_size)
scpi_bool_t SCPI_Input (scpi_t *context, const char *data, int len)
scpi_bool_t SCPI_Parse (scpi_t *context, char *data, int len)
size_t SCPI_ResultCharacters (scpi_t *context, const char *data, size_t len)
size_t SCPI_ResultUInt32Base (scpi_t *context, uint32_t val, int8_t base)
size_t SCPI_ResultInt32 (scpi_t *context, int32_t val)
size_t SCPI_ResultUInt64Base (scpi_t *context, uint64_t val, int8_t base)
size_t SCPI_ResultInt64 (scpi_t *context, int64_t val)
size_t SCPI_ResultFloat (scpi_t *context, float val)
size_t SCPI_ResultDouble (scpi_t *context, double val)
size_t SCPI_ResultText (scpi_t *context, const char *data)
size_t SCPI_ResultError (scpi_t *context, scpi_error_t *error)
size_t SCPI_ResultArbitraryBlock (scpi_t *context, const void *data, size_t len)
size_t SCPI_ResultArbitraryBlockHeader (scpi_t *context, size_t len)
size_t SCPI_ResultArbitraryBlockData (scpi_t *context, const void *data, size_t len)
size_t SCPI_ResultBool (scpi_t *context, scpi_bool_t val)
size_t SCPI_ResultArrayInt8 (scpi_t *context, const int8_t *array, size_t count, scpi_array_format_t format)
size_t SCPI_ResultArrayUInt8 (scpi_t *context, const uint8_t *array, size_t count, scpi_array_format_t format)
size_t SCPI_ResultArrayInt16 (scpi_t *context, const int16_t *array, size_t count, scpi_array_format_t format)
size_t SCPI_ResultArrayUInt16 (scpi_t *context, const uint16_t *array, size_t count, scpi_array_format_t format)
size_t SCPI_ResultArrayInt32 (scpi_t *context, const int32_t *array, size_t count, scpi_array_format_t format)
size_t SCPI_ResultArrayUInt32 (scpi_t *context, const uint32_t *array, size_t count, scpi_array_format_t format)
size_t SCPI_ResultArrayInt64 (scpi_t *context, const int64_t *array, size_t count, scpi_array_format_t format)
size_t SCPI_ResultArrayUInt64 (scpi_t *context, const uint64_t *array, size_t count, scpi_array_format_t format)
size_t SCPI_ResultArrayFloat (scpi_t *context, const float *array, size_t count, scpi_array_format_t format)
size_t SCPI_ResultArrayDouble (scpi_t *context, const double *array, size_t count, scpi_array_format_t format)
scpi_bool_t SCPI_Parameter (scpi_t *context, scpi_parameter_t *parameter, scpi_bool_t mandatory)
scpi_bool_t SCPI_ParamIsValid (scpi_parameter_t *parameter)
scpi_bool_t SCPI_ParamErrorOccurred (scpi_t *context)
scpi_bool_t SCPI_ParamIsNumber (scpi_parameter_t *parameter, scpi_bool_t suffixAllowed)
scpi_bool_t SCPI_ParamToInt32 (scpi_t *context, scpi_parameter_t *parameter, int32_t *value)
scpi_bool_t SCPI_ParamToUInt32 (scpi_t *context, scpi_parameter_t *parameter, uint32_t *value)
scpi_bool_t SCPI_ParamToInt64 (scpi_t *context, scpi_parameter_t *parameter, int64_t *value)
scpi_bool_t SCPI_ParamToUInt64 (scpi_t *context, scpi_parameter_t *parameter, uint64_t *value)
scpi_bool_t SCPI_ParamToFloat (scpi_t *context, scpi_parameter_t *parameter, float *value)
scpi_bool_t SCPI_ParamToDouble (scpi_t *context, scpi_parameter_t *parameter, double *value)
scpi_bool_t SCPI_ParamToChoice (scpi_t *context, scpi_parameter_t *parameter, const scpi_choice_def_t *options, int32_t *value)
scpi_bool_t SCPI_ChoiceToName (const scpi_choice_def_t *options, int32_t tag, const char **text)
scpi_bool_t SCPI_ParamInt32 (scpi_t *context, int32_t *value, scpi_bool_t mandatory)
scpi_bool_t SCPI_ParamUInt32 (scpi_t *context, void *value, scpi_bool_t mandatory)
scpi_bool_t SCPI_ParamInt64 (scpi_t *context, int64_t *value, scpi_bool_t mandatory)
scpi_bool_t SCPI_ParamUInt64 (scpi_t *context, uint64_t *value, scpi_bool_t mandatory)
scpi_bool_t SCPI_ParamFloat (scpi_t *context, void *value, scpi_bool_t mandatory)
scpi_bool_t SCPI_ParamDouble (scpi_t *context, double *value, scpi_bool_t mandatory)
scpi_bool_t SCPI_ParamCharacters (scpi_t *context, const char **value, size_t *len, scpi_bool_t mandatory)
scpi_bool_t SCPI_ParamArbitraryBlock (scpi_t *context, const char **value, size_t *len, scpi_bool_t mandatory)
scpi_bool_t SCPI_ParamCopyText (scpi_t *context, char *buffer, size_t buffer_len, size_t *copy_len, scpi_bool_t mandatory)
scpi_bool_t SCPI_ParamBool (scpi_t *context, scpi_bool_t *value, scpi_bool_t mandatory)
scpi_bool_t SCPI_ParamChoice (scpi_t *context, const scpi_choice_def_t *options, int32_t *value, scpi_bool_t mandatory)
scpi_bool_t SCPI_ParamArrayInt32 (scpi_t *context, int32_t *data, size_t i_count, size_t *o_count, scpi_array_format_t format, scpi_bool_t mandatory)
scpi_bool_t SCPI_ParamArrayUInt32 (scpi_t *context, uint32_t *data, size_t i_count, size_t *o_count, scpi_array_format_t format, scpi_bool_t mandatory)
scpi_bool_t SCPI_ParamArrayInt64 (scpi_t *context, int64_t *data, size_t i_count, size_t *o_count, scpi_array_format_t format, scpi_bool_t mandatory)
scpi_bool_t SCPI_ParamArrayUInt64 (scpi_t *context, uint64_t *data, size_t i_count, size_t *o_count, scpi_array_format_t format, scpi_bool_t mandatory)
scpi_bool_t SCPI_ParamArrayFloat (scpi_t *context, float *data, size_t i_count, size_t *o_count, scpi_array_format_t format, scpi_bool_t mandatory)
scpi_bool_t SCPI_ParamArrayDouble (scpi_t *context, double *data, size_t i_count, size_t *o_count, scpi_array_format_t format, scpi_bool_t mandatory)
scpi_bool_t SCPI_IsCmd (scpi_t *context, const char *cmd)
uint16_t SCPI_CmdTag (scpi_t *context)
scpi_bool_t SCPI_Match (const char *pattern, const char *value, size_t len, bool *query)
scpi_bool_t SCPI_CommandNumbers (scpi_t *context, int32_t *numbers, size_t len, int32_t default_value)

Macro Definition Documentation

◆ SCPI_Param_float

#define SCPI_Param_float ( c,
v,
b )
Value:
SCPI_ParamFloat(c, v, b)
SCPI_ParamFloat
scpi_bool_t SCPI_ParamFloat(scpi_t *context, void *value, scpi_bool_t mandatory)
Definition parser.c:1032

Definition at line 121 of file parser.h.

◆ SCPI_Param_int32_t

#define SCPI_Param_int32_t ( c,
v,
b )
Value:
SCPI_ParamInt32(c, v, b)
SCPI_ParamInt32
scpi_bool_t SCPI_ParamInt32(scpi_t *context, int32_t *value, scpi_bool_t mandatory)
Definition parser.c:1158

Definition at line 117 of file parser.h.

◆ SCPI_Param_uint16_t

#define SCPI_Param_uint16_t ( c,
v,
b )
Value:
SCPI_ParamUInt32(c, v, b)
SCPI_ParamUInt32
scpi_bool_t SCPI_ParamUInt32(scpi_t *context, void *value, scpi_bool_t mandatory)
Definition parser.c:1169

Definition at line 115 of file parser.h.

◆ SCPI_Param_uint32_t

#define SCPI_Param_uint32_t ( c,
v,
b )
Value:
SCPI_ParamUInt32(c, v, b)

Definition at line 114 of file parser.h.

◆ SCPI_Param_uint8_t

#define SCPI_Param_uint8_t ( c,
v,
b )
Value:
SCPI_ParamUInt32(c, v, b)

Definition at line 116 of file parser.h.

◆ SCPI_ParamInt

#define SCPI_ParamInt ( context,
value,
mandatory )
Value:
SCPI_ParamInt32((context), (value), (mandatory))

Definition at line 150 of file parser.h.

◆ SCPI_ParamToInt

#define SCPI_ParamToInt ( context,
parameter,
value )
Value:
SCPI_ParamToInt32((context), (parameter), (value))
SCPI_ParamToInt32
scpi_bool_t SCPI_ParamToInt32(scpi_t *context, scpi_parameter_t *parameter, int32_t *value)
Definition parser.c:922

Definition at line 148 of file parser.h.

◆ SCPI_ParamToUnsignedInt

#define SCPI_ParamToUnsignedInt ( context,
parameter,
value )
Value:
SCPI_ParamToUInt32((context), (parameter), (value))
SCPI_ParamToUInt32
scpi_bool_t SCPI_ParamToUInt32(scpi_t *context, scpi_parameter_t *parameter, uint32_t *value)
Definition parser.c:933

Definition at line 149 of file parser.h.

◆ SCPI_ParamUnsignedInt

#define SCPI_ParamUnsignedInt ( context,
value,
mandatory )
Value:
SCPI_ParamUInt32((context), (value), (mandatory))

Definition at line 151 of file parser.h.

◆ SCPI_Result_float

#define SCPI_Result_float ( c,
v )
Value:
SCPI_ResultFloat((c), (v))
SCPI_ResultFloat
size_t SCPI_ResultFloat(scpi_t *context, float val)
Definition parser.c:568

Definition at line 79 of file parser.h.

◆ SCPI_Result_int32_t

#define SCPI_Result_int32_t ( c,
v )
Value:
SCPI_ResultInt32((c), (v))
SCPI_ResultInt32
size_t SCPI_ResultInt32(scpi_t *context, int32_t val)
Definition parser.c:527

Definition at line 73 of file parser.h.

◆ SCPI_Result_uint16_t

#define SCPI_Result_uint16_t ( c,
v )
Value:
SCPI_ResultUInt32Base((c), (v), 10)
SCPI_ResultUInt32Base
size_t SCPI_ResultUInt32Base(scpi_t *context, uint32_t val, int8_t base)
Definition parser.c:538

Definition at line 70 of file parser.h.

◆ SCPI_Result_uint32_t

#define SCPI_Result_uint32_t ( c,
v )
Value:
SCPI_ResultUInt32Base((c), (v), 10)

Definition at line 71 of file parser.h.

◆ SCPI_Result_uint8_t

#define SCPI_Result_uint8_t ( c,
v )
Value:
SCPI_ResultUInt32Base((c), (v), 10)

Definition at line 69 of file parser.h.

◆ SCPI_ResultInt

#define SCPI_ResultInt ( context,
val )
Value:
SCPI_ResultInt32 ((context), (val))

Definition at line 147 of file parser.h.

◆ SCPI_ResultInt16

#define SCPI_ResultInt16 ( c,
v )
Value:
SCPI_ResultInt32((c), (int16_t)(v))

Definition at line 67 of file parser.h.

◆ SCPI_ResultInt8

#define SCPI_ResultInt8 ( c,
v )
Value:
SCPI_ResultInt32((c), (int8_t)(v))

Definition at line 64 of file parser.h.

◆ SCPI_ResultIntBase

#define SCPI_ResultIntBase ( context,
val,
base )
Value:
SCPI_ResultInt32Base ((context), (val), (base), TRUE)
TRUE
#define TRUE
Definition types.h:63

Definition at line 146 of file parser.h.

◆ SCPI_ResultMnemonic

#define SCPI_ResultMnemonic ( context,
data )
Value:
SCPI_ResultCharacters((context), (data), strlen(data))
SCPI_ResultCharacters
size_t SCPI_ResultCharacters(scpi_t *context, const char *data, size_t len)
Definition parser.c:447

Definition at line 61 of file parser.h.

◆ SCPI_ResultUInt16

#define SCPI_ResultUInt16 ( c,
v )
Value:
SCPI_ResultUInt32Base((c), (uint16_t)(v), 10)

Definition at line 66 of file parser.h.

◆ SCPI_ResultUInt16Base

#define SCPI_ResultUInt16Base ( c,
v,
b )
Value:
SCPI_ResultUInt32Base((c), (uint16_t)(v), (b))

Definition at line 65 of file parser.h.

◆ SCPI_ResultUInt32

#define SCPI_ResultUInt32 ( c,
v )
Value:
SCPI_ResultUInt32Base((c), (v), 10)

Definition at line 72 of file parser.h.

◆ SCPI_ResultUInt64

#define SCPI_ResultUInt64 ( c,
v )
Value:
SCPI_ResultUInt64Base((c), (v), 10)
SCPI_ResultUInt64Base
size_t SCPI_ResultUInt64Base(scpi_t *context, uint64_t val, int8_t base)
Definition parser.c:558

Definition at line 76 of file parser.h.

◆ SCPI_ResultUInt8

#define SCPI_ResultUInt8 ( c,
v )
Value:
SCPI_ResultUInt32Base((c), (uint8_t)(v), 10)

Definition at line 63 of file parser.h.

◆ SCPI_ResultUInt8Base

#define SCPI_ResultUInt8Base ( c,
v,
b )
Value:
SCPI_ResultUInt32Base((c), (v), (uint8_t)(b))

Definition at line 62 of file parser.h.

Function Documentation

◆ SCPI_ChoiceToName()

scpi_bool_t SCPI_ChoiceToName ( const scpi_choice_def_t * options,
int32_t tag,
const char ** text )

Find tag in choices and returns its first textual representation

Parameters
optionsspecifications of choices numbers (patterns)
tagnumerical representatio of choice
textresult text
Returns
TRUE if succesfule, else FALSE

Definition at line 1349 of file parser.c.

◆ SCPI_CmdTag()

uint16_t SCPI_CmdTag ( scpi_t * context)

Return the .tag field of the matching scpi_command_t

Parameters
context
Returns

Definition at line 1593 of file parser.c.

◆ SCPI_CommandNumbers()

scpi_bool_t SCPI_CommandNumbers ( scpi_t * context,
int32_t * numbers,
size_t len,
int32_t default_value )

Definition at line 1606 of file parser.c.

◆ SCPI_Init()

void SCPI_Init ( scpi_t * context,
const scpi_command_t * def_cmds,
scpi_interface_t * interface,
const scpi_unit_def_t * units,
const char * idn1,
const char * idn2,
const char * idn3,
const char * idn4,
char * input_buffer,
size_t input_buffer_length,
scpi_error_t * error_queue_data,
int16_t error_queue_size )

Initialize SCPI context structure

Parameters
context
commands
interface
units
idn1
idn2
idn3
idn4
input_buffer
input_buffer_length
error_queue_data
error_queue_size

Definition at line 337 of file parser.c.

◆ SCPI_Input()

scpi_bool_t SCPI_Input ( scpi_t * context,
const char * data,
int len )

Interface to the application. Adds data to system buffer and try to search command line termination. If the termination is found or if len=0, command parser is called.

Parameters
context
data- data to process
len- length of data
Returns

Definition at line 394 of file parser.c.

◆ SCPI_IsCmd()

scpi_bool_t SCPI_IsCmd ( scpi_t * context,
const char * cmd )

Check current command

  • suitable for one handle to multiple commands
    Parameters
    context
    cmd
    Returns

Definition at line 1575 of file parser.c.

◆ SCPI_Match()

scpi_bool_t SCPI_Match ( const char * pattern,
const char * value,
size_t len,
bool * query )

Definition at line 1602 of file parser.c.

◆ SCPI_ParamArbitraryBlock()

scpi_bool_t SCPI_ParamArbitraryBlock ( scpi_t * context,
const char ** value,
size_t * len,
scpi_bool_t mandatory )

Get arbitrary block program data and returns pointer to data

Parameters
context
valueresult pointer to data
lenresult length of data
mandatory
Returns

Definition at line 1240 of file parser.c.

◆ SCPI_ParamArrayDouble()

scpi_bool_t SCPI_ParamArrayDouble ( scpi_t * context,
double * data,
size_t i_count,
size_t * o_count,
scpi_array_format_t format,
scpi_bool_t mandatory )

Read list of values up to i_count

Parameters
context
data- array to fill
i_count- number of elements of data
o_count- real number of filled elements
mandatory
Returns
TRUE on success

Definition at line 1916 of file parser.c.

◆ SCPI_ParamArrayFloat()

scpi_bool_t SCPI_ParamArrayFloat ( scpi_t * context,
float * data,
size_t i_count,
size_t * o_count,
scpi_array_format_t format,
scpi_bool_t mandatory )

Read list of values up to i_count

Parameters
context
data- array to fill
i_count- number of elements of data
o_count- real number of filled elements
mandatory
Returns
TRUE on success

Definition at line 1903 of file parser.c.

◆ SCPI_ParamArrayInt32()

scpi_bool_t SCPI_ParamArrayInt32 ( scpi_t * context,
int32_t * data,
size_t i_count,
size_t * o_count,
scpi_array_format_t format,
scpi_bool_t mandatory )

Read list of values up to i_count

Parameters
context
data- array to fill
i_count- number of elements of data
o_count- real number of filled elements
mandatory
Returns
TRUE on success

Definition at line 1851 of file parser.c.

◆ SCPI_ParamArrayInt64()

scpi_bool_t SCPI_ParamArrayInt64 ( scpi_t * context,
int64_t * data,
size_t i_count,
size_t * o_count,
scpi_array_format_t format,
scpi_bool_t mandatory )

Read list of values up to i_count

Parameters
context
data- array to fill
i_count- number of elements of data
o_count- real number of filled elements
mandatory
Returns
TRUE on success

Definition at line 1877 of file parser.c.

◆ SCPI_ParamArrayUInt32()

scpi_bool_t SCPI_ParamArrayUInt32 ( scpi_t * context,
uint32_t * data,
size_t i_count,
size_t * o_count,
scpi_array_format_t format,
scpi_bool_t mandatory )

Read list of values up to i_count

Parameters
context
data- array to fill
i_count- number of elements of data
o_count- real number of filled elements
mandatory
Returns
TRUE on success

Definition at line 1864 of file parser.c.

◆ SCPI_ParamArrayUInt64()

scpi_bool_t SCPI_ParamArrayUInt64 ( scpi_t * context,
uint64_t * data,
size_t i_count,
size_t * o_count,
scpi_array_format_t format,
scpi_bool_t mandatory )

Read list of values up to i_count

Parameters
context
data- array to fill
i_count- number of elements of data
o_count- real number of filled elements
mandatory
Returns
TRUE on success

Definition at line 1890 of file parser.c.

◆ SCPI_ParamBool()

scpi_bool_t SCPI_ParamBool ( scpi_t * context,
scpi_bool_t * value,
scpi_bool_t mandatory )

Read BOOL parameter (0,1,ON,OFF)

Parameters
context
value
mandatory
Returns

Definition at line 1369 of file parser.c.

◆ SCPI_ParamCharacters()

scpi_bool_t SCPI_ParamCharacters ( scpi_t * context,
const char ** value,
size_t * len,
scpi_bool_t mandatory )

Read character parameter

Parameters
context
value
len
mandatory
Returns

Definition at line 1203 of file parser.c.

◆ SCPI_ParamChoice()

scpi_bool_t SCPI_ParamChoice ( scpi_t * context,
const scpi_choice_def_t * options,
int32_t * value,
scpi_bool_t mandatory )

Read value from list of options

Parameters
context
options
value
mandatory
Returns

Definition at line 1410 of file parser.c.

◆ SCPI_ParamCopyText()

scpi_bool_t SCPI_ParamCopyText ( scpi_t * context,
char * buffer,
size_t buffer_len,
size_t * copy_len,
scpi_bool_t mandatory )

Definition at line 1263 of file parser.c.

◆ SCPI_ParamDouble()

scpi_bool_t SCPI_ParamDouble ( scpi_t * context,
double * value,
scpi_bool_t mandatory )

Read floating point double (64 bit) parameter

Parameters
context
value
mandatory
Returns

Definition at line 1063 of file parser.c.

◆ SCPI_ParamErrorOccurred()

scpi_bool_t SCPI_ParamErrorOccurred ( scpi_t * context)

Returns TRUE if there was an error during parameter handling

Parameters
context
Returns

Definition at line 1625 of file parser.c.

◆ SCPI_Parameter()

scpi_bool_t SCPI_Parameter ( scpi_t * context,
scpi_parameter_t * parameter,
scpi_bool_t mandatory )

Get one parameter from command line

Parameters
context
parameter
mandatory
Returns

Definition at line 774 of file parser.c.

◆ SCPI_ParamFloat()

scpi_bool_t SCPI_ParamFloat ( scpi_t * context,
void * value,
scpi_bool_t mandatory )

Read floating point float (32 bit) parameter

Parameters
context
value
mandatory
Returns

Definition at line 1032 of file parser.c.

◆ SCPI_ParamInt32()

scpi_bool_t SCPI_ParamInt32 ( scpi_t * context,
int32_t * value,
scpi_bool_t mandatory )

Read signed 32 bit integer parameter

Parameters
context
value
mandatory
Returns

Definition at line 1158 of file parser.c.

◆ SCPI_ParamInt64()

scpi_bool_t SCPI_ParamInt64 ( scpi_t * context,
int64_t * value,
scpi_bool_t mandatory )

Read signed 64 bit integer parameter

Parameters
context
value
mandatory
Returns

Definition at line 1180 of file parser.c.

◆ SCPI_ParamIsNumber()

scpi_bool_t SCPI_ParamIsNumber ( scpi_parameter_t * parameter,
scpi_bool_t suffixAllowed )

Detect if parameter is number

Parameters
parameter
suffixAllowed
Returns

Definition at line 833 of file parser.c.

◆ SCPI_ParamIsValid()

scpi_bool_t SCPI_ParamIsValid ( scpi_parameter_t * parameter)

If SCPI_Parameter() returns FALSE, this function can detect, if the parameter is just missing (TRUE) or if there was an error during processing of the command (FALSE)

Parameters
parameter
Returns

Definition at line 1616 of file parser.c.

◆ SCPI_ParamToChoice()

scpi_bool_t SCPI_ParamToChoice ( scpi_t * context,
scpi_parameter_t * parameter,
const scpi_choice_def_t * options,
int32_t * value )

Convert parameter to choice

Parameters
context
parameter- should be PROGRAM_MNEMONIC
options- NULL terminated list of choices
value- index to options
Returns

Definition at line 1314 of file parser.c.

◆ SCPI_ParamToDouble()

scpi_bool_t SCPI_ParamToDouble ( scpi_t * context,
scpi_parameter_t * parameter,
double * value )

Convert parameter to double (64 bit)

Parameters
context
parameter
valueresult
Returns
TRUE if succesful

Definition at line 999 of file parser.c.

◆ SCPI_ParamToFloat()

scpi_bool_t SCPI_ParamToFloat ( scpi_t * context,
scpi_parameter_t * parameter,
float * value )

Convert parameter to float (32 bit)

Parameters
context
parameter
valueresult
Returns
TRUE if succesful

Definition at line 966 of file parser.c.

◆ SCPI_ParamToInt32()

scpi_bool_t SCPI_ParamToInt32 ( scpi_t * context,
scpi_parameter_t * parameter,
int32_t * value )

Convert parameter to signed 32 bit integer

Parameters
context
parameter
valueresult
Returns
TRUE if succesful

Definition at line 922 of file parser.c.

◆ SCPI_ParamToInt64()

scpi_bool_t SCPI_ParamToInt64 ( scpi_t * context,
scpi_parameter_t * parameter,
int64_t * value )

Convert parameter to signed 64 bit integer

Parameters
context
parameter
valueresult
Returns
TRUE if succesful

Definition at line 944 of file parser.c.

◆ SCPI_ParamToUInt32()

scpi_bool_t SCPI_ParamToUInt32 ( scpi_t * context,
scpi_parameter_t * parameter,
uint32_t * value )

Convert parameter to unsigned 32 bit integer

Parameters
context
parameter
valueresult
Returns
TRUE if succesful

Definition at line 933 of file parser.c.

◆ SCPI_ParamToUInt64()

scpi_bool_t SCPI_ParamToUInt64 ( scpi_t * context,
scpi_parameter_t * parameter,
uint64_t * value )

Convert parameter to unsigned 32 bit integer

Parameters
context
parameter
valueresult
Returns
TRUE if succesful

Definition at line 955 of file parser.c.

◆ SCPI_ParamUInt32()

scpi_bool_t SCPI_ParamUInt32 ( scpi_t * context,
void * value,
scpi_bool_t mandatory )

Read unsigned 32 bit integer parameter

Parameters
context
value
mandatory
Returns

Definition at line 1169 of file parser.c.

◆ SCPI_ParamUInt64()

scpi_bool_t SCPI_ParamUInt64 ( scpi_t * context,
uint64_t * value,
scpi_bool_t mandatory )

Read unsigned 64 bit integer parameter

Parameters
context
value
mandatory
Returns

Definition at line 1191 of file parser.c.

◆ SCPI_Parse()

scpi_bool_t SCPI_Parse ( scpi_t * context,
char * data,
int len )

Parse one command line

Parameters
context
data- complete command line
len- command line length
Returns
FALSE if there was some error during evaluation of commands

Definition at line 257 of file parser.c.

◆ SCPI_ResultArbitraryBlock()

size_t SCPI_ResultArbitraryBlock ( scpi_t * context,
const void * data,
size_t len )

Write arbitrary block program data to the result

Parameters
context
data
len
Returns

Definition at line 737 of file parser.c.

◆ SCPI_ResultArbitraryBlockData()

size_t SCPI_ResultArbitraryBlockData ( scpi_t * context,
const void * data,
size_t len )

Add data to arbitrary block

Parameters
context
data
len
Returns

Definition at line 714 of file parser.c.

◆ SCPI_ResultArbitraryBlockHeader()

size_t SCPI_ResultArbitraryBlockHeader ( scpi_t * context,
size_t len )

Write arbitrary block header with length

Parameters
context
len
Returns

Definition at line 694 of file parser.c.

◆ SCPI_ResultArrayDouble()

size_t SCPI_ResultArrayDouble ( scpi_t * context,
const double * array,
size_t count,
scpi_array_format_t format )

Result array of doubles

Parameters
context
array
count
format
Returns

Definition at line 1824 of file parser.c.

◆ SCPI_ResultArrayFloat()

size_t SCPI_ResultArrayFloat ( scpi_t * context,
const float * array,
size_t count,
scpi_array_format_t format )

Result array of floats

Parameters
context
array
count
format
Returns

Definition at line 1812 of file parser.c.

◆ SCPI_ResultArrayInt16()

size_t SCPI_ResultArrayInt16 ( scpi_t * context,
const int16_t * array,
size_t count,
scpi_array_format_t format )

Result array of signed 16bit integers

Parameters
context
array
count
format
Returns

Definition at line 1740 of file parser.c.

◆ SCPI_ResultArrayInt32()

size_t SCPI_ResultArrayInt32 ( scpi_t * context,
const int32_t * array,
size_t count,
scpi_array_format_t format )

Result array of signed 32bit integers

Parameters
context
array
count
format
Returns

Definition at line 1764 of file parser.c.

◆ SCPI_ResultArrayInt64()

size_t SCPI_ResultArrayInt64 ( scpi_t * context,
const int64_t * array,
size_t count,
scpi_array_format_t format )

Result array of signed 64bit integers

Parameters
context
array
count
format
Returns

Definition at line 1788 of file parser.c.

◆ SCPI_ResultArrayInt8()

size_t SCPI_ResultArrayInt8 ( scpi_t * context,
const int8_t * array,
size_t count,
scpi_array_format_t format )

Result array of signed 8bit integers

Parameters
context
array
count
format
Returns

Definition at line 1716 of file parser.c.

◆ SCPI_ResultArrayUInt16()

size_t SCPI_ResultArrayUInt16 ( scpi_t * context,
const uint16_t * array,
size_t count,
scpi_array_format_t format )

Result array of unsigned 16bit integers

Parameters
context
array
count
format
Returns

Definition at line 1752 of file parser.c.

◆ SCPI_ResultArrayUInt32()

size_t SCPI_ResultArrayUInt32 ( scpi_t * context,
const uint32_t * array,
size_t count,
scpi_array_format_t format )

Result array of unsigned 32bit integers

Parameters
context
array
count
format
Returns

Definition at line 1776 of file parser.c.

◆ SCPI_ResultArrayUInt64()

size_t SCPI_ResultArrayUInt64 ( scpi_t * context,
const uint64_t * array,
size_t count,
scpi_array_format_t format )

Result array of unsigned 64bit integers

Parameters
context
array
count
format
Returns

Definition at line 1800 of file parser.c.

◆ SCPI_ResultArrayUInt8()

size_t SCPI_ResultArrayUInt8 ( scpi_t * context,
const uint8_t * array,
size_t count,
scpi_array_format_t format )

Result array of unsigned 8bit integers

Parameters
context
array
count
format
Returns

Definition at line 1728 of file parser.c.

◆ SCPI_ResultBool()

size_t SCPI_ResultBool ( scpi_t * context,
scpi_bool_t val )

Write boolean value to the result

Parameters
context
val
Returns

Definition at line 750 of file parser.c.

◆ SCPI_ResultCharacters()

size_t SCPI_ResultCharacters ( scpi_t * context,
const char * data,
size_t len )

Write raw string result to the output

Parameters
context
data
Returns

Definition at line 447 of file parser.c.

◆ SCPI_ResultDouble()

size_t SCPI_ResultDouble ( scpi_t * context,
double val )

Write double (64bit) value to the result

Parameters
context
val
Returns

Definition at line 584 of file parser.c.

◆ SCPI_ResultError()

size_t SCPI_ResultError ( scpi_t * context,
scpi_error_t * error )

SCPI-99:21.8 Device-dependent error information. Write error information with the following syntax: <Error/event_number>,"<Error/event_description>[;<Device-dependent_info>]" The maximum string length of <Error/event_description> plus <Device-dependent_info> is SCPI_STD_ERROR_DESC_MAX_STRING_LENGTH (255) characters.

Parameters
context
error
Returns

Definition at line 629 of file parser.c.

◆ SCPI_ResultFloat()

size_t SCPI_ResultFloat ( scpi_t * context,
float val )

Write float (32 bit) value to the result

Parameters
context
val
Returns

Definition at line 568 of file parser.c.

◆ SCPI_ResultInt32()

size_t SCPI_ResultInt32 ( scpi_t * context,
int32_t val )

Write signed 32 bit integer value to the result

Parameters
context
val
Returns

Definition at line 527 of file parser.c.

◆ SCPI_ResultInt64()

size_t SCPI_ResultInt64 ( scpi_t * context,
int64_t val )

Write signed 64 bit integer value to the result

Parameters
context
val
Returns

Definition at line 548 of file parser.c.

◆ SCPI_ResultText()

size_t SCPI_ResultText ( scpi_t * context,
const char * data )

Write string withn " to the result

Parameters
context
data
Returns

Definition at line 600 of file parser.c.

◆ SCPI_ResultUInt32Base()

size_t SCPI_ResultUInt32Base ( scpi_t * context,
uint32_t val,
int8_t base )

Write unsigned 32 bit integer value in specific base to the result Write signed/unsigned 32 bit integer value in specific base to the result

Parameters
context
val
Returns

Definition at line 538 of file parser.c.

◆ SCPI_ResultUInt64Base()

size_t SCPI_ResultUInt64Base ( scpi_t * context,
uint64_t val,
int8_t base )

Write unsigned 64 bit integer value in specific base to the result

Parameters
context
val
Returns

Definition at line 558 of file parser.c.