WasatchVCPP::Proxy::Driver Class Reference

A proxy customer-facing class providing an object-oriented / STL-based interface to command and control the WasatchVCPP library. More...

#include <WasatchVCPP.h>

Public Member Functions
	Driver ()
	Instantiate a Proxy::Driver.
bool	setLogfile (const std::string &pathname)
bool	setLogLevel (int level)
std::string	getLibraryVersion ()
int	openAllSpectrometers ()
Spectrometer *	getSpectrometer (int index)
	Retrieve a handle to one Spectrometer. More...
bool	closeAllSpectrometers ()
void	destroy ()

Public Attributes
int	numberOfSpectrometers = 0
	number of spectrometers found (set by openAllSpectrometers)

Detailed Description

A proxy customer-facing class providing an object-oriented / STL-based interface to command and control the WasatchVCPP library.

Member Function Documentation

closeAllSpectrometers()

bool WasatchVCPP::Proxy::Driver::closeAllSpectrometers ( )

inline

See also

wp_close_all_spectrometers()

Note

calling wp_close_all_spectrometers() is not sufficient if using WasatchVCPP::Proxy, as Proxy::Spectrometer resources won't be released

destroy()

void WasatchVCPP::Proxy::Driver::destroy ( )

inline

See also

wp_destroy_driver()

getLibraryVersion()

std::string WasatchVCPP::Proxy::Driver::getLibraryVersion ( )

inline

See also

wp_get_library_version

getSpectrometer()

Spectrometer * WasatchVCPP::Proxy::Driver::getSpectrometer ( int  index )

inline

Retrieve a handle to one Spectrometer.

@peram specIndex (Input) which spectrometer (less than numberOfSpectrometers)

Warning

the caller should not 'delete' or 'free' this pointer; it will be released automatically by closeAllSpectrometers

Returns

handle to Proxy::Spectrometer

openAllSpectrometers()

int WasatchVCPP::Proxy::Driver::openAllSpectrometers ( )

inline

See also

wp_open_all_spectrometers()

setLogfile()

bool WasatchVCPP::Proxy::Driver::setLogfile ( const std::string &  pathname )

inline

See also

wp_set_logfile_path

setLogLevel()

bool WasatchVCPP::Proxy::Driver::setLogLevel ( int  level )

inline

See also

wp_set_log_level

---

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

• include/WasatchVCPP.h