CAEN MCA  0.99.10
SDK for Hexagon
CAENMCATypes.h File Reference

Definitions and types. More...

#include <stdint.h>
#include <stdarg.h>
+ Include dependency graph for CAENMCATypes.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define CAEN_MCA_API
 Calling convention (Windows only) More...
 
#define CAEN_MCA_DLLAPI   __attribute__((visibility("default")))
 Storage-class attributes (Windows only) More...
 
#define _MCALIB_SYMBOL_DLLAPI_   extern CAEN_MCA_DLLAPI
 
#define _CAEN_MCA_STR_HELPER(S)   #S
 
#define CAEN_MCA_STR(S)   _CAEN_MCA_STR_HELPER(S)
 
#define CONFIGSAVE_NAME_DEFAULTVALUES   "__default"
 
#define DATAMASK_CMD_NONE   UINT64_C(0x0)
 Empty datamask. More...
 
#define DATAMASK_CMD_REG_ADDR   UINT64_C(0x1)
 Register Address. More...
 
#define DATAMASK_CMD_REG_DATA   UINT64_C(0x2)
 Register Data. More...
 
#define DATAMASK_CMD_REG_MASK   UINT64_C(0x4)
 Register Write Mask. More...
 
#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...
 
#define DATAMASK_CMD_AUTOSET_DCO   UINT64_C(0x1)
 Activate DC offset autoset. Boolean (false if not set). More...
 
#define DATAMASK_CMD_AUTOSET_THR   UINT64_C(0x2)
 Activate Threshold autoset. Boolean (false if not set). More...
 
#define DATAMASK_CMD_AUTOSET_TAU   UINT64_C(0x4)
 Activate Tau autoset. Boolean (false if not set). More...
 
#define DATAMASK_CMD_HVOUTPUT_STATUS   UINT64_C(0x1)
 Represents HV Channel output status. Boolean (false if channel is OFF). More...
 
#define DATAMASK_CMD_CURRENT_DATETIME   UINT64_C(0x1)
 Datetime string. More...
 
#define DATAMASK_BRDINFO_MODELNAME   UINT64_C(0x1)
 Model name. More...
 
#define DATAMASK_BRDINFO_MODEL   UINT64_C(0x2)
 Model type. More...
 
#define DATAMASK_BRDINFO_NCHANNELS   UINT64_C(0x4)
 Number of input channels. More...
 
#define DATAMASK_BRDINFO_ROC_FW_MAJ   UINT64_C(0x8)
 ROC firmware version (Major) More...
 
#define DATAMASK_BRDINFO_ROC_FW_MIN   UINT64_C(0x10)
 ROC firmware version (Minor) More...
 
#define DATAMASK_BRDINFO_ROC_FW_BUILD   UINT64_C(0x20)
 ROC firmware version (Build) More...
 
#define DATAMASK_BRDINFO_AMC_FW_MAJ   UINT64_C(0x40)
 AMC firmware version (Major) More...
 
#define DATAMASK_BRDINFO_AMC_FW_MIN   UINT64_C(0x80)
 AMC firmware version (Minor) More...
 
#define DATAMASK_BRDINFO_AMC_FW_BUILD   UINT64_C(0x100)
 AMC firmware version (Build) More...
 
#define DATAMASK_BRDINFO_LICENSE   UINT64_C(0x200)
 License data. More...
 
#define DATAMASK_BRDINFO_SERIALNUM   UINT64_C(0x400)
 Serial number. More...
 
#define DATAMASK_BRDINFO_FAMCODE   UINT64_C(0x800)
 Family code. More...
 
#define DATAMASK_BRDINFO_NHVCHANNELS   UINT64_C(0x1000)
 Number of High-Voltage channels. More...
 
#define DATAMASK_BRDINFO_FORMFACTOR   UINT64_C(0x2000)
 Form factor. More...
 
#define DATAMASK_BRDINFO_PCBREV   UINT64_C(0x4000)
 PCB revision. More...
 
#define DATAMASK_BRDINFO_ADC_BIT_COUNT   UINT64_C(0x8000)
 ADC number of bits. More...
 
#define DATAMASK_BRDINFO_TSAMPLE_PS   UINT64_C(0x10000)
 Sample period in picoseconds. More...
 
#define DATAMASK_BRDINFO_NLVDSGROUPS   UINT64_C(0x20000)
 Number of LVDS groups. More...
 
#define DATAMASK_BRDINFO_NTRACES   UINT64_C(0x40000)
 Number of supported traces. More...
 
#define DATAMASK_BRDINFO_NMONOUTS   UINT64_C(0x80000)
 Number of monitor outputs. More...
 
#define DATAMASK_BRDINFO_ENERGY_BIT_COUNT   UINT64_C(0x100000)
 Energy Spectrum maximum number of bits. More...
 
#define DATAMASK_BRDINFO_LIB_VERSION   UINT64_C(0x200000)
 CAENMCA library version supported by board firmware. More...
 
#define DATAMASK_BRDINFO_NDTSPECTRA   UINT64_C(0x400000)
 Number of DT Spectra. More...
 
#define DATAMASK_CHANNELINFO_NENERGYSPECTRA   UINT64_C(0x1)
 Number of supported Energy Spectra. More...
 
#define DATAMASK_CHANNELINFO_NMCSSPECTRA   UINT64_C(0x2)
 Number of supported MCS Spectra. More...
 
#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...
 
#define PARAMINFO_INFOMASK_IS_ACQ_ON_ALLOWED   UINT32_C(0x1)
 Can be set when acquisition is on. More...
 
#define PARAMINFO_INFOMASK_IS_HVCONFIG_ALLOWED   UINT32_C(0x2)
 Can be set after HV has been configured. More...
 
#define PARAMINFO_INFOMASK_IS_HVON_ALLOWED   UINT32_C(0x4)
 Can be set when HV is ON. More...
 
#define PARAMINFO_INFOMASK_READABLE   UINT32_C(0x8)
 Can be read. More...
 
#define PARAMINFO_INFOMASK_WRITEABLE   UINT32_C(0x10)
 Can be written. More...
 
#define DATAMASK_HVCHANNELINFO_NRANGES   UINT64_C(0x1)
 Number of HV Ranges provided by the HV Channel. More...
 
#define DATAMASK_HVCHANNELINFO_POLARITY   UINT64_C(0x2)
 Polarity of the HV Channel. More...
 
#define DATAMASK_HVRANGEINFO_VSET_MIN   UINT64_C(0x1)
 Vset min. value in volts. More...
 
#define DATAMASK_HVRANGEINFO_VSET_MAX   UINT64_C(0x2)
 Vset max. in volts. More...
 
#define DATAMASK_HVRANGEINFO_VSET_INCR   UINT64_C(0x4)
 Vset min. step in volts. More...
 
#define DATAMASK_HVRANGEINFO_ISET_MIN   UINT64_C(0x8)
 Iset min. value in microampere. More...
 
#define DATAMASK_HVRANGEINFO_ISET_MAX   UINT64_C(0x10)
 Iset max. value in microampere. More...
 
#define DATAMASK_HVRANGEINFO_ISET_INCR   UINT64_C(0x20)
 Iset min. step in microampere. More...
 
