function_parameters.h File Reference

Tools to help expose and control function parameters. More...

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

Go to the source code of this file.

Data Structures
struct	FUNCTION_PARAMETER_SUBINFO_STREAM
struct	FUNCTION_PARAMETER_SUBINFO_FPS
struct	FUNCTION_PARAMETER
struct	FUNCTION_PARAMETER_STRUCT_MD
struct	FUNCTION_PARAMETER_STRUCT
struct	FPSCTRL_TASK_QUEUE
struct	FPSCTRL_TASK_ENTRY
struct	FPSCTRL_GUIVARS

Macros
#define	STRINGMAXLEN_FPS_LOGMSG   1000
#define	STRINGMAXLEN_FPS_CMDLINE   1000
#define	NB_FPS_MAX   100
#define	MAXNBLEVELS   20
#define	FPSCONNECT_SIMPLE   0
#define	FPSCONNECT_CONF   1
#define	FPSCONNECT_RUN   2
#define	FPSCMDCODE_CONFSTART   0x00000001
#define	FPSCMDCODE_CONFSTOP   0x00000002
#define	FPSCMDCODE_FPSINIT   0x00000004
#define	FPSCMDCODE_FPSINITCREATE   0x00000008
#define	FPSCMDCODE_RUNSTART   0x00000010
#define	FPSCMDCODE_RUNSTOP   0x00000020
#define	FUNCTION_PARAMETER_KEYWORD_STRMAXLEN   64
#define	FUNCTION_PARAMETER_KEYWORD_MAXLEVEL   20
#define	FPTYPE_UNDEF   0x00000001
#define	FPTYPE_INT32   0x00000002
#define	FPTYPE_UINT32   0x00000004
#define	FPTYPE_INT64   0x00000008
#define	FPTYPE_UINT64   0x00000010
#define	FPTYPE_FLOAT32   0x00000020
#define	FPTYPE_FLOAT64   0x00000040
#define	FPTYPE_PID   0x00000080
#define	FPTYPE_TIMESPEC   0x00000100
#define	FPTYPE_FILENAME   0x00000200
#define	FPTYPE_FITSFILENAME   0x00000400
#define	FPTYPE_EXECFILENAME   0x00000800
#define	FPTYPE_DIRNAME   0x00001000
#define	FPTYPE_STREAMNAME   0x00002000
#define	FPTYPE_STRING   0x00004000
#define	FPTYPE_ONOFF   0x00008000
#define	FPTYPE_PROCESS   0x00010000
#define	FPTYPE_FPSNAME   0x00020000
#define	FUNCTION_PARAMETER_DESCR_STRMAXLEN   64
#define	FUNCTION_PARAMETER_STRMAXLEN   64
#define	FPFLAG_ACTIVE   0x0000000000000001
#define	FPFLAG_USED   0x0000000000000002
#define	FPFLAG_VISIBLE   0x0000000000000004
#define	FPFLAG_WRITE   0x0000000000000010
#define	FPFLAG_WRITECONF   0x0000000000000020
#define	FPFLAG_WRITERUN   0x0000000000000040
#define	FPFLAG_WRITESTATUS   0x0000000000000080
#define	FPFLAG_LOG   0x0000000000000100
#define	FPFLAG_SAVEONCHANGE   0x0000000000000200
#define	FPFLAG_SAVEONCLOSE   0x0000000000000400
#define	FPFLAG_IMPORTED   0x0000000000001000
#define	FPFLAG_FEEDBACK   0x0000000000002000
#define	FPFLAG_ONOFF   0x0000000000004000
#define	FPFLAG_CHECKINIT   0x0000000000010000
#define	FPFLAG_MINLIMIT   0x0000000000020000
#define	FPFLAG_MAXLIMIT   0x0000000000040000
#define	FPFLAG_ERROR   0x0000000000080000
#define	STREAM_LOAD_SOURCE_NOTFOUND   0
#define	STREAM_LOAD_SOURCE_NOTFOUND_STRING   "STREAM_LOAD_SOURCE_NOTFOUND"
#define	STREAM_LOAD_SOURCE_LOCALMEM   1
#define	STREAM_LOAD_SOURCE_LOCALMEM_STRING   "STREAM_LOAD_SOURCE_LOCALMEM"
#define	STREAM_LOAD_SOURCE_SHAREMEM   2
#define	STREAM_LOAD_SOURCE_SHAREMEM_STRING   "STREAM_LOAD_SOURCE_SHAREMEM"
#define	STREAM_LOAD_SOURCE_CONFFITS   3
#define	STREAM_LOAD_SOURCE_CONFFITS_STRING   "STREAM_LOAD_SOURCE_CONFFITS"
#define	STREAM_LOAD_SOURCE_CONFNAME   4
#define	STREAM_LOAD_SOURCE_CONFNAME_STRING   "STREAM_LOAD_SOURCE_CONFNAME"
#define	STREAM_LOAD_SOURCE_NULL   5
#define	STREAM_LOAD_SOURCE_NULL_STRING   "STREAM_LOAD_SOURCE_NULL"
#define	STREAM_LOAD_SOURCE_EXITFAILURE   -1
#define	STREAM_LOAD_SOURCE_EXITFAILURE_STRING   "STREAM_LOAD_SOURCE_EXITFAILURE"
#define	FPFLAG_STREAM_LOAD_FORCE_LOCALMEM   0x0000000000100000
#define	FPFLAG_STREAM_LOAD_FORCE_SHAREMEM   0x0000000000200000
#define	FPFLAG_STREAM_LOAD_FORCE_CONFFITS   0x0000000000400000
#define	FPFLAG_STREAM_LOAD_FORCE_CONFNAME   0x0000000000800000
#define	FPFLAG_STREAM_LOAD_SKIPSEARCH_LOCALMEM   0x0000000001000000
#define	FPFLAG_STREAM_LOAD_SKIPSEARCH_SHAREMEM   0x0000000002000000
#define	FPFLAG_STREAM_LOAD_SKIPSEARCH_CONFFITS   0x0000000004000000
#define	FPFLAG_STREAM_LOAD_SKIPSEARCH_CONFNAME   0x0000000008000000
#define	FPFLAG_STREAM_LOAD_UPDATE_SHAREMEM   0x0000000010000000
#define	FPFLAG_STREAM_LOAD_UPDATE_CONFFITS   0x0000000020000000
#define	FPFLAG_FILE_CONF_REQUIRED   0x0000000040000000
#define	FPFLAG_FILE_RUN_REQUIRED   0x0000000080000000
#define	FPFLAG_FPS_CONF_REQUIRED   0x0000000040000000
#define	FPFLAG_FPS_RUN_REQUIRED   0x0000000080000000
#define	FPFLAG_STREAM_CONF_REQUIRED   0x0000000040000000
#define	FPFLAG_STREAM_RUN_REQUIRED   0x0000000080000000
#define	FPFLAG_STREAM_ENFORCE_DATATYPE   0x0000000100000000
#define	FPFLAG_STREAM_TEST_DATATYPE_UINT8   0x0000000200000000
#define	FPFLAG_STREAM_TEST_DATATYPE_INT8   0x0000000400000000
#define	FPFLAG_STREAM_TEST_DATATYPE_UINT16   0x0000000800000000
#define	FPFLAG_STREAM_TEST_DATATYPE_INT16   0x0000001000000000
#define	FPFLAG_STREAM_TEST_DATATYPE_UINT32   0x0000002000000000
#define	FPFLAG_STREAM_TEST_DATATYPE_INT32   0x0000004000000000
#define	FPFLAG_STREAM_TEST_DATATYPE_UINT64   0x0000008000000000
#define	FPFLAG_STREAM_TEST_DATATYPE_INT64   0x0000010000000000
#define	FPFLAG_STREAM_TEST_DATATYPE_HALF   0x0000020000000000
#define	FPFLAG_STREAM_TEST_DATATYPE_FLOAT   0x0000040000000000
#define	FPFLAG_STREAM_TEST_DATATYPE_DOUBLE   0x0000080000000000
#define	FPFLAG_STREAM_ENFORCE_1D   0x0000100000000000
#define	FPFLAG_STREAM_ENFORCE_2D   0x0000200000000000
#define	FPFLAG_STREAM_ENFORCE_3D   0x0000400000000000
#define	FPFLAG_STREAM_ENFORCE_XSIZE   0x0008000000000000
#define	FPFLAG_STREAM_ENFORCE_YSIZE   0x0010000000000000
#define	FPFLAG_STREAM_ENFORCE_ZSIZE   0x0020000000000000
#define	FPFLAG_CHECKSTREAM   0x0040000000000000
#define	FPFLAG_STREAM_MEMLOADREPORT   0x0080000000000000
#define	FPFLAG_DEFAULT_INPUT   FPFLAG_ACTIVE|FPFLAG_USED|FPFLAG_VISIBLE|FPFLAG_WRITE|FPFLAG_WRITECONF|FPFLAG_SAVEONCHANGE|FPFLAG_FEEDBACK|FPFLAG_CHECKINIT
#define	FPFLAG_DEFAULT_OUTPUT   FPFLAG_ACTIVE|FPFLAG_USED|FPFLAG_VISIBLE
#define	FPFLAG_DEFAULT_INPUT_STREAM   FPFLAG_DEFAULT_INPUT|FPFLAG_STREAM_RUN_REQUIRED|FPFLAG_CHECKSTREAM
#define	FPFLAG_DEFAULT_OUTPUT_STREAM   FPFLAG_DEFAULT_INPUT|FPFLAG_CHECKSTREAM
#define	FPFLAG_DEFAULT_STATUS   FPFLAG_ACTIVE|FPFLAG_USED|FPFLAG_VISIBLE
#define	FUNCTION_PARAMETER_NBPARAM_DEFAULT   100
#define	FUNCTION_PARAMETER_STRUCT_MSG_SIZE   500
#define	FUNCTION_PARAMETER_STRUCT_STATUS_CONF   0x0001
#define	FUNCTION_PARAMETER_STRUCT_STATUS_RUN   0x0002
#define	FUNCTION_PARAMETER_STRUCT_STATUS_CMDCONF   0x0010
#define	FUNCTION_PARAMETER_STRUCT_STATUS_CMDRUN   0x0020
#define	FUNCTION_PARAMETER_STRUCT_STATUS_RUNLOOP   0x0100
#define	FUNCTION_PARAMETER_STRUCT_STATUS_CHECKOK   0x0200
#define	FUNCTION_PARAMETER_STRUCT_SIGNAL_CONFRUN   0x0001
#define	FUNCTION_PARAMETER_STRUCT_SIGNAL_UPDATE   0x0004
#define	FUNCTION_PARAMETER_STRUCT_SIGNAL_CHECKED   0x0008
#define	FPS_NB_MSG   100
#define	FUNCTION_PARAMETER_STRUCT_MSG_LEN   500
#define	FPS_MSG_FLAG_NOTINITIALIZED   0x0001
#define	FPS_MSG_FLAG_BELOWMIN   0x0002
#define	FPS_MSG_FLAG_ABOVEMAX   0x0004
#define	FPS_MSG_FLAG_ERROR   0x0008
#define	FPS_MSG_FLAG_INFO   0x0010
#define	FPS_NAME_STRMAXLEN   100
#define	FPS_CWD_STRLENMAX   200
#define	FPS_SRCDIR_STRLENMAX   200
#define	FPS_PNAME_STRMAXLEN   100
#define	FPS_DESCR_STRMAXLEN   200
#define	NB_FPSCTRL_TASK_MAX   1024
#define	NB_FPSCTRL_TASKQUEUE_MAX   10
#define	FPSTASK_STATUS_ACTIVE   0x0000000000000001
#define	FPSTASK_STATUS_RUNNING   0x0000000000000002
#define	FPSTASK_STATUS_WAITING   0x0000000000000004
#define	FPSTASK_STATUS_SHOW   0x0000000000000008
#define	FPSTASK_FLAG_WAITONRUN   0x0000000000000001
#define	FPSTASK_FLAG_WAITONCONF   0x0000000000000002
#define	FPSTASK_FLAG_WAIT_FOR_FPS_NORUN   0x0000000000000004
#define	FPSTASK_MAX_NBQUEUE   10
#define	FPS_SETUP_INIT(VARfpsname, VARCMDmode)
	Initialize function parameter structure (FPS) More...
