Libpiv API documentation

 Search for 

/home/gerber/gpiv_all/libgpiv-0.4.0/include/gpiv/trig.h File Reference

module for triggering lightsource(s) and camera(s) using RTAI More...

Data Structures
struct	__GpivTrigTime
struct	__GpivTrigPar
Defines
#define	GPIV_TRIGPAR_DEFAULT__TTIME_CAP   250
#define	GPIV_TRIGPAR_DEFAULT__TTIME_LPW   0.02
#define	GPIV_TRIGPAR_DEFAULT__TTIME_T2L   0.19
#define	GPIV_TRIGPAR_DEFAULT__TTIME_DT   10
#define	GPIV_TRIGPAR_DEFAULT__TTIME_MODE   2
#define	GPIV_TRIGPAR_DEFAULT__TTIME_CYCLES   1
#define	GPIV_TRIGPAR_DEFAULT__TTIME_INCR_DT   1
#define	GPIV_TRIGPAR_TTIME_CAP_MIN   100
#define	GPIV_TRIGPAR_TTIME_LPW_MIN   0.02
#define	GPIV_TRIGPAR_TTIME_T2L_MIN   0.19
#define	GPIV_TRIGPAR_TTIME_DT_MIN   0.10
#define	GPIV_TRIGPAR_TTIME_MODE_MIN   1
#define	GPIV_TRIGPAR_TTIME_CYCLES_MIN   1
#define	GPIV_TRIGPAR_TTIME_INCR_DT_MIN   0.01
#define	GPIV_TRIGPAR_TTIME_CAP_MAX   1000
#define	GPIV_TRIGPAR_TTIME_LPW_MAX   0.02
#define	GPIV_TRIGPAR_TTIME_T2L_MAX   0.19
#define	GPIV_TRIGPAR_TTIME_DT_MAX   100
#define	GPIV_TRIGPAR_TTIME_MODE_MAX   6
#define	GPIV_TRIGPAR_TTIME_CYCLES_MAX   1
#define	GPIV_TRIGPAR_TTIME_INCR_DT_MAX   20
#define	GPIV_NANO2MILI   0.001 * 0.001
#define	GPIV_MILI2NANO   1000 * 1000
Enumerations
enum	GpivFifo
enum	GpivTimingMode
Functions
int	gpiv_trig_openrtfs (int *init, int *trig, int *stop, int *error)
void	gpiv_trig_default_parameters (GpivTrigPar *trig_par_default, gboolean force)
void	gpiv_trig_read_parameters (FILE *fp_par, GpivTrigPar *trig_par, int print_par)
char *	gpiv_trig_check_parameters_read (GpivTrigPar *trig_par, GpivTrigPar trig_par_default)
void	gpiv_trig_parameters_logic (GpivTrigPar *trig_par, gboolean flag)
char *	gpiv_trig_test_parameter (GpivTrigPar *trig_par)
void	gpiv_trig_fprint_parameters (FILE *fp_par_out, GpivTrigPar trig_par)

---

Detailed Description

module for triggering lightsource(s) and camera(s) using RTAI

SOURCES: lib/trig.c, lib/trig_par.c

LAST MODIFICATION DATE:

Id

trig.h,v 1.2 2007-01-29 11:53:54 gerber Exp

---

Define Documentation

#define GPIV_MILI2NANO   1000 * 1000

Constant to convert from milli to nanseconds

#define GPIV_NANO2MILI   0.001 * 0.001

Constant to convert from nano ro milliseconds

#define GPIV_TRIGPAR_DEFAULT__TTIME_CAP   250

Default parameter for cam_acq_period of __GpivTrigTime

#define GPIV_TRIGPAR_DEFAULT__TTIME_CYCLES   1

Default parameter for cycles of __GpivTrigTime

#define GPIV_TRIGPAR_DEFAULT__TTIME_DT   10

Default parameter for dt of __GpivTrigTime

#define GPIV_TRIGPAR_DEFAULT__TTIME_INCR_DT   1

Default parameter for increment of __GpivTrigTime

#define GPIV_TRIGPAR_DEFAULT__TTIME_LPW   0.02

Default parameter for laser_trig_pw of __GpivTrigTime

#define GPIV_TRIGPAR_DEFAULT__TTIME_MODE   2

Default parameter for mode of __GpivTrigTime