#define DATAMASK_HVRANGEINFO_VMON_MIN   UINT64_C(0x40)
 Vmon min. value in volts. More...
 
#define DATAMASK_HVRANGEINFO_VMON_MAX   UINT64_C(0x80)
 Vmon max. in volts. More...
 
#define DATAMASK_HVRANGEINFO_VMON_INCR   UINT64_C(0x100)
 Vmon min. step in volts. More...
 
#define DATAMASK_HVRANGEINFO_IMON_MIN   UINT64_C(0x200)
 Imon min. value in microampere. More...
 
#define DATAMASK_HVRANGEINFO_IMON_MAX   UINT64_C(0x400)
 Imon max. value in microampere. More...
 
#define DATAMASK_HVRANGEINFO_IMON_INCR   UINT64_C(0x800)
 Imon min. step in microampere. More...
 
#define DATAMASK_HVRANGEINFO_VMAX_MIN   UINT64_C(0x1000)
 Vmax min. value in volts. More...
 
#define DATAMASK_HVRANGEINFO_VMAX_MAX   UINT64_C(0x2000)
 Vmax max. in volts. More...
 
#define DATAMASK_HVRANGEINFO_VMAX_INCR   UINT64_C(0x4000)
 Vmax min. step in volts. More...
 
#define DATAMASK_HVRANGEINFO_RAMPUP_MIN   UINT64_C(0x8000)
 RampUp min. value in volts. More...
 
#define DATAMASK_HVRANGEINFO_RAMPUP_MAX   UINT64_C(0x10000)
 RampUp max. in volts. More...
 
#define DATAMASK_HVRANGEINFO_RAMPUP_INCR   UINT64_C(0x20000)
 RampUp min. step in volts. More...
 
#define DATAMASK_HVRANGEINFO_RAMPDOWN_MIN   UINT64_C(0x40000)
 RampDown min. value in volts. More...
 
#define DATAMASK_HVRANGEINFO_RAMPDOWN_MAX   UINT64_C(0x80000)
 RampDown max. in volts. More...
 
#define DATAMASK_HVRANGEINFO_RAMPDOWN_INCR   UINT64_C(0x100000)
 RampDown min. step in volts. More...
 
#define DATAMASK_HVRANGEINFO_CODE   UINT64_C(0x200000)
 HV Range code. More...
 
#define DATAMASK_HVRANGEINFO_CODENAME   UINT64_C(0x400000)
 HV Range codename. More...
 
#define DATAMASK_HVRANGEINFO_NAME   UINT64_C(0x800000)
 HV Range name. More...
 
#define DATAMASK_COLLECTION_LENGTH   UINT64_C(0x1)
 Number of handles in the collection. More...
 
#define DATAMASK_COLLECTION_HANDLES   UINT64_C(0x2)
 Array of handles. More...
 
#define DATAMASK_VALUE_NUMERIC   UINT64_C(0x1)
 Numeric value. More...
 
#define DATAMASK_VALUE_CODENAME   UINT64_C(0x2)
 Value codename in case of list parameter. Literal value in case or range parameter. More...
 
#define DATAMASK_VALUE_NAME   UINT64_C(0x4)
 Value name in case of list parameter. Literal value in case or range parameter. More...
 
#define DATAMASK_ENERGY_SPECTRUM_ARRAY   UINT64_C(0x1)
 The spectrum. More...
 
#define DATAMASK_ENERGY_SPECTRUM_RTIME   UINT64_C(0x2)
 Real time. More...
 
#define DATAMASK_ENERGY_SPECTRUM_LTIME   UINT64_C(0x4)
 Live time. More...
 
#define DATAMASK_ENERGY_SPECTRUM_DTIME   UINT64_C(0x8)
 Dead time. More...
 
#define DATAMASK_ENERGY_SPECTRUM_OVERFLOW   UINT64_C(0x10)
 Number of overflows. More...
 
#define DATAMASK_ENERGY_SPECTRUM_UNDERFLOW   UINT64_C(0x20)
 Number of underflows. More...
 
#define DATAMASK_ENERGY_SPECTRUM_NENTRIES   UINT64_C(0x40)
 Total number of entries in the spectrum. More...
 
#define DATAMASK_ENERGY_SPECTRUM_NROIS   UINT64_C(0x80)
 Number of supported ROIs. More...
 
#define DATAMASK_ENERGY_SPECTRUM_FILENAME   UINT64_C(0x100)
 Remote file where the spectrum is saved periodically and at acquisition stop. More...
 
#define DATAMASK_ENERGY_SPECTRUM_AUTOSAVE_PERIOD   UINT64_C(0x200)
 Period of the auto save of the spectra to file in milliseconds. Set to 0 to disable the autosave. More...
 
#define DATAMASK_ENERGY_SPECTRUM_STABILIZER_ENABLE   UINT64_C(0x400)
 Status of the gain stabilizer. Set to 0 to disable the gain stabilizer. More...
 
#define DATAMASK_ENERGY_SPECTRUM_SAMPLE_ID   UINT64_C(0x800)
 Identification of the sample from which the spectrum is obtained. More...
 
#define DATAMASK_ENERGY_SPECTRUM_START_DATETIME   UINT64_C(0x1000)
 Datetime of last data acquisition start. More...
 
#define DATAMASK_ENERGY_SPECTRUM_STOP_DATETIME   UINT64_C(0x2000)
 Datetime of last data acquisition stop. More...
 
#define DATAMASK_ROI_NENTRIES   UINT64_C(0x1)
 Total number of entries in the ROI. More...
 
#define DATAMASK_DT_SPECTRUM_ARRAY   UINT64_C(0x1)
 The spectrum. More...
 
#define DATAMASK_DT_SPECTRUM_NENTRIES   UINT64_C(0x2)
 Total number of entries in the spectrum. More...
 
#define DATAMASK_DT_SPECTRUM_ENABLE   UINT64_C(0x4)
 ΔT Spectrum enabled. Boolean. More...
 
#define DATAMASK_DT_SPECTRUM_REFCH   UINT64_C(0x8)
 Reference channel for DT calculation. More...
 
#define DATAMASK_WAVEFORM_TRACE1   UINT64_C(0x1)
 Analog trace #1. More...
 
#define DATAMASK_WAVEFORM_TRACE2   UINT64_C(0x2)
 Analog trace #2. More...
 
#define DATAMASK_WAVEFORM_DTRACE1   UINT64_C(0x4)
 Digital trace #1. More...
 
#define DATAMASK_WAVEFORM_DTRACE2   UINT64_C(0x8)
 Digital trace #2. More...
 
#define DATAMASK_DISCOVERY_TIMEOUT_MS   UINT64_C(0x1)
 Time-out of the function in milliseconds. More...
 
#define DATAMASK_DISCOVERY_FOUNDCOUNT   UINT64_C(0x2)
 Number of devices found. More...
 
#define DATAMASK_DISCOVERY_NAME   UINT64_C(0x4)
 Array of found devices. More...
 
#define DATAMASK_DISCOVERY_SERIALNUMBER   UINT64_C(0x8)
 Array of found serial numbers. More...
 
#define DATAMASK_DISCOVERY_IP   UINT64_C(0x10)
 Array of found IP addresses. More...
 