#define	FPS_CONNECT(VARfpsname, VARCMDmode)
#define	FPS_CONFLOOP_START
#define	FPS_CONFLOOP_END   functionparameter_CheckParametersAll(&fps);}} function_parameter_FPCONFexit(&fps);
#define	FPS_ADDPARAM_FLT64_IN(key, pname, pdescr, dflt)
#define	FPS_ADDPARAM_INT64_IN(key, pname, pdescr, dflt)
#define	FPS_ADDPARAM_INT64_OUT(key, pname, pdescr)
#define	FPS_ADDPARAM_STREAM_IN(key, pname, pdescr)
#define	FPS_ADDPARAM_STREAM_OUT(key, pname, pdescr)

Functions
errno_t	function_parameter_getFPSname_from_CLIfunc (char *fpsname_default)
errno_t	function_parameter_execFPScmd ()
errno_t	function_parameter_struct_create (int NBparamMAX, const char *name)
long	function_parameter_struct_connect (const char *name, FUNCTION_PARAMETER_STRUCT *fps, int fpsconnectmode)
int	function_parameter_struct_disconnect (FUNCTION_PARAMETER_STRUCT *funcparamstruct)
int	function_parameter_printlist (FUNCTION_PARAMETER *funcparamarray, long NBparamMAX)
int	functionparameter_GetParamIndex (FUNCTION_PARAMETER_STRUCT *fps, const char *paramname)
long	functionparameter_GetParamValue_INT64 (FUNCTION_PARAMETER_STRUCT *fps, const char *paramname)
int	functionparameter_SetParamValue_INT64 (FUNCTION_PARAMETER_STRUCT *fps, const char *paramname, long value)
long *	functionparameter_GetParamPtr_INT64 (FUNCTION_PARAMETER_STRUCT *fps, const char *paramname)
double	functionparameter_GetParamValue_FLOAT64 (FUNCTION_PARAMETER_STRUCT *fps, const char *paramname)
int	functionparameter_SetParamValue_FLOAT64 (FUNCTION_PARAMETER_STRUCT *fps, const char *paramname, double value)
double *	functionparameter_GetParamPtr_FLOAT64 (FUNCTION_PARAMETER_STRUCT *fps, const char *paramname)
float	functionparameter_GetParamValue_FLOAT32 (FUNCTION_PARAMETER_STRUCT *fps, const char *paramname)
int	functionparameter_SetParamValue_FLOAT32 (FUNCTION_PARAMETER_STRUCT *fps, const char *paramname, float value)
float *	functionparameter_GetParamPtr_FLOAT32 (FUNCTION_PARAMETER_STRUCT *fps, const char *paramname)
char *	functionparameter_GetParamPtr_STRING (FUNCTION_PARAMETER_STRUCT *fps, const char *paramname)
int	functionparameter_SetParamValue_STRING (FUNCTION_PARAMETER_STRUCT *fps, const char *paramname, const char *stringvalue)
int	functionparameter_GetParamValue_ONOFF (FUNCTION_PARAMETER_STRUCT *fps, const char *paramname)
int	functionparameter_SetParamValue_ONOFF (FUNCTION_PARAMETER_STRUCT *fps, const char *paramname, int ONOFFvalue)
uint64_t *	functionparameter_GetParamPtr_fpflag (FUNCTION_PARAMETER_STRUCT *fps, const char *paramname)
imageID	functionparameter_LoadStream (FUNCTION_PARAMETER_STRUCT *fps, int pindex, int fpsconnectmode)
int	function_parameter_add_entry (FUNCTION_PARAMETER_STRUCT *fps, const char *keywordstring, const char *descriptionstring, uint64_t type, uint64_t fpflag, void *dataptr)
int	functionparameter_CheckParameter (FUNCTION_PARAMETER_STRUCT *fpsentry, int pindex)
int	functionparameter_CheckParametersAll (FUNCTION_PARAMETER_STRUCT *fpsentry)
int	functionparameter_ConnectExternalFPS (FUNCTION_PARAMETER_STRUCT *FPS, int pindex, FUNCTION_PARAMETER_STRUCT *FPSext)
errno_t	functionparameter_GetTypeString (uint32_t type, char *typestring)
int	functionparameter_PrintParameterInfo (FUNCTION_PARAMETER_STRUCT *fpsentry, int pindex)
FUNCTION_PARAMETER_STRUCT	function_parameter_FPCONFsetup (const char *fpsname, uint32_t CMDmode)
uint16_t	function_parameter_FPCONFloopstep (FUNCTION_PARAMETER_STRUCT *fps)
uint16_t	function_parameter_FPCONFexit (FUNCTION_PARAMETER_STRUCT *fps)
uint16_t	function_parameter_RUNexit (FUNCTION_PARAMETER_STRUCT *fps)
int	functionparameter_SaveParam2disk (FUNCTION_PARAMETER_STRUCT *fpsentry, const char *paramname)
int	functionparameter_WriteParameterToDisk (FUNCTION_PARAMETER_STRUCT *fpsentry, int pindex, char *tagname, char *commentstr)
errno_t	functionparameter_CONFstart (FUNCTION_PARAMETER_STRUCT *fps, int fpsindex)
errno_t	functionparameter_CONFstop (FUNCTION_PARAMETER_STRUCT *fps, int fpsindex)
errno_t	functionparameter_RUNstart (FUNCTION_PARAMETER_STRUCT *fps, int fpsindex)
errno_t	functionparameter_RUNstop (FUNCTION_PARAMETER_STRUCT *fps, int fpsindex)
errno_t	functionparameter_FPSremove (FUNCTION_PARAMETER_STRUCT *fps, int fpsindex)
errno_t	functionparameter_outlog_file (char *keyw, char *msgstring, FILE *fpout)
errno_t	functionparameter_outlog (char *keyw, char *msgstring)
errno_t	functionparameter_outlog_namelink (const char *fpsname, int cmdcode)
	Establish sym link for convenience. More...
