HORIBA C++ SDK
Library for HORIBA devices
Loading...
Searching...
No Matches
horiba::devices::SpectrAcq3sDiscovery Class Reference

Represents a discovery of SpectrAcq cameras on the ICL. More...

#include <spectracq3s_discovery.h>

Inheritance diagram for horiba::devices::SpectrAcq3sDiscovery:

Public Member Functions

 SpectrAcq3sDiscovery (std::shared_ptr< horiba::communication::Communicator > communicator)
 Builds a SpectrAcq3 discovery.
 
 ~SpectrAcq3sDiscovery () override=default
 
void execute (bool error_on_no_devices) noexcept(false) override
 Executes the SpectrAcq3 discovery.
 
std::vector< std::shared_ptr< single_devices::SpectrAcq3 > > spectracq3s () const
 SpectrAcq3s that have been discovered after calling the execute() function.
 
- Public Member Functions inherited from horiba::devices::DeviceDiscovery
virtual ~DeviceDiscovery ()=default
 

Detailed Description

Represents a discovery of SpectrAcq cameras on the ICL.

Constructor & Destructor Documentation

◆ SpectrAcq3sDiscovery()

horiba::devices::SpectrAcq3sDiscovery::SpectrAcq3sDiscovery ( std::shared_ptr< horiba::communication::Communicator > communicator)
explicit

Builds a SpectrAcq3 discovery.

Parameters
communicatorThe communicator that will talk to the ICL

◆ ~SpectrAcq3sDiscovery()

horiba::devices::SpectrAcq3sDiscovery::~SpectrAcq3sDiscovery ( )
overridedefault

Member Function Documentation

◆ execute()

void horiba::devices::SpectrAcq3sDiscovery::execute ( bool error_on_no_devices)
overridevirtual

Executes the SpectrAcq3 discovery.

Parameters
error_on_no_devicesWhether to throw an exception or not if no devices are detected

Implements horiba::devices::DeviceDiscovery.

◆ spectracq3s()

std::vector< std::shared_ptr< single_devices::SpectrAcq3 > > horiba::devices::SpectrAcq3sDiscovery::spectracq3s ( ) const
nodiscard

SpectrAcq3s that have been discovered after calling the execute() function.

Returns
The detected SpectrAcqs

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