#define DATAMASK_DISCOVERY_INPUT_CHANNELS   UINT64_C(0x20)
 Array of found Number of Input Channels. More...
 
#define DATAMASK_DISCOVERY_MODEL_NAME   UINT64_C(0x40)
 Array of found model names. More...
 
#define DATAMASK_DISCOVERY_PATH   UINT64_C(0x80)
 Array of found path to use as argument of CAEN_MCA_OpenDevice() More...
 
#define DATAMASK_LIST_ENABLE   UINT64_C(0x1)
 List enabled. Boolean. More...
 
#define DATAMASK_LIST_SAVEMODE   UINT64_C(0x2)
 Current List mode. More...
 
#define DATAMASK_LIST_FILENAME   UINT64_C(0x4)
 In case of ASCII-Binary mode: remote file name used. More...
 
#define DATAMASK_LIST_FILE_DATAMASK   UINT64_C(0x8)
 Data to save. More...
 
#define DATAMASK_LIST_GETFAKEEVTS   UINT64_C(0x10)
 Get also fake events. Boolean. More...
 
#define DATAMASK_LIST_MAXNEVTS   UINT64_C(0x20)
 In case of memory mode: max number of events to get in case of memory mode. Must be < LISTS_DATA_MAXLEN. More...
 
#define DATAMASK_LIST_NEVTS   UINT64_C(0x40)
 Number of events in the data. More...
 
#define DATAMASK_LIST_DATA_TIMETAG   UINT64_C(0x80)
 Timetags of the events in picoseconds since acquisition start. More...
 
#define DATAMASK_LIST_DATA_ENERGY   UINT64_C(0x100)
 Energies of the events in bins. More...
 
#define DATAMASK_LIST_DATA_FLAGS_DATAMASK   UINT64_C(0x200)
 Flags of the events. More...
 
#define DATAMASK_LIST_GETSATEVTS   UINT64_C(0x400)
 Get also saturated events. Boolean. More...
 
#define DATAMASK_LIST_GETSKIMEVTS   UINT64_C(0x800)
 Get also energy skim events (whose energy is outside the spectrum [LLD,ULD] interval). Boolean. More...
 
#define LIST_FILE_DATAMASK_TIMETAG   UINT32_C(0x1)
 enable Timetag More...
 
#define LIST_FILE_DATAMASK_ENERGY   UINT32_C(0x2)
 enable Energy More...
 
#define LIST_FILE_DATAMASK_FLAGS   UINT32_C(0x4)
 enable Flags More...
 
#define LIST_DATA_FLAGS_DATAMASK_DEADTIME   UINT32_C(0x1)
 Identifies the first event after a dead time. More...
 
#define LIST_DATA_FLAGS_DATAMASK_TTROLLOVER   UINT32_C(0x2)
 Identifies a trigger time stamp roll-over that occurred before this event. More...
 
#define LIST_DATA_FLAGS_DATAMASK_TTRESET   UINT32_C(0x4)
 Identifies a trigger time stamp reset forced from external signals in S-IN (GPI for Desktop). More...
 
#define LIST_DATA_FLAGS_DATAMASK_EVTFAKE   UINT32_C(0x8)
 Identifies a fake event (which does not correspond to any physical event). More...
 
#define LIST_DATA_FLAGS_DATAMASK_MEMFULL   UINT32_C(0x10)
 Reading memory full. More...
 
#define LIST_DATA_FLAGS_DATAMASK_TRGLOST   UINT32_C(0x20)
 Identifies the first event after a trigger lost. More...
 
#define LIST_DATA_FLAGS_DATAMASK_NTRGLOST   UINT32_C(0x40)
 Every N lost events this flag is high (see board documentation to set N). More...
 
#define LIST_DATA_FLAGS_DATAMASK_OVERRNG   UINT32_C(0x80)
 Energy overranged. More...
 
#define LIST_DATA_FLAGS_DATAMASK_1024TRG   UINT32_C(0x100)
 1024 triggers counted (every 1024 counted events this flag is high). More...
 
#define LIST_DATA_FLAGS_DATAMASK_LOSTEVT   UINT32_C(0x200)
 Identifies the first event after when one or more events is lost due to a memory board FULL. The memory can be FULL due to a write event. More...
 
#define LIST_DATA_FLAGS_DATAMASK_INPUTSAT   UINT32_C(0x400)
 Identifies an event saturating the input dynamics (clipping). More...
 
#define LIST_DATA_FLAGS_DATAMASK_NTRGTOT   UINT32_C(0x800)
 Every N total events this flag is high (see board documentation to set N). More...
 
#define LIST_DATA_FLAGS_DATAMASK_OLDSORT   UINT32_C(0x1000)
 Identifies an event not sorted but sent for waveform. More...
 
#define LIST_DATA_FLAGS_DATAMASK_EOR   UINT32_C(0x2000)
 Identifies a fake event occurring at the end of run. More...
 
#define LIST_DATA_FLAGS_DATAMASK_FINETT   UINT32_C(0x4000)
 Identifies an event with fine time stamp. More...
 
#define LIST_DATA_FLAGS_DATAMASK_PILEUP   UINT32_C(0x8000)
 Identifies a pile up event. More...
 
#define LIST_DATA_FLAGS_DATAMASK_TIME   UINT32_C(0x10000)
 Identifies a fake event occurring on a time stamp roll-over. More...
 
#define LIST_DATA_FLAGS_DATAMASK_ENERGY_SKIM   UINT32_C(0x20000)
 Energy skimming. More...
 
#define LIST_DATA_FLAGS_DATAMASK_SATREJ   UINT32_C(0x40000)
 Identifies an event occurred when detector was inibited due to saturation. More...
 
#define DATAMASK_HANDLE_TYPE   UINT64_C(0x1)
 Handle type. More...
 
#define DATAMASK_HANDLE_INDEX   UINT64_C(0x2)
 Handle index. More...
 
#define DATAMASK_HANDLE_NAME   UINT64_C(0x4)
 Handle name. More...
 
#define DATAMASK_MCS_SPECTRUM_ARRAY   UINT64_C(0x1)
 The MCS spectrum. More...
 
#define DATAMASK_MCS_SPECTRUM_STATUS   UINT64_C(0x2)
 The MCS spectrum status. More...
 
#define DATAMASK_MCS_SPECTRUM_CURRENT_PASS   UINT64_C(0x4)
 The MCS current pass number. More...
 
#define HEXAGONDISCOVERY_NAME_MAXLEN   (DISCOVERY_NAME_MAXLEN)
 
#define HEXAGONDISCOVERY_LIST_MAXLEN   (DISCOVERY_LIST_MAXLEN)
 
#define HEXAGONDISCOVERY_IP_MAXLEN   (DISCOVERY_IP_MAXLEN)
 

Typedefs

typedef void * CAEN_MCA_HANDLE
 Reference to an object. More...
 

Enumerations