errno_t	functionparameter_CTRLscreen (uint32_t mode, char *fpsname, char *fpsCTRLfifoname)

Detailed Description

Tools to help expose and control function parameters.

See also

Function Parameter Structure (FPS)

Macro Definition Documentation

FPFLAG_ACTIVE

#define FPFLAG_ACTIVE   0x0000000000000001

FPFLAG_CHECKINIT

#define FPFLAG_CHECKINIT   0x0000000000010000

FPFLAG_CHECKSTREAM

#define FPFLAG_CHECKSTREAM   0x0040000000000000

FPFLAG_DEFAULT_INPUT

#define FPFLAG_DEFAULT_INPUT   FPFLAG_ACTIVE|FPFLAG_USED|FPFLAG_VISIBLE|FPFLAG_WRITE|FPFLAG_WRITECONF|FPFLAG_SAVEONCHANGE|FPFLAG_FEEDBACK|FPFLAG_CHECKINIT

FPFLAG_DEFAULT_INPUT_STREAM

#define FPFLAG_DEFAULT_INPUT_STREAM   FPFLAG_DEFAULT_INPUT|FPFLAG_STREAM_RUN_REQUIRED|FPFLAG_CHECKSTREAM

FPFLAG_DEFAULT_OUTPUT

#define FPFLAG_DEFAULT_OUTPUT   FPFLAG_ACTIVE|FPFLAG_USED|FPFLAG_VISIBLE