#define GPIV_TRIGPAR_DEFAULT__TTIME_T2L   0.19

Default parameter for time2laser of __GpivTrigTime

#define GPIV_TRIGPAR_TTIME_CAP_MAX   1000

Maximum value for cam_acq_period of __GpivTrigTime

#define GPIV_TRIGPAR_TTIME_CAP_MIN   100

Minimum value for cam_acq_period of __GpivTrigTime

#define GPIV_TRIGPAR_TTIME_CYCLES_MAX   1

Maximum value for cycles of __GpivTrigTime

#define GPIV_TRIGPAR_TTIME_CYCLES_MIN   1

Minimum value for cycles of __GpivTrigTime

#define GPIV_TRIGPAR_TTIME_DT_MAX   100

Maximum value for dt of __GpivTrigTime

#define GPIV_TRIGPAR_TTIME_DT_MIN   0.10

Minimum value for dt of __GpivTrigTime

#define GPIV_TRIGPAR_TTIME_INCR_DT_MAX   20

Maximum value for increment of __GpivTrigTime

#define GPIV_TRIGPAR_TTIME_INCR_DT_MIN   0.01

Minimum value for increment of __GpivTrigTime

#define GPIV_TRIGPAR_TTIME_LPW_MAX   0.02

Maximum value for laser_trig_pw of __GpivTrigTime

#define GPIV_TRIGPAR_TTIME_LPW_MIN   0.02

Minimum value for laser_trig_pw of __GpivTrigTime

#define GPIV_TRIGPAR_TTIME_MODE_MAX   6

Maximum value for mode of __GpivTrigTime

#define GPIV_TRIGPAR_TTIME_MODE_MIN   1

Minimum value for mode of __GpivTrigTime

#define GPIV_TRIGPAR_TTIME_T2L_MAX   0.19

Maximum value for time2laser of __GpivTrigTime

#define GPIV_TRIGPAR_TTIME_T2L_MIN   0.19

Minimum value for time2laser of __GpivTrigTime

---

Enumeration Type Documentation

enum GpivFifo

Fifo values

enum GpivTimingMode

Operating mode

---

Function Documentation

char* gpiv_trig_check_parameters_read	(	GpivTrigPar *	trig_par,
		GpivTrigPar	trig_par_default
	)

Check out if all GpivTrigPar parameters have been read

Parameters:

[in]	trig_par_default
[out]	trig_par	triggering parameters

Returns:

NULL on success or *err_msg on failure

void gpiv_trig_default_parameters	(	GpivTrigPar *	trig_par_default,
		gboolean	force
	)

Sets default GpivTrigPar parameter values

Parameters:

[in]	force	flag to enforce parameters set to defaults
[out]	trig_par_default	structure of triggering parameters

Returns:

void

void gpiv_trig_fprint_parameters	(	FILE *	fp_par_out,
		GpivTrigPar	trig_par
	)

Prints GpivTrigPar parameters to fp_par_out

Parameters:

[in]	fp_par_out
[in]	trig_par	triggering parameters

Returns:

void

int gpiv_trig_openrtfs	(	int *	init,
		int *	trig,
		int *	stop,
		int *	error
	)

Opens communication channels to camlasco-rtl kernel module

Parameters:

[in]	init	initialization or uploading of trigger parameters
[in]	trig	trigger signel
[in]	stop	stop signal
[in]	error	error signal

Returns:

void

void gpiv_trig_parameters_logic	(	GpivTrigPar *	trig_par,
		gboolean	flag
	)

Sets flags for _logic variables of GpivTrigPar

Parameters:

[in]	flag	flag to be set
[out]	trig_par	triggering parameters

Returns:

void

void gpiv_trig_read_parameters	(	FILE *	fp_par,
		GpivTrigPar *	trig_par,
		int	print_par
	)

Read all GpivTrigPar parameters

Parameters:

[in]	fp_par	file pointer to parameter file
[in]	print_par	flag to print parametrs to stdout
[out]	trig_par	triggering parameters

Returns:

void

char* gpiv_trig_test_parameter

(

GpivTrigPar *

trig_par

)

Testing GpivTrigPar parameters on valid values and initializing derived variables

Parameters:

[in]	trig_par
[out]	trig_par	triggering parameters

Returns:

NULL on success or *err_msg on failure

---