enum  CAEN_MCA_HandleType_t {
  CAEN_MCA_HANDLE_PARENT = -1, CAEN_MCA_HANDLE_LIBRARY = 0, CAEN_MCA_HANDLE_DEVICE = 1, CAEN_MCA_HANDLE_CHANNEL = 2,
  CAEN_MCA_HANDLE_HVCHANNEL = 3, CAEN_MCA_HANDLE_HVRANGE = 4, CAEN_MCA_HANDLE_LVDSGROUP = 5, CAEN_MCA_HANDLE_TRACE = 6,
  CAEN_MCA_HANDLE_PARAMETER = 7, CAEN_MCA_HANDLE_COLLECTION = 8, CAEN_MCA_HANDLE_ENERGYSPECTRUM = 9, CAEN_MCA_HANDLE_MCSSPECTRUM = 10,
  CAEN_MCA_HANDLE_ROI = 11, CAEN_MCA_HANDLE_EVENT = 12, CAEN_MCA_HANDLE_TRIGGER = 13, CAEN_MCA_HANDLE_VALUE = 14,
  CAEN_MCA_HANDLE_MONOUT = 15, CAEN_MCA_HANDLE_DTSPECTRUM = 16, CAEN_MCA_HANDLE_REMOVABLE_COLLECTION = 17
}
 Handle type definitions. More...
 
enum  CAEN_MCA_CommandType_t {
  CAEN_MCA_CMD_ACQ_START = 1, CAEN_MCA_CMD_ACQ_STOP = 2, CAEN_MCA_CMD_ENERGYSPECTRUM_CLEAR = 3, CAEN_MCA_CMD_REGISTER_READ = 4,
  CAEN_MCA_CMD_REGISTER_WRITE = 5, CAEN_MCA_CMD_RESTART = 6, CAEN_MCA_CMD_CONFIGURATION_SAVE = 7, CAEN_MCA_CMD_CONFIGURATION_LOAD = 8,
  CAEN_MCA_CMD_CONFIGURATION_LIST = 9, CAEN_MCA_CMD_CONFIGURATION_DELETE = 10, CAEN_MCA_CMD_PARAM_AUTOSET_START = 11, CAEN_MCA_CMD_PARAM_AUTOSET_STOP = 12,
  CAEN_MCA_CMD_HV_ON = 13, CAEN_MCA_CMD_HV_OFF = 14, CAEN_MCA_CMD_HV_ONOFF = 15, CAEN_MCA_CMD_MCS_SWEEP = 16,
  CAEN_MCA_CMD_MCS_SPECTRUM_CLEAR = 17, CAEN_MCA_CMD_GAIN_STABILIZER_RESET = 18, CAEN_MCA_CMD_DTSPECTRUM_CLEAR = 19, CAEN_MCA_CMD_SAMPLE_ADVANCE = 20,
  CAEN_MCA_CMD_CONFIGURATION_DB_PATH = 21, CAEN_MCA_CMD_RTCLOCK =22
}
 Command type definitions. More...
 
enum  CAEN_MCA_DataType_t {
  CAEN_MCA_DATA_BOARD_INFO = 1, CAEN_MCA_DATA_CHANNEL_INFO = 2, CAEN_MCA_DATA_HVCHANNEL_INFO = 3, CAEN_MCA_DATA_HVRANGE_INFO = 4,
  CAEN_MCA_DATA_COLLECTION = 5, CAEN_MCA_DATA_PARAMETER_INFO = 6, CAEN_MCA_DATA_PARAMETER_VALUE = 7, CAEN_MCA_DATA_ENERGYSPECTRUM = 8,
  CAEN_MCA_DATA_ROI = 9, CAEN_MCA_DATA_WAVEFORM = 10, CAEN_MCA_DATA_LIST_MODE = 11, CAEN_MCA_DATA_DISCOVEREDDEVICES = 12,
  CAEN_MCA_DATA_HANDLE_INFO = 13, CAEN_MCA_DATA_MCSSPECTRUM = 14, CAEN_MCA_DATA_DTSPECTRUM = 15
}
 Data type definitions. More...
 
enum  CAEN_MCA_FormFactor_t {
  CAEN_MCA_FORM_FACTOR_VME64 = 0, CAEN_MCA_FORM_FACTOR_VME64X = 1, CAEN_MCA_FORM_FACTOR_DESKTOP = 2, CAEN_MCA_FORM_FACTOR_NIM = 3,
  CAEN_MCA_FORM_FACTOR_UNKNOWN = -1
}
 Form Factor types. More...
 
enum  CAEN_MCA_BoardFamilyCode_t {
  CAEN_MCA_FAMILY_CODE_XX724 = 0, CAEN_MCA_FAMILY_CODE_XX721 = 1, CAEN_MCA_FAMILY_CODE_XX731 = 2, CAEN_MCA_FAMILY_CODE_XX720 = 3,
  CAEN_MCA_FAMILY_CODE_XX740 = 4, CAEN_MCA_FAMILY_CODE_XX751 = 5, CAEN_MCA_FAMILY_CODE_XX742 = 6, CAEN_MCA_FAMILY_CODE_XX780 = 7,
  CAEN_MCA_FAMILY_CODE_XX761 = 8, CAEN_MCA_FAMILY_CODE_XX743 = 9, CAEN_MCA_FAMILY_CODE_XX730 = 10, CAEN_MCA_FAMILY_CODE_XX790 = 11,
  CAEN_MCA_FAMILY_CODE_XX781 = 12, CAEN_MCA_FAMILY_CODE_XX725 = 13, CAEN_MCA_FAMILY_CODE_XXHEX = 14, CAEN_MCA_FAMILY_CODE_XX782 = 15,
  CAEN_MCA_FAMILY_CODE_UNKNOWN = -1
}
 Board Family types. More...
 
enum  CAEN_MCA_BoardModel_t {
  CAEN_MCA_MODEL_V1724 = 0, CAEN_MCA_MODEL_V1721 = 1, CAEN_MCA_MODEL_V1731 = 2, CAEN_MCA_MODEL_V1720 = 3,
  CAEN_MCA_MODEL_V1740 = 4, CAEN_MCA_MODEL_V1751 = 5, CAEN_MCA_MODEL_DT5724 = 6, CAEN_MCA_MODEL_DT5721 = 7,
  CAEN_MCA_MODEL_DT5731 = 8, CAEN_MCA_MODEL_DT5720 = 9, CAEN_MCA_MODEL_DT5740 = 10, CAEN_MCA_MODEL_DT5751 = 11,
  CAEN_MCA_MODEL_N6724 = 12, CAEN_MCA_MODEL_N6721 = 13, CAEN_MCA_MODEL_N6731 = 14, CAEN_MCA_MODEL_N6720 = 15,
  CAEN_MCA_MODEL_N6740 = 16, CAEN_MCA_MODEL_N6751 = 17, CAEN_MCA_MODEL_DT5742 = 18, CAEN_MCA_MODEL_N6742 = 19,
  CAEN_MCA_MODEL_V1742 = 20, CAEN_MCA_MODEL_DT5780 = 21, CAEN_MCA_MODEL_N6780 = 22, CAEN_MCA_MODEL_V1780 = 23,
  CAEN_MCA_MODEL_DT5761 = 24, CAEN_MCA_MODEL_N6761 = 25, CAEN_MCA_MODEL_V1761 = 26, CAEN_MCA_MODEL_DT5743 = 27,
  CAEN_MCA_MODEL_N6743 = 28, CAEN_MCA_MODEL_V1743 = 29, CAEN_MCA_MODEL_DT5730 = 30, CAEN_MCA_MODEL_N6730 = 31,
  CAEN_MCA_MODEL_V1730 = 32, CAEN_MCA_MODEL_DT5790 = 33, CAEN_MCA_MODEL_N6790 = 34, CAEN_MCA_MODEL_V1790 = 35,
  CAEN_MCA_MODEL_DT5781 = 36, CAEN_MCA_MODEL_N6781 = 37, CAEN_MCA_MODEL_V1781 = 38, CAEN_MCA_MODEL_DT5725 = 39,
  CAEN_MCA_MODEL_N6725 = 40, CAEN_MCA_MODEL_V1725 = 41, CAEN_MCA_MODEL_HEXAGON = 42, CAEN_MCA_MODEL_V1782 = 43,
  CAEN_MCA_MODEL_UNKNOWN = -1
}
 Board Model types. More...
 
