Shared EDT SDK stub declarations for MagAO-X test builds. More...

This graph shows which files directly or indirectly include this file:

Classes
struct	EdtDev
	Stub EDT device handle type used by unit tests. More...

struct	PdvDev
	Stub EDT camera handle type used by unit tests. More...

struct	Dependent
	Stub EDT dependent-configuration type used by unit tests. More...

struct	Edtinfo
	Stub EDT configuration info structure used by unit tests. More...

Macros
#define	EDT_INTERFACE "pdv"
	Default EDT interface name used by the production code.

Typedefs
typedef unsigned int	uint

typedef unsigned char	u_char

Functions
Dependent *	pdv_alloc_dependent ()
	Allocate a stub EDT dependent configuration object.

int	pdv_readcfg (const char configFile, Dependent dd_p, Edtinfo *edtinfo)
	Read a stub EDT configuration file.

EdtDev *	edt_open_channel (const char *deviceName, int unit, int channel)
	Open a stub EDT device channel.

void	edt_perror (char *errstr)
	Report the last stub EDT error message.

int	pdv_initcam (EdtDev edt_p, Dependent dd_p, int unit, Edtinfo edtinfo, const char configFile, char *bitdir, int pdv_debug)
	Initialize a stub EDT camera instance.

void	edt_close (EdtDev *edt_p)
	Close a stub EDT device channel.

PdvDev *	pdv_open_channel (const char *deviceName, int unit, int channel)
	Open a stub PDV device handle.

void	pdv_close (PdvDev *pdv_p)
	Close a stub PDV device handle.

void	pdv_flush_fifo (PdvDev *pdv_p)
	Flush the stub PDV FIFO.

void	pdv_serial_read_enable (PdvDev *pdv_p)
	Enable stub PDV serial reads.

int	pdv_get_width (PdvDev *pdv_p)
	Return the stub PDV frame width.

int	pdv_get_height (PdvDev *pdv_p)
	Return the stub PDV frame height.

int	pdv_get_depth (PdvDev *pdv_p)
	Return the stub PDV frame bit depth.

char *	pdv_get_cameratype (PdvDev *pdv_p)
	Return the stub PDV camera type string.

void	pdv_multibuf (PdvDev *pdv_p, int numBuffs)
	Configure the stub PDV ring-buffer depth.

void	pdv_start_images (PdvDev *pdv_p, int numBuffs)
	Start stub PDV acquisition for multiple images.

u_char *	pdv_wait_last_image_timed (PdvDev *pdv_p, uint dmaTimeStamp[2])
	Wait for the last stub PDV image and fill the DMA timestamp.

void	pdv_start_image (PdvDev *pdv_p)
	Start acquisition of the next stub PDV image.

int	pdv_serial_read (PdvDev pdv_p, char buf, int size)
	Read bytes from the stub PDV serial channel.

int	pdv_serial_command (PdvDev pdv_p, const char command)
	Send a command over the stub PDV serial channel.

int	pdv_serial_wait (PdvDev *pdv_p, int timeout, int count)
	Wait for serial data on the stub PDV channel.

int	pdv_get_waitchar (PdvDev pdv_p, u_char waitc)
	Return the configured stub PDV serial terminator.

Detailed Description

Shared EDT SDK stub declarations for MagAO-X test builds.

Author: OpenAI Codex

Definition in file edtinc.h.

Class Documentation

◆ EdtDev

struct EdtDev

Stub EDT device handle type used by unit tests.

Definition at line 13 of file edtinc.h.

Collaboration diagram for EdtDev:

Class Members
int	unused

◆ PdvDev

struct PdvDev

Stub EDT camera handle type used by unit tests.

Definition at line 19 of file edtinc.h.

Collaboration diagram for PdvDev:

Class Members
int	unused

◆ Dependent

struct Dependent

Stub EDT dependent-configuration type used by unit tests.

Definition at line 25 of file edtinc.h.

Collaboration diagram for Dependent:

Class Members
int	unused

◆ Edtinfo

struct Edtinfo

Stub EDT configuration info structure used by unit tests.

Definition at line 31 of file edtinc.h.

Collaboration diagram for Edtinfo:

Class Members
int	unused

Macro Definition Documentation

◆ EDT_INTERFACE

#define EDT_INTERFACE "pdv"

Default EDT interface name used by the production code.

Definition at line 37 of file edtinc.h.

Typedef Documentation

◆ u_char

typedef unsigned char u_char

Definition at line 10 of file edtinc.h.

◆ uint

typedef unsigned int uint

Definition at line 9 of file edtinc.h.

Function Documentation

◆ edt_close()

void edt_close ( EdtDev * edt_p )

Close a stub EDT device channel.

Definition at line 169 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvConfig().

◆ edt_open_channel()

EdtDev * edt_open_channel	(	const char *	deviceName,
		int	unit,
		int	channel
	)

Open a stub EDT device channel.

Definition at line 134 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvConfig().

◆ edt_perror()

void edt_perror ( char * errstr )

Report the last stub EDT error message.

Definition at line 143 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvConfig(), and libXWCTest::cred2CtrlTest::TEST_CASE().

◆ pdv_alloc_dependent()

Dependent * pdv_alloc_dependent ( )

Allocate a stub EDT dependent configuration object.