FPFLAG_DEFAULT_OUTPUT_STREAM

#define FPFLAG_DEFAULT_OUTPUT_STREAM   FPFLAG_DEFAULT_INPUT|FPFLAG_CHECKSTREAM

FPFLAG_DEFAULT_STATUS

#define FPFLAG_DEFAULT_STATUS   FPFLAG_ACTIVE|FPFLAG_USED|FPFLAG_VISIBLE

FPFLAG_ERROR

#define FPFLAG_ERROR   0x0000000000080000

FPFLAG_FEEDBACK

#define FPFLAG_FEEDBACK   0x0000000000002000

FPFLAG_FILE_CONF_REQUIRED

#define FPFLAG_FILE_CONF_REQUIRED   0x0000000040000000

FPFLAG_FILE_RUN_REQUIRED

#define FPFLAG_FILE_RUN_REQUIRED   0x0000000080000000

FPFLAG_FPS_CONF_REQUIRED

#define FPFLAG_FPS_CONF_REQUIRED   0x0000000040000000

FPFLAG_FPS_RUN_REQUIRED

#define FPFLAG_FPS_RUN_REQUIRED   0x0000000080000000

FPFLAG_IMPORTED

#define FPFLAG_IMPORTED   0x0000000000001000

FPFLAG_LOG

#define FPFLAG_LOG   0x0000000000000100

FPFLAG_MAXLIMIT

#define FPFLAG_MAXLIMIT   0x0000000000040000

FPFLAG_MINLIMIT

#define FPFLAG_MINLIMIT   0x0000000000020000

FPFLAG_ONOFF

#define FPFLAG_ONOFF   0x0000000000004000

FPFLAG_SAVEONCHANGE

#define FPFLAG_SAVEONCHANGE   0x0000000000000200

FPFLAG_SAVEONCLOSE

#define FPFLAG_SAVEONCLOSE   0x0000000000000400

FPFLAG_STREAM_CONF_REQUIRED

#define FPFLAG_STREAM_CONF_REQUIRED   0x0000000040000000

FPFLAG_STREAM_ENFORCE_1D

#define FPFLAG_STREAM_ENFORCE_1D   0x0000100000000000

FPFLAG_STREAM_ENFORCE_2D

#define FPFLAG_STREAM_ENFORCE_2D   0x0000200000000000

FPFLAG_STREAM_ENFORCE_3D

#define FPFLAG_STREAM_ENFORCE_3D   0x0000400000000000

FPFLAG_STREAM_ENFORCE_DATATYPE

#define FPFLAG_STREAM_ENFORCE_DATATYPE   0x0000000100000000

FPFLAG_STREAM_ENFORCE_XSIZE

#define FPFLAG_STREAM_ENFORCE_XSIZE   0x0008000000000000

FPFLAG_STREAM_ENFORCE_YSIZE

#define FPFLAG_STREAM_ENFORCE_YSIZE   0x0010000000000000

FPFLAG_STREAM_ENFORCE_ZSIZE

#define FPFLAG_STREAM_ENFORCE_ZSIZE   0x0020000000000000

FPFLAG_STREAM_LOAD_FORCE_CONFFITS

#define FPFLAG_STREAM_LOAD_FORCE_CONFFITS   0x0000000000400000

FPFLAG_STREAM_LOAD_FORCE_CONFNAME