enum  CAEN_MCA_ParameterType_t { CAEN_MCA_PARAMETER_TYPE_RANGE = 0, CAEN_MCA_PARAMETER_TYPE_LIST = 1, CAEN_MCA_PARAMETER_TYPE_UNKNOWN = -1 }
 Parameter Range format. More...
 
enum  CAEN_MCA_Polarity_t { CAEN_MCA_POLARITY_TYPE_POSITIVE = 0, CAEN_MCA_POLARITY_TYPE_NEGATIVE = 1 }
 HV Polarity type. More...
 
enum  CAEN_MCA_ListSaveMode_t { CAEN_MCA_SAVEMODE_FILE_ASCII = 0, CAEN_MCA_SAVEMODE_FILE_BINARY = 1, CAEN_MCA_SAVEMODE_MEMORY = 2 }
 List save mode. More...
 
enum  CAEN_MCA_HVRangeCode_t { CAEN_MCA_HVRANGE_HPGE = 0, CAEN_MCA_HVRANGE_PMT = 1, CAEN_MCA_HVRANGE_SD = 2 }
 HV Ranges. More...
 
enum  CAEN_MCA_MCSMode_t { CAEN_MCA_MCS_ON_ICR = 0, CAEN_MCA_MCS_ON_EXT_SIGNAL = 1, CAEN_MCA_MCS_ON_SCA = 2 }
 MCS counting mode. More...
 
enum  CAEN_MCA_MCS_Spectrum_Status_t { CAEN_MCA_MCS_SPE_NOT_STARTED = 0, CAEN_MCA_MCS_SPE_ACQUIRING = 1, CAEN_MCA_MCS_SPE_COMPLETED = 2, CAEN_MCA_MCS_SPE_STOPPED = 3 }
 MCS spectrum status. More...
 
enum  CAEN_MCA_MCS_AcqMode_t { CAEN_MCA_MCS_REPLACE = 0, CAEN_MCA_MCS_SUM = 1, CAEN_MCA_MCS_REPLACE_AND_SUM = 2 }
 MCS acquisition mode. More...
 
enum  CAEN_MCA_GSTAB_Mode_t { CAEN_MCA_GSTAB_MODE_DISABLED = 0, CAEN_MCA_GSTAB_MODE_PEAK = 1, CAEN_MCA_GSTAB_MODE_SENSOR = 2 }
 MCS acquisition mode. More...
 
enum  CAEN_MCA_RetCode_t {
  CAEN_MCA_RetCode_Success = 0, CAEN_MCA_RetCode_Generic = -1, CAEN_MCA_RetCode_SockInit = -2, CAEN_MCA_RetCode_SockConnect = -3,
  CAEN_MCA_RetCode_OutOfMemory = -4, CAEN_MCA_RetCode_Handle = -5, CAEN_MCA_RetCode_Argument = -6, CAEN_MCA_RetCode_SocketSend = -7,
  CAEN_MCA_RetCode_SocketReceive = -8, CAEN_MCA_RetCode_Protocol = -9, CAEN_MCA_RetCode_Serialize = -10, CAEN_MCA_RetCode_Deserialize = -11,
  CAEN_MCA_RetCode_Parameter = -12, CAEN_MCA_RetCode_ParameterValue = -13, CAEN_MCA_RetCode_LibraryLoad = -14, CAEN_MCA_RetCode_DiscoveryFunction = -15,
  CAEN_MCA_RetCode_NotConnected = -16, CAEN_MCA_RetCode_NotSupported = -17, CAEN_MCA_RetCode_NotYetImplemented = -18, CAEN_MCA_RetCode_CollectionFull = -19,
  CAEN_MCA_RetCode_Map = -20, CAEN_MCA_RetCode_IndexAlreadyUsed = -21
}
 Library return codes. More...
 

Variables

int32_t CAEN_MCA_DEFAULT_TCP_PORT
 Default port. More...
 
int32_t PARAMINFO_LIST_MAXLEN
 
int32_t HANDLE_NAME_MAXLEN
 
int32_t PARAMINFO_NAME_MAXLEN
 
int32_t HVRANGEINFO_NAME_MAXLEN
 
int32_t MODEL_NAME_MAXLEN
 
int32_t LICENSE_MAXLEN
 
int32_t VERSION_MAXLEN
 
int32_t LIB_VERSION_MAXLEN
 
int32_t ENERGYSPECTRUM_MAXLEN
 
int32_t WAVEFORM_MAXLEN
 
int32_t DEFINITIONARRAY_MAXLEN
 
int32_t CONFIGSAVE_NAME_MAXLEN
 
int32_t CONFIGSAVE_LIST_MAXLEN
 
int32_t DISCOVERY_NAME_MAXLEN
 
int32_t DISCOVERY_LIST_MAXLEN
 
int32_t DISCOVERY_IP_MAXLEN
 
int32_t LISTS_DATA_MAXLEN
 
int32_t COLLECTION_MAXLEN
 
int32_t MCSSPECTRUM_MAXLEN
 
int32_t DTSPECTRUM_MAXLEN
 
int32_t STANDARD_FILE_MAXLEN
 
int32_t BASEDIR_MAXLEN
 
int32_t RUNSAVE_RELATIVEPATH_MAXLEN
 
int32_t RUNSAVE_FULLPATH_MAXLEN
 
int32_t ENERGYSPECTRUM_RELATIVEPATH_MAXLEN
 
int32_t ENERGYSPECTRUM_FULLPATH_MAXLEN
 
int32_t CONFIGSAVE_RELATIVEPATH_MAXLEN
 
int32_t CONFIGSAVE_FULLPATH_MAXLEN
 
int32_t LISTS_RELATIVEPATH_MAXLEN
 
int32_t LISTS_FULLPATH_MAXLEN
 
int32_t SAMPLEID_MAXLEN
 
int32_t DATETIME_MAXLEN
 

Detailed Description

Definitions and types.

Author
Giovanni Cerretani, Lara Palla, Francesco Pepe
Version
0.99.11
Date
2023

Definition in file CAENMCATypes.h.

Macro Definition Documentation

◆ CONFIGSAVE_NAME_DEFAULTVALUES

#define CONFIGSAVE_NAME_DEFAULTVALUES   "__default"

Definition at line 316 of file CAENMCATypes.h.

Typedef Documentation

◆ CAEN_MCA_HANDLE

typedef void* CAEN_MCA_HANDLE

Reference to an object.

Definition at line 71 of file CAENMCATypes.h.

