Data mask: Parameter info

Information about the Parameter. Read only. More...

Collaboration diagram for Data mask: Parameter info:

Modules
	Data mask: Parameter info (information bits)
	Bits provided by DATAMASK_PARAMINFO_INFOMASK.

Macros
#define	DATAMASK_PARAMINFO_NAME   UINT64_C(0x1)
	Parameter name. More...
#define	DATAMASK_PARAMINFO_CODENAME   UINT64_C(0X2)
	Parameter codename (unique) More...
#define	DATAMASK_PARAMINFO_INFOMASK   UINT64_C(0X4)
	Extra information mask. More...
#define	DATAMASK_PARAMINFO_UOM_NAME   UINT64_C(0x8)
	Symbol of the SI unit of measurement. Metrix prefix specified by DATAMASK_PARAMINFO_UOM_POWER as power of 10. Example: in case of millivolts, the name will be "V" and the power "-3". More...
#define	DATAMASK_PARAMINFO_UOM_CODENAME   UINT64_C(0x10)
	Codename of the unit of measurement. More...
#define	DATAMASK_PARAMINFO_UOM_POWER   UINT64_C(0x20)
	Power of 10 to multiply with respect to the unit of measurement. Example: in case of millivolts, the name will be "V" and the power "-3". More...
#define	DATAMASK_PARAMINFO_TYPE   UINT64_C(0x40)
	Type of parameter (range or list) More...
#define	DATAMASK_PARAMINFO_MIN   UINT64_C(0x80)
	Min. value allowed. More...
#define	DATAMASK_PARAMINFO_MAX   UINT64_C(0x100)
	Max. value allowed. More...
#define	DATAMASK_PARAMINFO_INCR   UINT64_C(0x200)
	Min. step allowed. More...
#define	DATAMASK_PARAMINFO_NALLOWED_VALUES   UINT64_C(0x400)
	In case of list parameter: number of allowed values. More...
#define	DATAMASK_PARAMINFO_ALLOWED_VALUES   UINT64_C(0x800)
	In case of list parameter: allowed values. More...
#define	DATAMASK_PARAMINFO_ALLOWED_VALUE_CODENAMES   UINT64_C(0x1000)
	In case of list parameter: allowed codenames. More...
#define	DATAMASK_PARAMINFO_ALLOWED_VALUE_NAMES   UINT64_C(0x2000)
	In case of list parameter: names of allowed values. More...

Detailed Description

Information about the Parameter. Read only.

See also

CAEN_MCA_DATA_PARAMETER_INFO

Macro Definition Documentation

DATAMASK_PARAMINFO_NAME

#define DATAMASK_PARAMINFO_NAME   UINT64_C(0x1)

Parameter name.

Note

Required argument: char*

Maximum size: PARAMINFO_NAME_MAXLEN

Access type: read only

Examples:

examples_parameters.c.

Definition at line 445 of file CAENMCATypes.h.

DATAMASK_PARAMINFO_CODENAME

#define DATAMASK_PARAMINFO_CODENAME   UINT64_C(0X2)

Parameter codename (unique)

Note

Required argument: char*

Maximum size: PARAMINFO_NAME_MAXLEN

Access type: read only

Examples:

examples_parameters.c.

Definition at line 446 of file CAENMCATypes.h.

DATAMASK_PARAMINFO_INFOMASK

#define DATAMASK_PARAMINFO_INFOMASK   UINT64_C(0X4)

Extra information mask.

Note

Required argument: uint32_t

Access type: read only

See also

Data mask: Parameter info (information bits)

Examples:

examples_parameters.c.

Definition at line 447 of file CAENMCATypes.h.

DATAMASK_PARAMINFO_UOM_NAME

#define DATAMASK_PARAMINFO_UOM_NAME   UINT64_C(0x8)

Symbol of the SI unit of measurement. Metrix prefix specified by DATAMASK_PARAMINFO_UOM_POWER as power of 10. Example: in case of millivolts, the name will be "V" and the power "-3".

Note

Required argument: char*

