milk  1.01
Modular Image processing Library toolKit
function_parameters.h File Reference

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

#include "fps_add_entry.h"
#include "fps_checkparameter.h"
#include "fps_connect.h"
#include "fps_connectExternalFPS.h"
#include "fps_CTRLscreen.h"
#include "fps_disconnect.h"
#include "fps_execFPScmd.h"
#include "fps_FPCONFexit.h"
#include "fps_FPCONFloopstep.h"
#include "fps_FPCONFsetup.h"
#include "fps_getFPSargs.h"
#include "fps_load.h"
#include "fps_outlog.h"
#include "fps_paramvalue.h"
#include "fps_processinfo_entries.h"
#include "fps_RUNexit.h"
#include "fps_save2disk.h"
#include "fps_shmdirname.h"
Include dependency graph for function_parameters.h:
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_PROCESS_VARS
 
struct  KEYWORD_TREE_NODE
 

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 FPSCMDCODE_TMUXSTART   0x00000100
 
#define FPSCMDCODE_TMUXSTOP   0x00000200
 
#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
 
#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 STRINGMAXLEN_FPS_NAME   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_STATUS_TMUXCONF   0x1000
 
#define FUNCTION_PARAMETER_STRUCT_STATUS_TMUXRUN   0x2000
 
#define FUNCTION_PARAMETER_STRUCT_STATUS_TMUXCTRL   0x4000
 
#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_CWD_STRLENMAX   200
 
#define FPS_DIR_STRLENMAX   200
 
#define FPS_SRCDIR_STRLENMAX   200
 
#define FPS_PNAME_STRMAXLEN   100
 
#define FPS_CALLPROGNAME_STRMAXLEN   80
 
#define FPS_CALLFUNCNAME_STRMAXLEN   100
 
#define FPS_DESCR_STRMAXLEN   200
 
#define STRINGMAXLEN_FPS_DIRNAME   200
 
#define FPS_LOCALSTATUS_CONFLOOP   0x0001
 
#define NB_FPSCTRL_TASK_MAX   500
 
#define NB_FPSCTRL_TASK_PURGESIZE   50
 
#define FPSTASK_STATUS_ACTIVE   0x0000000000000001
 
#define FPSTASK_STATUS_SHOW   0x0000000000000002
 
#define FPSTASK_STATUS_RUNNING   0x0000000000000004
 
#define FPSTASK_STATUS_COMPLETED   0x0000000000000008
 
#define FPSTASK_STATUS_WAITING   0x0000000000000010
 
#define FPSTASK_STATUS_RECEIVED   0x0000000000000020
 
#define FPSTASK_STATUS_CMDNOTFOUND   0x0000000000000040
 
#define FPSTASK_STATUS_CMDFAIL   0x0000000000000080
 
#define FPSTASK_STATUS_CMDOK   0x0000000000000100
 
#define FPSTASK_FLAG_WAITONRUN   0x0000000000000001
 
#define FPSTASK_FLAG_WAITONCONF   0x0000000000000002
 
#define FPSTASK_FLAG_WAIT_FOR_FPS_NORUN   0x0000000000000004
 
#define NB_FPSCTRL_TASKQUEUE_MAX   100
 
#define NB_KEYWNODE_MAX   10000
 
#define MAX_NB_CHILD   500
 
#define FPS_SETUP_INIT(VARfpsname, VARCMDmode)
 Initialize function parameter structure (FPS) More...
 
#define FPS_CONNECT(VARfpsname, VARCMDmode)
 Connect to FPS. More...
 
#define FPS_CONFLOOP_START
 Start FPS configuration loop. More...
 
#define FPS_CONFLOOP_END
 End FPS configuration loop. More...
 
#define FPS_ADDPARAM_FLT32_IN(key, pname, pdescr, dflt)
 Add 64-bit float parameter entry. More...
 
#define FPS_ADDPARAM_FLT64_IN(key, pname, pdescr, dflt)
 Add 32-bit float parameter entry. More...
 
#define FPS_ADDPARAM_INT64_IN(key, pname, pdescr, dflt)
 Add INT64 input parameter entry. More...
 
#define FPS_ADDPARAM_FILENAME_IN(key, pname, pdescr, dflt)
 Add filename input parameter entry. More...
 
#define FPS_ADDPARAM_STREAM_IN(key, pname, pdescr, dflt)
 Add stream input parameter entry. More...
 
#define FPS_ADDPARAM_ONOFF(key, pname, pdescr, dflt)
 Add ON/OFF parameter entry. More...
 
#define FPS_ADDPARAM_FLT32_OUT(key, pname, pdescr)
 Add FLT32 output parameter entry. More...
 
#define FPS_ADDPARAM_FLT64_OUT(key, pname, pdescr)
 Add FLT64 output parameter entry. More...
 
#define FPS_ADDPARAM_INT64_OUT(key, pname, pdescr)
 Add INT64 output parameter entry. More...
 
#define FPS_ADDPARAM_STREAM_OUT(key, pname, pdescr)
 Add stream output parameter entry. More...
 

Detailed Description

Tools to help expose and control function parameters.

See also
Function Parameter Structure (FPS)