Enumeration Type Documentation

◆ CAEN_MCA_HandleType_t

Handle type definitions.

Enumerator
CAEN_MCA_HANDLE_PARENT 

Current handle's parent. To be used with CAEN_MCA_GetAncestorHandle() to directly get the parent handle.

Remarks
Special handle.
CAEN_MCA_HANDLE_LIBRARY 

Library.

Note
Children: CAEN_MCA_HANDLE_DEVICE
CAEN_MCA_HANDLE_DEVICE 

Device.

Note
Children: CAEN_MCA_HANDLE_PARAMETER, CAEN_MCA_HANDLE_CHANNEL, CAEN_MCA_HANDLE_HVCHANNEL, CAEN_MCA_HANDLE_LVDSGROUP, CAEN_MCA_HANDLE_TRACE, CAEN_MCA_HANDLE_MONOUT, CAEN_MCA_HANDLE_DTSPECTRUM
CAEN_MCA_HANDLE_CHANNEL 

Channel.

Note
Children: CAEN_MCA_HANDLE_PARAMETER, CAEN_MCA_HANDLE_ENERGYSPECTRUM, CAEN_MCA_HANDLE_MCSSPECTRUM
CAEN_MCA_HANDLE_HVCHANNEL 

HV Channel.

Note
Children: CAEN_MCA_HANDLE_PARAMETER, CAEN_MCA_HANDLE_HVRANGE
CAEN_MCA_HANDLE_HVRANGE 

HV Range.

Note
Children: CAEN_MCA_HANDLE_PARAMETER
CAEN_MCA_HANDLE_LVDSGROUP 

LVDS Group.

Note
Children: CAEN_MCA_HANDLE_PARAMETER
CAEN_MCA_HANDLE_TRACE 

Trace.

Note
Children: CAEN_MCA_HANDLE_PARAMETER
CAEN_MCA_HANDLE_PARAMETER 

Parameter.

Note
Children: CAEN_MCA_HANDLE_PARAMETER
CAEN_MCA_HANDLE_COLLECTION 

Handle Collection.

Remarks
Special handle.
CAEN_MCA_HANDLE_ENERGYSPECTRUM 

Energy Spectrum.

Note
Children: CAEN_MCA_HANDLE_PARAMETER, CAEN_MCA_HANDLE_ROI
CAEN_MCA_HANDLE_MCSSPECTRUM 

MCS Spectrum.

Note
Children: CAEN_MCA_HANDLE_PARAMETER
CAEN_MCA_HANDLE_ROI 

ROI.

Note
Children: CAEN_MCA_HANDLE_PARAMETER
CAEN_MCA_HANDLE_EVENT 

Board-related event (e.g: reaction to a command)

Warning
Currently unused.
CAEN_MCA_HANDLE_TRIGGER 

Single-trigger event (list mode event)

Warning
Currently unused.
CAEN_MCA_HANDLE_VALUE 

Parameter Value.

Warning
Currently unused.
CAEN_MCA_HANDLE_MONOUT 

Monitor Out.

Note
Children: CAEN_MCA_HANDLE_PARAMETER
CAEN_MCA_HANDLE_DTSPECTRUM 

ΔT Spectrum

Note
Children: CAEN_MCA_HANDLE_PARAMETER
CAEN_MCA_HANDLE_REMOVABLE_COLLECTION 

Handle Collection where elements can be removed.

Remarks
Special handle.

Definition at line 85 of file CAENMCATypes.h.

◆ CAEN_MCA_CommandType_t

Command type definitions.

Enumerator
CAEN_MCA_CMD_ACQ_START 

Start Acquisition.

Remarks
On CAEN_MCA_HANDLE_DEVICE (board) or CAEN_MCA_HANDLE_CHANNEL (single channel)
See also
Command mask: None
CAEN_MCA_CMD_ACQ_STOP 

Stop Acquisition.

Remarks
On CAEN_MCA_HANDLE_DEVICE (board) or CAEN_MCA_HANDLE_CHANNEL (single channel)
See also
Command mask: None
CAEN_MCA_CMD_ENERGYSPECTRUM_CLEAR 

Clear Energy Spectrum.

Remarks
On CAEN_MCA_HANDLE_ENERGYSPECTRUM
See also
Command mask: None
CAEN_MCA_CMD_REGISTER_READ 

Read Register.

Remarks
On CAEN_MCA_HANDLE_DEVICE
See also
Command mask: Registers
CAEN_MCA_CMD_REGISTER_WRITE 

Write Register.

Remarks
On CAEN_MCA_HANDLE_DEVICE
See also
Command mask: Registers
CAEN_MCA_CMD_RESTART 

Restart the server.

Remarks
On CAEN_MCA_HANDLE_DEVICE
See also
Command mask: None
CAEN_MCA_CMD_CONFIGURATION_SAVE 

Save current configuration to a file.

Remarks
On CAEN_MCA_HANDLE_DEVICE
See also
Command mask: Configuration Save
CAEN_MCA_CMD_CONFIGURATION_LOAD 

Load a saved configuration.

Remarks
On CAEN_MCA_HANDLE_DEVICE
See also
Command mask: Configuration Save
CAEN_MCA_CMD_CONFIGURATION_LIST 

List all saved configuration.

Remarks
On CAEN_MCA_HANDLE_DEVICE
See also
Command mask: Configuration Save
CAEN_MCA_CMD_CONFIGURATION_DELETE 

Delete saved configurations.

Remarks
On CAEN_MCA_HANDLE_DEVICE
See also
Command mask: Configuration Save
CAEN_MCA_CMD_PARAM_AUTOSET_START 

Start Parameter auto-set.

Remarks
On CAEN_MCA_HANDLE_DEVICE
See also
Command mask: Auto set
CAEN_MCA_CMD_PARAM_AUTOSET_STOP 

Stop Parameter auto-set.

Remarks
On CAEN_MCA_HANDLE_DEVICE
See also
Command mask: Auto set
CAEN_MCA_CMD_HV_ON 

Enable HV output.

Remarks
On CAEN_MCA_HANDLE_HVCHANNEL
See also
Command mask: None
CAEN_MCA_CMD_HV_OFF 

Disable HV output.

Remarks
On CAEN_MCA_HANDLE_HVCHANNEL
See also
Command mask: None
CAEN_MCA_CMD_HV_ONOFF 

Enable or Disable HV output.

Remarks
On CAEN_MCA_HANDLE_HVCHANNEL
See also
Command mask: HV output status
CAEN_MCA_CMD_MCS_SWEEP 

Send sweep signal for MCS Spectrum.

Remarks
On CAEN_MCA_HANDLE_MCSSPECTRUM
See also
Command mask: None
CAEN_MCA_CMD_MCS_SPECTRUM_CLEAR 

Clear MCS Spectrum.

Remarks
On CAEN_MCA_HANDLE_MCSSPECTRUM
See also
Command mask: None
CAEN_MCA_CMD_GAIN_STABILIZER_RESET 

Reset the gain stabilizer.

Remarks
On CAEN_MCA_HANDLE_ENERGYSPECTRUM
See also
Command mask: None
CAEN_MCA_CMD_DTSPECTRUM_CLEAR 

Clear ΔT Spectrum.