Definition at line 120 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvConfig().

◆ pdv_close()

void pdv_close ( PdvDev * pdv_p )

Close a stub PDV device handle.

Definition at line 183 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::~edtCamera(), and MagAOX::app::dev::edtCamera< derivedT >::pdvConfig().

◆ pdv_flush_fifo()

void pdv_flush_fifo ( PdvDev * pdv_p )

Flush the stub PDV FIFO.

Definition at line 188 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvConfig().

◆ pdv_get_cameratype()

char * pdv_get_cameratype ( PdvDev * pdv_p )

Return the stub PDV camera type string.

Definition at line 216 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvConfig().

◆ pdv_get_depth()

int pdv_get_depth ( PdvDev * pdv_p )

Return the stub PDV frame bit depth.

Definition at line 210 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvConfig().

◆ pdv_get_height()

int pdv_get_height ( PdvDev * pdv_p )

Return the stub PDV frame height.

Definition at line 204 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvConfig().

◆ pdv_get_waitchar()

int pdv_get_waitchar	(	PdvDev *	pdv_p,
		u_char *	waitc
	)

Return the configured stub PDV serial terminator.

Definition at line 330 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvSerialWriteRead().

◆ pdv_get_width()

int pdv_get_width ( PdvDev * pdv_p )

Return the stub PDV frame width.

Definition at line 198 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvConfig().

◆ pdv_initcam()

int pdv_initcam	(	EdtDev *	edt_p,
		Dependent *	dd_p,
		int	unit,
		Edtinfo *	edtinfo,
		const char *	configFile,
		char *	bitdir,
		int	pdv_debug
	)

Initialize a stub EDT camera instance.

Definition at line 151 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvConfig().

◆ pdv_multibuf()

void pdv_multibuf	(	PdvDev *	pdv_p,
		int	numBuffs
	)

Configure the stub PDV ring-buffer depth.

Definition at line 223 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvConfig().

◆ pdv_open_channel()

PdvDev * pdv_open_channel	(	const char *	deviceName,
		int	unit,
		int	channel
	)

Open a stub PDV device handle.

Definition at line 174 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvConfig().

◆ pdv_readcfg()

int pdv_readcfg	(	const char *	configFile,
		Dependent *	dd_p,
		Edtinfo *	edtinfo
	)

Read a stub EDT configuration file.

Definition at line 125 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvConfig().

◆ pdv_serial_command()

int pdv_serial_command	(	PdvDev *	pdv_p,
		const char *	command
	)

Send a command over the stub PDV serial channel.

Definition at line 278 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvSerialWriteRead(), and libXWCTest::cred2CtrlTest::TEST_CASE().

◆ pdv_serial_read()

int pdv_serial_read	(	PdvDev *	pdv_p,
		char *	buf,
		int	size
	)

Read bytes from the stub PDV serial channel.

Definition at line 251 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvSerialWriteRead(), and libXWCTest::cred2CtrlTest::TEST_CASE().

◆ pdv_serial_read_enable()

void pdv_serial_read_enable ( PdvDev * pdv_p )

Enable stub PDV serial reads.

Definition at line 193 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvConfig().

◆ pdv_serial_wait()

int pdv_serial_wait	(	PdvDev *	pdv_p,
		int	timeout,
		int	count
	)

Wait for serial data on the stub PDV channel.

Definition at line 310 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvSerialWriteRead(), and libXWCTest::cred2CtrlTest::TEST_CASE().

◆ pdv_start_image()

void pdv_start_image ( PdvDev * pdv_p )

Start acquisition of the next stub PDV image.

Definition at line 245 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvAcquire().

◆ pdv_start_images()

void pdv_start_images	(	PdvDev *	pdv_p,
		int	numBuffs
	)

Start stub PDV acquisition for multiple images.

Definition at line 230 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvStartAcquisition().

◆ pdv_wait_last_image_timed()

u_char * pdv_wait_last_image_timed	(	PdvDev *	pdv_p,
		uint	dmaTimeStamp[2]
	)

Wait for the last stub PDV image and fill the DMA timestamp.

Definition at line 237 of file cred2Ctrl_test.cpp.

Referenced by MagAOX::app::dev::edtCamera< derivedT >::pdvAcquire().

Classes

Macros

Typedefs

Functions

Detailed Description

Class Documentation

◆ EdtDev

◆ PdvDev

◆ Dependent

◆ Edtinfo

Macro Definition Documentation

◆ EDT_INTERFACE

Typedef Documentation

◆ u_char

◆ uint

Function Documentation

◆ edt_close()

◆ edt_open_channel()

◆ edt_perror()

◆ pdv_alloc_dependent()

◆ pdv_close()

◆ pdv_flush_fifo()

◆ pdv_get_cameratype()

◆ pdv_get_depth()

◆ pdv_get_height()

◆ pdv_get_waitchar()

◆ pdv_get_width()

◆ pdv_initcam()

◆ pdv_multibuf()

◆ pdv_open_channel()

◆ pdv_readcfg()

◆ pdv_serial_command()

◆ pdv_serial_read()

◆ pdv_serial_read_enable()

◆ pdv_serial_wait()

◆ pdv_start_image()

◆ pdv_start_images()

◆ pdv_wait_last_image_timed()