#define FPFLAG_STREAM_LOAD_FORCE_CONFNAME   0x0000000000800000

FPFLAG_STREAM_LOAD_FORCE_LOCALMEM

#define FPFLAG_STREAM_LOAD_FORCE_LOCALMEM   0x0000000000100000

FPFLAG_STREAM_LOAD_FORCE_SHAREMEM

#define FPFLAG_STREAM_LOAD_FORCE_SHAREMEM   0x0000000000200000

FPFLAG_STREAM_LOAD_SKIPSEARCH_CONFFITS

#define FPFLAG_STREAM_LOAD_SKIPSEARCH_CONFFITS   0x0000000004000000

FPFLAG_STREAM_LOAD_SKIPSEARCH_CONFNAME

#define FPFLAG_STREAM_LOAD_SKIPSEARCH_CONFNAME   0x0000000008000000

FPFLAG_STREAM_LOAD_SKIPSEARCH_LOCALMEM

#define FPFLAG_STREAM_LOAD_SKIPSEARCH_LOCALMEM   0x0000000001000000

FPFLAG_STREAM_LOAD_SKIPSEARCH_SHAREMEM

#define FPFLAG_STREAM_LOAD_SKIPSEARCH_SHAREMEM   0x0000000002000000

FPFLAG_STREAM_LOAD_UPDATE_CONFFITS

#define FPFLAG_STREAM_LOAD_UPDATE_CONFFITS   0x0000000020000000

FPFLAG_STREAM_LOAD_UPDATE_SHAREMEM

#define FPFLAG_STREAM_LOAD_UPDATE_SHAREMEM   0x0000000010000000

FPFLAG_STREAM_MEMLOADREPORT

#define FPFLAG_STREAM_MEMLOADREPORT   0x0080000000000000

FPFLAG_STREAM_RUN_REQUIRED

#define FPFLAG_STREAM_RUN_REQUIRED   0x0000000080000000

FPFLAG_STREAM_TEST_DATATYPE_DOUBLE

#define FPFLAG_STREAM_TEST_DATATYPE_DOUBLE   0x0000080000000000

FPFLAG_STREAM_TEST_DATATYPE_FLOAT

#define FPFLAG_STREAM_TEST_DATATYPE_FLOAT   0x0000040000000000

FPFLAG_STREAM_TEST_DATATYPE_HALF

#define FPFLAG_STREAM_TEST_DATATYPE_HALF   0x0000020000000000

FPFLAG_STREAM_TEST_DATATYPE_INT16

#define FPFLAG_STREAM_TEST_DATATYPE_INT16   0x0000001000000000

FPFLAG_STREAM_TEST_DATATYPE_INT32

#define FPFLAG_STREAM_TEST_DATATYPE_INT32   0x0000004000000000

FPFLAG_STREAM_TEST_DATATYPE_INT64

#define FPFLAG_STREAM_TEST_DATATYPE_INT64   0x0000010000000000

FPFLAG_STREAM_TEST_DATATYPE_INT8

#define FPFLAG_STREAM_TEST_DATATYPE_INT8   0x0000000400000000

FPFLAG_STREAM_TEST_DATATYPE_UINT16

#define FPFLAG_STREAM_TEST_DATATYPE_UINT16   0x0000000800000000

FPFLAG_STREAM_TEST_DATATYPE_UINT32

#define FPFLAG_STREAM_TEST_DATATYPE_UINT32   0x0000002000000000

FPFLAG_STREAM_TEST_DATATYPE_UINT64

#define FPFLAG_STREAM_TEST_DATATYPE_UINT64   0x0000008000000000

FPFLAG_STREAM_TEST_DATATYPE_UINT8

#define FPFLAG_STREAM_TEST_DATATYPE_UINT8   0x0000000200000000

FPFLAG_USED

#define FPFLAG_USED   0x0000000000000002

FPFLAG_VISIBLE

#define FPFLAG_VISIBLE   0x0000000000000004

FPFLAG_WRITE

#define FPFLAG_WRITE   0x0000000000000010

FPFLAG_WRITECONF

#define FPFLAG_WRITECONF   0x0000000000000020

FPFLAG_WRITERUN

#define FPFLAG_WRITERUN   0x0000000000000040

FPFLAG_WRITESTATUS

#define FPFLAG_WRITESTATUS   0x0000000000000080

FPS_CWD_STRLENMAX

#define FPS_CWD_STRLENMAX   200

FPS_DESCR_STRMAXLEN

#define FPS_DESCR_STRMAXLEN   200

FPS_MSG_FLAG_ABOVEMAX

#define FPS_MSG_FLAG_ABOVEMAX   0x0004

FPS_MSG_FLAG_BELOWMIN

#define FPS_MSG_FLAG_BELOWMIN   0x0002

FPS_MSG_FLAG_ERROR

#define FPS_MSG_FLAG_ERROR   0x0008

FPS_MSG_FLAG_INFO

#define FPS_MSG_FLAG_INFO   0x0010

FPS_MSG_FLAG_NOTINITIALIZED

#define FPS_MSG_FLAG_NOTINITIALIZED   0x0001

FPS_NAME_STRMAXLEN

#define FPS_NAME_STRMAXLEN   100

FPS_NB_MSG

#define FPS_NB_MSG   100

FPS_PNAME_STRMAXLEN

#define FPS_PNAME_STRMAXLEN   100

FPS_SRCDIR_STRLENMAX

#define FPS_SRCDIR_STRLENMAX   200

FPSCMDCODE_CONFSTART

#define FPSCMDCODE_CONFSTART   0x00000001

FPSCMDCODE_CONFSTOP

#define FPSCMDCODE_CONFSTOP   0x00000002

FPSCMDCODE_FPSINIT

#define FPSCMDCODE_FPSINIT   0x00000004

FPSCMDCODE_FPSINITCREATE