Remarks
On CAEN_MCA_HANDLE_DTSPECTRUM
See also
Command mask: None
CAEN_MCA_CMD_SAMPLE_ADVANCE 

Send Sample Advance signal.

Remarks
On CAEN_MCA_HANDLE_CHANNEL (single channel)
See also
Command mask: None
CAEN_MCA_CMD_CONFIGURATION_DB_PATH 

Set or get the path of internal configrations database.

Remarks
On CAEN_MCA_HANDLE_DEVICE
See also
Command mask: Configuration Save
CAEN_MCA_CMD_RTCLOCK 

Set or get the internal system datetime.

Remarks
On CAEN_MCA_HANDLE_DEVICE
See also
Command mask: System Datetime

Definition at line 108 of file CAENMCATypes.h.

◆ CAEN_MCA_DataType_t

Data type definitions.

Enumerator
CAEN_MCA_DATA_BOARD_INFO 

Board Information.

Remarks
On CAEN_MCA_HANDLE_DEVICE
See also
Data mask: Board info
CAEN_MCA_DATA_CHANNEL_INFO 

Channel Information.

Remarks
On CAEN_MCA_HANDLE_CHANNEL
See also
Data mask: Channel info
CAEN_MCA_DATA_HVCHANNEL_INFO 

HV Channel Information.

Remarks
On CAEN_MCA_HANDLE_HVCHANNEL
See also
Data mask: HV channel info
CAEN_MCA_DATA_HVRANGE_INFO 

HV Range Information.

Remarks
On CAEN_MCA_HANDLE_HVRANGE
See also
Data mask: HV range info
CAEN_MCA_DATA_COLLECTION 

Handle Collection.

Remarks
On CAEN_MCA_HANDLE_COLLECTION
See also
Data mask: Handle collection
CAEN_MCA_DATA_PARAMETER_INFO 

Parameter Information.

Remarks
On CAEN_MCA_HANDLE_PARAMETER
See also
Data mask: Parameter info
CAEN_MCA_DATA_PARAMETER_VALUE 

Parameter Value.

Remarks
On CAEN_MCA_HANDLE_PARAMETER
See also
Data mask: Parameter value
CAEN_MCA_DATA_ENERGYSPECTRUM 

Energy Spectrum.

Remarks
On CAEN_MCA_HANDLE_ENERGYSPECTRUM
See also
Data mask: Energy spectrum
CAEN_MCA_DATA_ROI 

ROI.

Remarks
On CAEN_MCA_HANDLE_ROI
See also
Data mask: ROI
CAEN_MCA_DATA_WAVEFORM 

Waveforms.

Remarks
On CAEN_MCA_HANDLE_CHANNEL
See also
Data mask: Waveforms
CAEN_MCA_DATA_LIST_MODE 

List Mode.

Remarks
On CAEN_MCA_HANDLE_CHANNEL
See also
Data mask: Lists
CAEN_MCA_DATA_DISCOVEREDDEVICES 

Discover Hexagon devices on the local LAN.

Remarks
On CAEN_MCA_HANDLE_LIBRARY
See also
Data mask: Device discovery
CAEN_MCA_DATA_HANDLE_INFO 

Handle information.

Remarks
On any handle
See also
Data mask: Handles
CAEN_MCA_DATA_MCSSPECTRUM 

MCS Spectrum.

Remarks
On CAEN_MCA_HANDLE_MCSSPECTRUM
See also
Data mask: MCS spectrum
CAEN_MCA_DATA_DTSPECTRUM 

ΔT Spectrum

Remarks
On CAEN_MCA_HANDLE_DTSPECTRUM
See also
Data mask: &Delta;T spectrum

Definition at line 134 of file CAENMCATypes.h.

◆ CAEN_MCA_FormFactor_t

Form Factor types.

Enumerator
CAEN_MCA_FORM_FACTOR_VME64 

VME64 Type.

CAEN_MCA_FORM_FACTOR_VME64X 

VME64x Type.

CAEN_MCA_FORM_FACTOR_DESKTOP 

Desktop Type.

CAEN_MCA_FORM_FACTOR_NIM 

NIM Type.

CAEN_MCA_FORM_FACTOR_UNKNOWN 

Unknown Type.

Definition at line 153 of file CAENMCATypes.h.

◆ CAEN_MCA_BoardFamilyCode_t

Board Family types.

Enumerator
CAEN_MCA_FAMILY_CODE_XX724 

XX724 family.

CAEN_MCA_FAMILY_CODE_XX721 

XX721 family.

CAEN_MCA_FAMILY_CODE_XX731 

XX731 family.

CAEN_MCA_FAMILY_CODE_XX720 

XX720 family.

CAEN_MCA_FAMILY_CODE_XX740 

XX740 family.

CAEN_MCA_FAMILY_CODE_XX751 

XX751 family.

CAEN_MCA_FAMILY_CODE_XX742 

XX742 family.

CAEN_MCA_FAMILY_CODE_XX780 

XX780 family.

CAEN_MCA_FAMILY_CODE_XX761 

XX761 family.

CAEN_MCA_FAMILY_CODE_XX743 

XX743 family.

CAEN_MCA_FAMILY_CODE_XX730 

XX730 family.

CAEN_MCA_FAMILY_CODE_XX790 

XX790 family.

CAEN_MCA_FAMILY_CODE_XX781 

XX781 family.

CAEN_MCA_FAMILY_CODE_XX725 

XX725 family.

CAEN_MCA_FAMILY_CODE_XXHEX 

Hexagon family.

CAEN_MCA_FAMILY_CODE_XX782 

XX782 family.

CAEN_MCA_FAMILY_CODE_UNKNOWN 

Unknown family.

Definition at line 162 of file CAENMCATypes.h.

◆ CAEN_MCA_BoardModel_t

Board Model types.

Enumerator
CAEN_MCA_MODEL_V1724 

V1724.

CAEN_MCA_MODEL_V1721 

V1721.

CAEN_MCA_MODEL_V1731 

V1731.

CAEN_MCA_MODEL_V1720 

V1720.

CAEN_MCA_MODEL_V1740 

V1740.

CAEN_MCA_MODEL_V1751 

V1751.

CAEN_MCA_MODEL_DT5724 

DT5724.

CAEN_MCA_MODEL_DT5721 

DT5721.

CAEN_MCA_MODEL_DT5731 

DT5731.

CAEN_MCA_MODEL_DT5720 

DT5720.

CAEN_MCA_MODEL_DT5740 

DT5740.

CAEN_MCA_MODEL_DT5751 

DT5751.

CAEN_MCA_MODEL_N6724 

N6724.

CAEN_MCA_MODEL_N6721 

N6721.

CAEN_MCA_MODEL_N6731 

N6731.

CAEN_MCA_MODEL_N6720 

N6720.

CAEN_MCA_MODEL_N6740 

N6740.

CAEN_MCA_MODEL_N6751 

N6751.

CAEN_MCA_MODEL_DT5742 

DT5742.

CAEN_MCA_MODEL_N6742 

N6742.

CAEN_MCA_MODEL_V1742 

V1742.

CAEN_MCA_MODEL_DT5780 

DT5780.

CAEN_MCA_MODEL_N6780 

N6780.

CAEN_MCA_MODEL_V1780 

V1780.

