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

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

#include <monos_discovery.h>

Inheritance diagram for horiba::devices::MonochromatorsDiscovery:

Public Member Functions

 MonochromatorsDiscovery (std::shared_ptr< horiba::communication::Communicator > communicator)
 Builds a Monochromator discovery.
 
 ~MonochromatorsDiscovery () override=default
 
void execute (bool error_on_no_devices) noexcept(false) override
 Executes the Monochromator discovery.
 
std::vector< std::shared_ptr< single_devices::Monochromator > > monochromators () const
 Monochromators 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 CCD cameras on the ICL.

Constructor & Destructor Documentation

◆ MonochromatorsDiscovery()

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

Builds a Monochromator discovery.

Parameters
communicatorThe communicator that will talk to the ICL

◆ ~MonochromatorsDiscovery()

horiba::devices::MonochromatorsDiscovery::~MonochromatorsDiscovery ( )
overridedefault

Member Function Documentation

◆ execute()

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

Executes the Monochromator discovery.

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

Implements horiba::devices::DeviceDiscovery.

◆ monochromators()

std::vector< std::shared_ptr< single_devices::Monochromator > > horiba::devices::MonochromatorsDiscovery::monochromators ( ) const
nodiscard

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

Returns
The detected monochromators

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