#define FPSCMDCODE_FPSINITCREATE   0x00000008

FPSCMDCODE_RUNSTART

#define FPSCMDCODE_RUNSTART   0x00000010

FPSCMDCODE_RUNSTOP

#define FPSCMDCODE_RUNSTOP   0x00000020

FPSCONNECT_CONF

#define FPSCONNECT_CONF   1

FPSCONNECT_RUN

#define FPSCONNECT_RUN   2

FPSCONNECT_SIMPLE

#define FPSCONNECT_SIMPLE   0

FPSTASK_FLAG_WAIT_FOR_FPS_NORUN

#define FPSTASK_FLAG_WAIT_FOR_FPS_NORUN   0x0000000000000004

FPSTASK_FLAG_WAITONCONF

#define FPSTASK_FLAG_WAITONCONF   0x0000000000000002

FPSTASK_FLAG_WAITONRUN

#define FPSTASK_FLAG_WAITONRUN   0x0000000000000001

FPSTASK_MAX_NBQUEUE

#define FPSTASK_MAX_NBQUEUE   10

FPSTASK_STATUS_ACTIVE

#define FPSTASK_STATUS_ACTIVE   0x0000000000000001

FPSTASK_STATUS_RUNNING

#define FPSTASK_STATUS_RUNNING   0x0000000000000002

FPSTASK_STATUS_SHOW

#define FPSTASK_STATUS_SHOW   0x0000000000000008

FPSTASK_STATUS_WAITING

#define FPSTASK_STATUS_WAITING   0x0000000000000004

FPTYPE_DIRNAME

#define FPTYPE_DIRNAME   0x00001000

FPTYPE_EXECFILENAME

#define FPTYPE_EXECFILENAME   0x00000800

FPTYPE_FILENAME

#define FPTYPE_FILENAME   0x00000200

FPTYPE_FITSFILENAME

#define FPTYPE_FITSFILENAME   0x00000400

FPTYPE_FLOAT32

#define FPTYPE_FLOAT32   0x00000020

FPTYPE_FLOAT64

#define FPTYPE_FLOAT64   0x00000040

FPTYPE_FPSNAME

#define FPTYPE_FPSNAME   0x00020000

FPTYPE_INT32

#define FPTYPE_INT32   0x00000002

FPTYPE_INT64

#define FPTYPE_INT64   0x00000008

FPTYPE_ONOFF

#define FPTYPE_ONOFF   0x00008000

FPTYPE_PID

#define FPTYPE_PID   0x00000080

FPTYPE_PROCESS

#define FPTYPE_PROCESS   0x00010000

FPTYPE_STREAMNAME

#define FPTYPE_STREAMNAME   0x00002000

FPTYPE_STRING

#define FPTYPE_STRING   0x00004000

FPTYPE_TIMESPEC

#define FPTYPE_TIMESPEC   0x00000100

FPTYPE_UINT32

#define FPTYPE_UINT32   0x00000004

FPTYPE_UINT64

#define FPTYPE_UINT64   0x00000010

FPTYPE_UNDEF

#define FPTYPE_UNDEF   0x00000001

FUNCTION_PARAMETER_DESCR_STRMAXLEN

#define FUNCTION_PARAMETER_DESCR_STRMAXLEN   64

FUNCTION_PARAMETER_KEYWORD_MAXLEVEL

#define FUNCTION_PARAMETER_KEYWORD_MAXLEVEL   20

FUNCTION_PARAMETER_KEYWORD_STRMAXLEN

#define FUNCTION_PARAMETER_KEYWORD_STRMAXLEN   64

FUNCTION_PARAMETER_NBPARAM_DEFAULT

#define FUNCTION_PARAMETER_NBPARAM_DEFAULT   100

FUNCTION_PARAMETER_STRMAXLEN

#define FUNCTION_PARAMETER_STRMAXLEN   64

FUNCTION_PARAMETER_STRUCT_MSG_LEN

#define FUNCTION_PARAMETER_STRUCT_MSG_LEN   500

FUNCTION_PARAMETER_STRUCT_MSG_SIZE

#define FUNCTION_PARAMETER_STRUCT_MSG_SIZE   500

FUNCTION_PARAMETER_STRUCT_SIGNAL_CHECKED

#define FUNCTION_PARAMETER_STRUCT_SIGNAL_CHECKED   0x0008

FUNCTION_PARAMETER_STRUCT_SIGNAL_CONFRUN

#define FUNCTION_PARAMETER_STRUCT_SIGNAL_CONFRUN   0x0001

FUNCTION_PARAMETER_STRUCT_SIGNAL_UPDATE

#define FUNCTION_PARAMETER_STRUCT_SIGNAL_UPDATE   0x0004

FUNCTION_PARAMETER_STRUCT_STATUS_CHECKOK

#define FUNCTION_PARAMETER_STRUCT_STATUS_CHECKOK   0x0200

FUNCTION_PARAMETER_STRUCT_STATUS_CMDCONF

#define FUNCTION_PARAMETER_STRUCT_STATUS_CMDCONF   0x0010

FUNCTION_PARAMETER_STRUCT_STATUS_CMDRUN

#define FUNCTION_PARAMETER_STRUCT_STATUS_CMDRUN   0x0020

FUNCTION_PARAMETER_STRUCT_STATUS_CONF

#define FUNCTION_PARAMETER_STRUCT_STATUS_CONF   0x0001

FUNCTION_PARAMETER_STRUCT_STATUS_RUN

#define FUNCTION_PARAMETER_STRUCT_STATUS_RUN   0x0002

FUNCTION_PARAMETER_STRUCT_STATUS_RUNLOOP

#define FUNCTION_PARAMETER_STRUCT_STATUS_RUNLOOP   0x0100

MAXNBLEVELS

#define MAXNBLEVELS   20

NB_FPS_MAX