Maximum size: PARAMINFO_NAME_MAXLEN

Access type: read only

Examples:

examples_parameters.c.

Definition at line 448 of file CAENMCATypes.h.

DATAMASK_PARAMINFO_UOM_CODENAME

#define DATAMASK_PARAMINFO_UOM_CODENAME   UINT64_C(0x10)

Codename of the unit of measurement.

Note

Required argument: char*

Maximum size: PARAMINFO_NAME_MAXLEN

Access type: read only

Examples:

examples_parameters.c.

Definition at line 449 of file CAENMCATypes.h.

DATAMASK_PARAMINFO_UOM_POWER

#define DATAMASK_PARAMINFO_UOM_POWER   UINT64_C(0x20)

Power of 10 to multiply with respect to the unit of measurement. Example: in case of millivolts, the name will be "V" and the power "-3".

Note

Required argument: int32_t

Access type: read only

Examples:

examples_parameters.c.

Definition at line 450 of file CAENMCATypes.h.

DATAMASK_PARAMINFO_TYPE

#define DATAMASK_PARAMINFO_TYPE   UINT64_C(0x40)

Type of parameter (range or list)

Note

Required argument: int32_t

Access type: read only

See also

CAEN_MCA_ParameterType_t

Examples:

examples_parameters.c.

Definition at line 451 of file CAENMCATypes.h.

DATAMASK_PARAMINFO_MIN

#define DATAMASK_PARAMINFO_MIN   UINT64_C(0x80)

Min. value allowed.

Note

Required argument: double

Access type: read only

Examples:

examples_parameters.c.

Definition at line 452 of file CAENMCATypes.h.

DATAMASK_PARAMINFO_MAX

#define DATAMASK_PARAMINFO_MAX   UINT64_C(0x100)

Max. value allowed.

Note

Required argument: double

Access type: read only

Examples:

examples_parameters.c.

Definition at line 453 of file CAENMCATypes.h.

DATAMASK_PARAMINFO_INCR

#define DATAMASK_PARAMINFO_INCR   UINT64_C(0x200)

Min. step allowed.

Note

Required argument: double

Access type: read only

Examples:

examples_parameters.c.

Definition at line 454 of file CAENMCATypes.h.

DATAMASK_PARAMINFO_NALLOWED_VALUES

#define DATAMASK_PARAMINFO_NALLOWED_VALUES   UINT64_C(0x400)

In case of list parameter: number of allowed values.

Note

Required argument: uint32_t

Access type: read only

Examples:

examples_parameters.c.

Definition at line 455 of file CAENMCATypes.h.

DATAMASK_PARAMINFO_ALLOWED_VALUES

#define DATAMASK_PARAMINFO_ALLOWED_VALUES   UINT64_C(0x800)

In case of list parameter: allowed values.

Note

Required argument: double*

Maximum size: PARAMINFO_LIST_MAXLEN

Access type: read only

Examples:

examples_parameters.c.

Definition at line 456 of file CAENMCATypes.h.

DATAMASK_PARAMINFO_ALLOWED_VALUE_CODENAMES

#define DATAMASK_PARAMINFO_ALLOWED_VALUE_CODENAMES   UINT64_C(0x1000)

In case of list parameter: allowed codenames.

Note

Required argument: char** pointing to already allocated storages of size PARAMINFO_NAME_MAXLEN

Maximum size: PARAMINFO_LIST_MAXLEN

Access type: read only

Examples:

examples_parameters.c.

Definition at line 457 of file CAENMCATypes.h.

DATAMASK_PARAMINFO_ALLOWED_VALUE_NAMES

#define DATAMASK_PARAMINFO_ALLOWED_VALUE_NAMES   UINT64_C(0x2000)

In case of list parameter: names of allowed values.

Note

Required argument: char** pointing to already allocated storages of size PARAMINFO_NAME_MAXLEN

Maximum size: PARAMINFO_LIST_MAXLEN

Access type: read only

Examples:

examples_parameters.c.

Definition at line 458 of file CAENMCATypes.h.