CAEN_MCA_MODEL_DT5761 

DT5761.

CAEN_MCA_MODEL_N6761 

N6761.

CAEN_MCA_MODEL_V1761 

V1761.

CAEN_MCA_MODEL_DT5743 

DT5743.

CAEN_MCA_MODEL_N6743 

N6743.

CAEN_MCA_MODEL_V1743 

V1743.

CAEN_MCA_MODEL_DT5730 

DT5730.

CAEN_MCA_MODEL_N6730 

N6730.

CAEN_MCA_MODEL_V1730 

V1730.

CAEN_MCA_MODEL_DT5790 

DT5790.

CAEN_MCA_MODEL_N6790 

N6790.

CAEN_MCA_MODEL_V1790 

V1790.

CAEN_MCA_MODEL_DT5781 

DT5781.

CAEN_MCA_MODEL_N6781 

N6781.

CAEN_MCA_MODEL_V1781 

V1781.

CAEN_MCA_MODEL_DT5725 

DT5725.

CAEN_MCA_MODEL_N6725 

N6725.

CAEN_MCA_MODEL_V1725 

V1725.

CAEN_MCA_MODEL_HEXAGON 

Hexagon.

CAEN_MCA_MODEL_V1782 

V1782.

CAEN_MCA_MODEL_UNKNOWN 

Unknown model.

Definition at line 183 of file CAENMCATypes.h.

◆ CAEN_MCA_ParameterType_t

Parameter Range format.

Enumerator
CAEN_MCA_PARAMETER_TYPE_RANGE 

Parameter accepting value in a certain range.

CAEN_MCA_PARAMETER_TYPE_LIST 

Parameter accepting only a fixed set of values.

CAEN_MCA_PARAMETER_TYPE_UNKNOWN 

Unknown format.

Definition at line 232 of file CAENMCATypes.h.

◆ CAEN_MCA_Polarity_t

HV Polarity type.

Enumerator
CAEN_MCA_POLARITY_TYPE_POSITIVE 

Positive polarity.

CAEN_MCA_POLARITY_TYPE_NEGATIVE 

Negative polarity.

Definition at line 239 of file CAENMCATypes.h.

◆ CAEN_MCA_ListSaveMode_t

List save mode.

Enumerator
CAEN_MCA_SAVEMODE_FILE_ASCII 

Save lists into a remote file in ASCII format.

CAEN_MCA_SAVEMODE_FILE_BINARY 

Save lists into a remote file in binary format.

CAEN_MCA_SAVEMODE_MEMORY 

Save lists only in memory.

Definition at line 245 of file CAENMCATypes.h.

◆ CAEN_MCA_HVRangeCode_t

HV Ranges.

Enumerator
CAEN_MCA_HVRANGE_HPGE 

HV Range suited for HPGe detectors.

CAEN_MCA_HVRANGE_PMT 

HV Range suited for PMT detectors.

CAEN_MCA_HVRANGE_SD 

HV Range suited for Silicon-Diamond detectors.

Definition at line 252 of file CAENMCATypes.h.

◆ CAEN_MCA_MCSMode_t

MCS counting mode.

Enumerator
CAEN_MCA_MCS_ON_ICR 

MCS counting parameter is the channel trigger.

CAEN_MCA_MCS_ON_EXT_SIGNAL 

MCS counting parameter is the number of external signals.

CAEN_MCA_MCS_ON_SCA 

MCS counting parameter is the number of events with energy inside the SCA interval.

Definition at line 259 of file CAENMCATypes.h.

◆ CAEN_MCA_MCS_Spectrum_Status_t

MCS spectrum status.

Enumerator
CAEN_MCA_MCS_SPE_NOT_STARTED 

MCS is not active, the spectrum is not being filled.

CAEN_MCA_MCS_SPE_ACQUIRING 

MCS spectrum is being filled with MCS counts data.

CAEN_MCA_MCS_SPE_COMPLETED 

MCS spectrum is ready (waiting for the sweep signal)

CAEN_MCA_MCS_SPE_STOPPED 

MCS spectrum is freezed.

Examples:
examples_mcs.c.

Definition at line 266 of file CAENMCATypes.h.

◆ CAEN_MCA_MCS_AcqMode_t

MCS acquisition mode.

Enumerator
CAEN_MCA_MCS_REPLACE 

MCS data of the current pass replace those of the previuous one (single scan mode)

CAEN_MCA_MCS_SUM 

MCS data of the current pass is added to the sum of the data from the previous passes (multi scan mode)

CAEN_MCA_MCS_REPLACE_AND_SUM 

MCS data acquisition works in REPLACE mode for the first pass, in SUM mode for the next passes.

Definition at line 274 of file CAENMCATypes.h.

◆ CAEN_MCA_GSTAB_Mode_t

MCS acquisition mode.

Enumerator
CAEN_MCA_GSTAB_MODE_DISABLED 

MCS data of the current pass replace those of the previuous one (single scan mode)

CAEN_MCA_GSTAB_MODE_PEAK 

MCS data of the current pass is added to the sum of the data from the previous passes (multi scan mode)

CAEN_MCA_GSTAB_MODE_SENSOR 

MCS data acquisition works in REPLACE mode for the first pass, in SUM mode for the next passes.

Definition at line 281 of file CAENMCATypes.h.

◆ CAEN_MCA_RetCode_t

Library return codes.

Enumerator
CAEN_MCA_RetCode_Success 

Success.

CAEN_MCA_RetCode_Generic 

Generic error.

CAEN_MCA_RetCode_SockInit 

Socket initialization error.

CAEN_MCA_RetCode_SockConnect 

Socket connect error.

CAEN_MCA_RetCode_OutOfMemory 

Out of memory (malloc failed)

CAEN_MCA_RetCode_Handle 

Invalid handle.

CAEN_MCA_RetCode_Argument 

Invalid argument.

CAEN_MCA_RetCode_SocketSend 

TCP/IP send error.

CAEN_MCA_RetCode_SocketReceive 

TCP/IP receive error.

CAEN_MCA_RetCode_Protocol 

Protocol error.

CAEN_MCA_RetCode_Serialize 

Serialize error.

CAEN_MCA_RetCode_Deserialize 

Deserialize error.

CAEN_MCA_RetCode_Parameter 

Parameter error.

CAEN_MCA_RetCode_ParameterValue 

Parameter Value error.

CAEN_MCA_RetCode_LibraryLoad 

Library dynamic load error (Linux only)

CAEN_MCA_RetCode_DiscoveryFunction 

SSDP discovery failed.

CAEN_MCA_RetCode_NotConnected 

Not connected.

CAEN_MCA_RetCode_NotSupported 

Not supported.

CAEN_MCA_RetCode_NotYetImplemented 

Not yet implemented.

CAEN_MCA_RetCode_CollectionFull 

Handle collection full (collections support up to COLLECTION_MAXLEN elements)

CAEN_MCA_RetCode_Map 

Error in a map.

CAEN_MCA_RetCode_IndexAlreadyUsed 

Collection index is already in use.

Definition at line 291 of file CAENMCATypes.h.

Variable Documentation

◆ CAEN_MCA_DEFAULT_TCP_PORT

int32_t CAEN_MCA_DEFAULT_TCP_PORT

Default port.