#define NB_FPS_MAX   100

NB_FPSCTRL_TASK_MAX

#define NB_FPSCTRL_TASK_MAX   1024

NB_FPSCTRL_TASKQUEUE_MAX

#define NB_FPSCTRL_TASKQUEUE_MAX   10

STREAM_LOAD_SOURCE_CONFFITS

#define STREAM_LOAD_SOURCE_CONFFITS   3

STREAM_LOAD_SOURCE_CONFFITS_STRING

#define STREAM_LOAD_SOURCE_CONFFITS_STRING   "STREAM_LOAD_SOURCE_CONFFITS"

STREAM_LOAD_SOURCE_CONFNAME

#define STREAM_LOAD_SOURCE_CONFNAME   4

STREAM_LOAD_SOURCE_CONFNAME_STRING

#define STREAM_LOAD_SOURCE_CONFNAME_STRING   "STREAM_LOAD_SOURCE_CONFNAME"

STREAM_LOAD_SOURCE_EXITFAILURE

#define STREAM_LOAD_SOURCE_EXITFAILURE   -1

STREAM_LOAD_SOURCE_EXITFAILURE_STRING

#define STREAM_LOAD_SOURCE_EXITFAILURE_STRING   "STREAM_LOAD_SOURCE_EXITFAILURE"

STREAM_LOAD_SOURCE_LOCALMEM

#define STREAM_LOAD_SOURCE_LOCALMEM   1

STREAM_LOAD_SOURCE_LOCALMEM_STRING

#define STREAM_LOAD_SOURCE_LOCALMEM_STRING   "STREAM_LOAD_SOURCE_LOCALMEM"

STREAM_LOAD_SOURCE_NOTFOUND

#define STREAM_LOAD_SOURCE_NOTFOUND   0

STREAM_LOAD_SOURCE_NOTFOUND_STRING

#define STREAM_LOAD_SOURCE_NOTFOUND_STRING   "STREAM_LOAD_SOURCE_NOTFOUND"

STREAM_LOAD_SOURCE_NULL

#define STREAM_LOAD_SOURCE_NULL   5

STREAM_LOAD_SOURCE_NULL_STRING

#define STREAM_LOAD_SOURCE_NULL_STRING   "STREAM_LOAD_SOURCE_NULL"

STREAM_LOAD_SOURCE_SHAREMEM

#define STREAM_LOAD_SOURCE_SHAREMEM   2

STREAM_LOAD_SOURCE_SHAREMEM_STRING

#define STREAM_LOAD_SOURCE_SHAREMEM_STRING   "STREAM_LOAD_SOURCE_SHAREMEM"

STRINGMAXLEN_FPS_CMDLINE

#define STRINGMAXLEN_FPS_CMDLINE   1000

STRINGMAXLEN_FPS_LOGMSG

#define STRINGMAXLEN_FPS_LOGMSG   1000

Function Documentation

function_parameter_add_entry()

int function_parameter_add_entry	(	FUNCTION_PARAMETER_STRUCT *	fps,
		const char *	keywordstring,
		const char *	descriptionstring,
		uint64_t	type,
		uint64_t	fpflag,
		void *	valueptr
	)

Purpose

Add parameter to database with default settings

If entry already exists, do not modify it

function_parameter_execFPScmd()

errno_t function_parameter_execFPScmd

(

)

function_parameter_FPCONFexit()

uint16_t function_parameter_FPCONFexit

(

FUNCTION_PARAMETER_STRUCT *

fps

)

function_parameter_FPCONFloopstep()

uint16_t function_parameter_FPCONFloopstep

(

FUNCTION_PARAMETER_STRUCT *

fps

)

function_parameter_FPCONFsetup()

FUNCTION_PARAMETER_STRUCT function_parameter_FPCONFsetup	(	const char *	fpsname,
		uint32_t	CMDmode
	)

function_parameter_getFPSname_from_CLIfunc()

errno_t function_parameter_getFPSname_from_CLIfunc

(

char *

fpsname_default

)

Purpose

Construct FPS name and set FPSCMDCODE from command line function call

function_parameter_printlist()

int function_parameter_printlist	(	FUNCTION_PARAMETER *	funcparamarray,
		long	NBparamMAX
	)

function_parameter_RUNexit()

uint16_t function_parameter_RUNexit

(

FUNCTION_PARAMETER_STRUCT *

fps

)

function_parameter_struct_connect()

long function_parameter_struct_connect	(	const char *	name,
		FUNCTION_PARAMETER_STRUCT *	fps,
		int	fpsconnectmode
	)

Purpose

Connect to function parameter structure

Arguments

fpsconnectmode can take following value

FPSCONNECT_SIMPLE : simple connect, don't try load streams FPSCONNECT_CONF : connect as CONF process FPSCONNECT_RUN : connect as RUN process

function_parameter_struct_create()

errno_t function_parameter_struct_create	(	int	NBparamMAX,
		const char *	name
	)

function_parameter_struct_disconnect()

int function_parameter_struct_disconnect

(

FUNCTION_PARAMETER_STRUCT *

funcparamstruct

)

functionparameter_CheckParameter()

int functionparameter_CheckParameter	(	FUNCTION_PARAMETER_STRUCT *	fpsentry,
		int	pindex
	)

functionparameter_CheckParametersAll()

int functionparameter_CheckParametersAll

(

FUNCTION_PARAMETER_STRUCT *

fpsentry

)

functionparameter_CONFstart()

errno_t functionparameter_CONFstart	(	FUNCTION_PARAMETER_STRUCT *	fps,
		int	fpsindex
	)

functionparameter_CONFstop()

errno_t functionparameter_CONFstop	(	FUNCTION_PARAMETER_STRUCT *	fps,
		int	fpsindex
	)

functionparameter_ConnectExternalFPS()

