HORIBA C++ SDK
Library for HORIBA devices
Loading...
Searching...
No Matches
horiba::devices::single_devices::AcquisitionSetParameters Class Referencefinal

Represents the parameters for the acquisition set. More...

#include <spectracq3.h>

Public Member Functions

 AcquisitionSetParameters (int scan_count, std::chrono::seconds time_step, std::chrono::seconds integration_time, int external_param)
 
int scan_count () const
 Number of acquisition to perform.
 
std::chrono::seconds time_step () const
 Interval between successive scans for time based scan in seconds. If 0 or not defined, the scans take place as fast as possible (limited by integration time and monochromator move if applicable)
 
std::chrono::seconds integration_time () const
 Integration time in seconds.
 
int external_param () const
 User defined value.
 

Detailed Description

Represents the parameters for the acquisition set.

Constructor & Destructor Documentation

◆ AcquisitionSetParameters()

horiba::devices::single_devices::AcquisitionSetParameters::AcquisitionSetParameters ( int scan_count,
std::chrono::seconds time_step,
std::chrono::seconds integration_time,
int external_param )
inlineexplicit

Member Function Documentation

◆ external_param()

int horiba::devices::single_devices::AcquisitionSetParameters::external_param ( ) const
inlinenodiscard

User defined value.

Returns
User defined value

◆ integration_time()

std::chrono::seconds horiba::devices::single_devices::AcquisitionSetParameters::integration_time ( ) const
inlinenodiscard

Integration time in seconds.

Returns
Integration time in seconds

◆ scan_count()

int horiba::devices::single_devices::AcquisitionSetParameters::scan_count ( ) const
inlinenodiscard

Number of acquisition to perform.

Returns
Number of acquisition to perform

◆ time_step()

std::chrono::seconds horiba::devices::single_devices::AcquisitionSetParameters::time_step ( ) const
inlinenodiscard

Interval between successive scans for time based scan in seconds. If 0 or not defined, the scans take place as fast as possible (limited by integration time and monochromator move if applicable)

Returns
Interval between successive scans for time based scan in seconds.

The documentation for this class was generated from the following file: