shamrock Class Reference

Driver for Andor Shamrock spectrographs. More...

Inheritance diagram for shamrock:

Public Member Functions
	shamrock (const char *portName, int shamrockID, const char *iniPath, int priority, int stacksize)
	Constructor for the shamrock class. More...
virtual asynStatus	writeInt32 (asynUser *pasynUser, epicsInt32 value)
	Sets an int32 parameter. More...
virtual asynStatus	writeFloat64 (asynUser *pasynUser, epicsFloat64 value)
	Sets an float64 parameter. More...
virtual asynStatus	readFloat32Array (asynUser *pasynUser, epicsFloat32 *pValue, size_t nElements, size_t *nIn)
	Reads float32 array. More...
void	report (FILE *fp, int details)
	Print out a report; calls asynPortDriver::report to get base class report as well. More...

Protected Attributes
int	SRWavelength_
int	SRMinWavelength_
int	SRMaxWavelength_
	Min wavelength (float64 read/write) More...
int	SRCalibration_
	Min wavelength (float64 read/write) More...
int	SRGrating_
	Calibration (float32 array read) More...
int	SRNumGratings_
	Grating (int32 read/write) More...
int	SRGratingExists_
	Number of gratings (int32 read) More...
int	SRFlipperMirrorExists_
	Grating exists (int32 read) More...
int	SRFlipperMirrorPort_
	Flipper Mirror exists (int32 read) More...
int	SRSlitExists_
	Flipper Mirror Port (int32 read/write) More...
int	SRSlitSize_
	Slit exists (int32 read) More...

Detailed Description

Driver for Andor Shamrock spectrographs.

One instance of this class will control one spectrograph.

Constructor & Destructor Documentation

shamrock()

shamrock::shamrock	(	const char *	portName,
		int	shamrockID,
		const char *	iniPath,
		int	priority,
		int	stackSize
	)

Constructor for the shamrock class.

Parameters

[in]	portName	asyn port name to assign to the camera.
[in]	shamrockID	The spectrograph index.
[in]	iniPath	The path to the camera ini file
[in]	priority	The EPICS thread priority for this driver. 0=use asyn default.
[in]	stackSize	The size of the stack for the EPICS port thread. 0=use asyn default.

Member Function Documentation

readFloat32Array()

asynStatus shamrock::readFloat32Array ( asynUser *  pasynUser, epicsFloat32 *  pValue, size_t  nElements, size_t *  nIn  )

virtual

Reads float32 array.

Parameters

[in]	pasynUser	asynUser structure that contains the function code in pasynUser->reason.
[in]	pValue	The array
[in]	nElements	The size of the array
[out]	nIn	The number of elements copied to the array Takes action if the function code requires it.

report()

void shamrock::report	(	FILE *	fp,
		int	details
	)

Print out a report; calls asynPortDriver::report to get base class report as well.

Parameters

[in]	fp	File pointer to write output to
[in]	details	Level of detail desired.

writeFloat64()

asynStatus shamrock::writeFloat64 ( asynUser *  pasynUser, epicsFloat64  value  )

virtual

Sets an float64 parameter.

Parameters

[in]	pasynUser	asynUser structure that contains the function code in pasynUser->reason.
[in]	value	The value for this parameter

Takes action if the function code requires it.

writeInt32()

asynStatus shamrock::writeInt32 ( asynUser *  pasynUser, epicsInt32  value  )

virtual

Sets an int32 parameter.

Parameters

[in]	pasynUser	asynUser structure that contains the function code in pasynUser->reason.
[in]	value	The value for this parameter

Takes action if the function code requires it. ADAcquire, ADSizeX, and many other function codes make calls to the Firewire library from this function.

Member Data Documentation

SRCalibration_

int shamrock::SRCalibration_

protected

Min wavelength (float64 read/write)

SRFlipperMirrorExists_

int shamrock::SRFlipperMirrorExists_

protected

Grating exists (int32 read)

SRFlipperMirrorPort_

int shamrock::SRFlipperMirrorPort_

protected

Flipper Mirror exists (int32 read)

SRGrating_

int shamrock::SRGrating_

protected

Calibration (float32 array read)

SRGratingExists_

int shamrock::SRGratingExists_

protected

Number of gratings (int32 read)

SRMaxWavelength_

int shamrock::SRMaxWavelength_

protected

Min wavelength (float64 read/write)

SRMinWavelength_

int shamrock::SRMinWavelength_

protected

SRNumGratings_

int shamrock::SRNumGratings_

protected

Grating (int32 read/write)

SRSlitExists_

int shamrock::SRSlitExists_

protected

Flipper Mirror Port (int32 read/write)

SRSlitSize_

int shamrock::SRSlitSize_

protected

Slit exists (int32 read)

SRWavelength_

int shamrock::SRWavelength_

protected

---

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

• /home/runner/work/areaDetector/areaDetector/ADAndor/andorApp/src/shamrock.cpp