int functionparameter_ConnectExternalFPS	(	FUNCTION_PARAMETER_STRUCT *	FPS,
		int	pindex,
		FUNCTION_PARAMETER_STRUCT *	FPSext
	)

functionparameter_CTRLscreen()

errno_t functionparameter_CTRLscreen	(	uint32_t	mode,
		char *	fpsnamemask,
		char *	fpsCTRLfifoname
	)

Purpose

Automatically build simple ASCII GUI from function parameter structure (fps) name mask

functionparameter_FPSremove()

errno_t functionparameter_FPSremove	(	FUNCTION_PARAMETER_STRUCT *	fps,
		int	fpsindex
	)

functionparameter_GetParamIndex()

int functionparameter_GetParamIndex	(	FUNCTION_PARAMETER_STRUCT *	fps,
		const char *	paramname
	)

functionparameter_GetParamPtr_FLOAT32()

float* functionparameter_GetParamPtr_FLOAT32	(	FUNCTION_PARAMETER_STRUCT *	fps,
		const char *	paramname
	)

functionparameter_GetParamPtr_FLOAT64()

double* functionparameter_GetParamPtr_FLOAT64	(	FUNCTION_PARAMETER_STRUCT *	fps,
		const char *	paramname
	)

functionparameter_GetParamPtr_fpflag()

uint64_t* functionparameter_GetParamPtr_fpflag	(	FUNCTION_PARAMETER_STRUCT *	fps,
		const char *	paramname
	)

functionparameter_GetParamPtr_INT64()

long* functionparameter_GetParamPtr_INT64	(	FUNCTION_PARAMETER_STRUCT *	fps,
		const char *	paramname
	)

functionparameter_GetParamPtr_STRING()

char* functionparameter_GetParamPtr_STRING	(	FUNCTION_PARAMETER_STRUCT *	fps,
		const char *	paramname
	)

functionparameter_GetParamValue_FLOAT32()

float functionparameter_GetParamValue_FLOAT32	(	FUNCTION_PARAMETER_STRUCT *	fps,
		const char *	paramname
	)

functionparameter_GetParamValue_FLOAT64()

double functionparameter_GetParamValue_FLOAT64	(	FUNCTION_PARAMETER_STRUCT *	fps,
		const char *	paramname
	)

functionparameter_GetParamValue_INT64()

long functionparameter_GetParamValue_INT64	(	FUNCTION_PARAMETER_STRUCT *	fps,
		const char *	paramname
	)

functionparameter_GetParamValue_ONOFF()

int functionparameter_GetParamValue_ONOFF	(	FUNCTION_PARAMETER_STRUCT *	fps,
		const char *	paramname
	)

functionparameter_GetTypeString()

errno_t functionparameter_GetTypeString	(	uint32_t	type,
		char *	typestring
	)

functionparameter_LoadStream()

imageID functionparameter_LoadStream	(	FUNCTION_PARAMETER_STRUCT *	fps,
		int	pindex,
		int	fpsconnectmode
	)

functionparameter_outlog()

errno_t functionparameter_outlog	(	char *	keyw,
		char *	msgstring
	)

functionparameter_outlog_file()

errno_t functionparameter_outlog_file	(	char *	keyw,
		char *	msgstring,
		FILE *	fpout
	)

functionparameter_outlog_namelink()

errno_t functionparameter_outlog_namelink	(	const char *	fpsname,
		int	cmdcode
	)

Establish sym link for convenience.

This is a one-time function when running FPS init.
Creates a human-readable informative sym link to outlog

functionparameter_PrintParameterInfo()

int functionparameter_PrintParameterInfo	(	FUNCTION_PARAMETER_STRUCT *	fpsentry,
		int	pindex
	)

functionparameter_RUNstart()

errno_t functionparameter_RUNstart	(	FUNCTION_PARAMETER_STRUCT *	fps,
		int	fpsindex
	)

functionparameter_RUNstop()

errno_t functionparameter_RUNstop	(	FUNCTION_PARAMETER_STRUCT *	fps,
		int	fpsindex
	)

functionparameter_SaveParam2disk()

int functionparameter_SaveParam2disk	(	FUNCTION_PARAMETER_STRUCT *	fpsentry,
		const char *	paramname
	)

functionparameter_SetParamValue_FLOAT32()

int functionparameter_SetParamValue_FLOAT32	(	FUNCTION_PARAMETER_STRUCT *	fps,
		const char *	paramname,
		float	value
	)

functionparameter_SetParamValue_FLOAT64()

int functionparameter_SetParamValue_FLOAT64	(	FUNCTION_PARAMETER_STRUCT *	fps,
		const char *	paramname,
		double	value
	)

functionparameter_SetParamValue_INT64()

int functionparameter_SetParamValue_INT64	(	FUNCTION_PARAMETER_STRUCT *	fps,
		const char *	paramname,
		long	value
	)

functionparameter_SetParamValue_ONOFF()

int functionparameter_SetParamValue_ONOFF	(	FUNCTION_PARAMETER_STRUCT *	fps,
		const char *	paramname,
		int	ONOFFvalue
	)

functionparameter_SetParamValue_STRING()

int functionparameter_SetParamValue_STRING	(	FUNCTION_PARAMETER_STRUCT *	fps,
		const char *	paramname,
		const char *	stringvalue
	)

functionparameter_WriteParameterToDisk()

int functionparameter_WriteParameterToDisk	(	FUNCTION_PARAMETER_STRUCT *	fpsentry,
		int	pindex,
		char *	tagname,
		char *	commentstr
	)

Purpose

Write parameter to disk

TAG names

One of the following:

• "setval" Set value
• "fpsname" Name of FPS to which parameter belongs
• "fpsdir" FPS directory
• "minval" Minimum value (if applicable)
• "maxval" Maximum value (if applicable)
• "currval" Current value (if applicable)