Configuration save-related function command data mask. More...

Collaboration diagram for Command mask: Configuration Save:

Macros
#define	DATAMASK_CMD_SAVE_NAME UINT64_C(0x1)
	Name of the save. More...

#define	DATAMASK_CMD_SAVE_LIST_OFFSET UINT64_C(0x2)
	Offset for list of saved configuration. If not set: 0. More...

#define	DATAMASK_CMD_SAVE_LIST_COUNT UINT64_C(0x4)
	Number of saved configuration. More...

#define	DATAMASK_CMD_SAVE_LIST_NAMES UINT64_C(0x8)
	List of CONFIGSAVE_LIST_MAXLEN saved configuration starting from the one speficied in the optional parameter DATAMASK_CMD_SAVE_LIST_OFFSET. More...

#define	DATAMASK_CMD_SAVE_HV_RELOAD UINT64_C(0x10)
	Reload saved HV parameters. Boolean (false if not set). More...

#define	DATAMASK_CMD_SAVE_DB_PATH UINT64_C(0x20)
	Set or get the complete path (including filename) were to look for saves database. Such database is used for both CAEN_MCA_CMD_CONFIGURATION_SAVE and CAEN_MCA_CMD_CONFIGURATION_LOAD commands. More...

Detailed Description

Configuration save-related function command data mask.

See also: CAEN_MCA_CMD_CONFIGURATION_SAVE CAEN_MCA_CMD_CONFIGURATION_LOAD CAEN_MCA_CMD_CONFIGURATION_LIST CAEN_MCA_CMD_CONFIGURATION_DELETE

Macro Definition Documentation

◆ DATAMASK_CMD_SAVE_NAME

#define DATAMASK_CMD_SAVE_NAME UINT64_C(0x1)

Name of the save.

Note: Required argument: char*; Maximum size: CONFIGSAVE_NAME_MAXLEN; Access type: input

Warning

If not set:

For CAEN_MCA_CMD_CONFIGURATION_SAVE: the default name is a SQL CURRENT_TIMESTAMP.
For CAEN_MCA_CMD_CONFIGURATION_LOAD: most recent saved configuration will be loaded.
For CAEN_MCA_CMD_CONFIGURATION_DELETE: all the saved configurations will be deleted.

Examples:: examples_board_control.c.

Definition at line 352 of file CAENMCATypes.h.

◆ DATAMASK_CMD_SAVE_LIST_OFFSET

#define DATAMASK_CMD_SAVE_LIST_OFFSET UINT64_C(0x2)

Offset for list of saved configuration. If not set: 0.

Note: Required argument: uint32_t; Access type: input

Examples:: examples_board_control.c.

Definition at line 353 of file CAENMCATypes.h.

◆ DATAMASK_CMD_SAVE_LIST_COUNT

#define DATAMASK_CMD_SAVE_LIST_COUNT UINT64_C(0x4)

Number of saved configuration.

Note: Required argument: uint32_t; Access type: output

Examples:: examples_board_control.c.

Definition at line 354 of file CAENMCATypes.h.

◆ DATAMASK_CMD_SAVE_LIST_NAMES

#define DATAMASK_CMD_SAVE_LIST_NAMES UINT64_C(0x8)

List of CONFIGSAVE_LIST_MAXLEN saved configuration starting from the one speficied in the optional parameter DATAMASK_CMD_SAVE_LIST_OFFSET.

Note: Required argument: char** pointing to already allocated storages of size CONFIGSAVE_NAME_MAXLEN; Maximum size: CONFIGSAVE_LIST_MAXLEN; Access type: output

Examples:: examples_board_control.c.

Definition at line 355 of file CAENMCATypes.h.

◆ DATAMASK_CMD_SAVE_HV_RELOAD

#define DATAMASK_CMD_SAVE_HV_RELOAD UINT64_C(0x10)

Reload saved HV parameters. Boolean (false if not set).

Note: Required argument: uint32_t; Access type: input

Definition at line 356 of file CAENMCATypes.h.

◆ DATAMASK_CMD_SAVE_DB_PATH

#define DATAMASK_CMD_SAVE_DB_PATH UINT64_C(0x20)

Set or get the complete path (including filename) were to look for saves database. Such database is used for both CAEN_MCA_CMD_CONFIGURATION_SAVE and CAEN_MCA_CMD_CONFIGURATION_LOAD commands.

Note: Required argument: char*; Maximum size: CONFIGSAVE_FULLPATH_MAXLEN; Access type: input/output

Examples:: examples_board_control.c.

Definition at line 357 of file CAENMCATypes.h.

Macros