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

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

#include <ccds_discovery.h>

Inheritance diagram for horiba::devices::ChargeCoupledDevicesDiscovery:

Public Member Functions

 ChargeCoupledDevicesDiscovery (std::shared_ptr< horiba::communication::Communicator > communicator)
 Builds a CCD discovery.
 
 ~ChargeCoupledDevicesDiscovery () override=default
 
void execute (bool error_on_no_devices) noexcept(false) override
 Executes the CCD discovery.
 
std::vector< std::shared_ptr< single_devices::ChargeCoupledDevice > > charge_coupled_devices () const
 CCDs 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

◆ ChargeCoupledDevicesDiscovery()

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

Builds a CCD discovery.

Parameters
communicatorThe communicator that will talk to the ICL

◆ ~ChargeCoupledDevicesDiscovery()

horiba::devices::ChargeCoupledDevicesDiscovery::~ChargeCoupledDevicesDiscovery ( )
overridedefault

Member Function Documentation

◆ charge_coupled_devices()

std::vector< std::shared_ptr< single_devices::ChargeCoupledDevice > > horiba::devices::ChargeCoupledDevicesDiscovery::charge_coupled_devices ( ) const

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

Returns
The detected CCDs

◆ execute()

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

Executes the CCD discovery.

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

Implements horiba::devices::DeviceDiscovery.


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