tool_lib.c File Reference

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <alarm.h>
#include <epicsTime.h>
#include <epicsString.h>
#include <cadef.h>
#include "tool_lib.h"

Include dependency graph for tool_lib.c:

Go to the source code of this file.

Macros
#define	TIMETEXTLEN   28 /* Length of timestamp text buffer */
#define	STR   500
#define	FMT_TIME   " Timestamp: %s"
#define	ARGS_TIME(T)   timeText
#define	FMT_STS
#define	ARGS_STS(T)
#define	ARGS_STS_UNSIGNED(T)
#define	FMT_ACK
#define	ARGS_ACK(T)
#define	FMT_UNITS   " Units: %s"
#define	ARGS_UNITS(T)   ((struct T *)value)->units
#define	FMT_PREC   " Precision: %d"
#define	ARGS_PREC(T)   ((struct T *)value)->precision
#define	FMT_GR(FMT)
#define	ARGS_GR(T, F)
#define	FMT_CTRL(FMT)
#define	ARGS_CTRL(T, F)
#define	PRN_DBR_STS(T)
#define	PRN_DBR_TIME(T)
#define	PRN_DBR_GR(T, F, FMT)
#define	PRN_DBR_GR_PREC(T, F, FMT)
#define	PRN_DBR_CTRL(T, F, FMT)
#define	PRN_DBR_CTRL_PREC(T, F, FMT)
#define	PRN_DBR_STSACK(T)
#define	PRN_DBR_X_ENUM(T)
#define	DBR_PRINT_BUFFER_SIZE
#define	PRN_TIME_VAL_STS(TYPE, TYPE_ENUM)

Functions
char *	val2str (const void *v, unsigned type, int index)
char *	dbr2str (const void *value, unsigned type)
void	print_time_val_sts (pv *pv, unsigned long reqElems)
int	create_pvs (pv *pvs, int nPvs, caCh *pCB)
int	connect_pvs (pv *pvs, int nPvs)

Variables
TimeT	tsType = absolute
int	tsSrcServer = 1
int	tsSrcClient = 0
IntFormatT	outTypeI = dec
IntFormatT	outTypeF = dec
char	dblFormatStr [30] = "%g"
char	timeFormatStr [30] = "%Y-%m-%d %H:%M:%S.%06f"
char	fieldSeparator = ' '
int	enumAsNr = 0
int	charArrAsStr = 0
double	caTimeout = 1.0
capri	caPriority = DEFAULT_CA_PRIORITY

Macro Definition Documentation

#define ARGS_ACK

(

T

)

Value:

((struct T *)value)->ackt ? "YES" : "NO",   \
    sevr_to_str_unsigned(((struct T *)value)->acks)

Definition at line 230 of file tool_lib.c.

#define ARGS_CTRL	(		T,
			F
	)

Value:

(F)((struct T *)value)->lower_ctrl_limit,   \
    (F)((struct T *)value)->upper_ctrl_limit

Definition at line 266 of file tool_lib.c.

#define ARGS_GR	(		T,
			F
	)

Value:

(F)((struct T *)value)->lower_disp_limit,   \
    (F)((struct T *)value)->upper_disp_limit,   \
    (F)((struct T *)value)->lower_alarm_limit,  \
    (F)((struct T *)value)->lower_warning_limit, \
    (F)((struct T *)value)->upper_warning_limit, \
    (F)((struct T *)value)->upper_alarm_limit

Definition at line 254 of file tool_lib.c.

#define ARGS_PREC

(

T

)

((struct T *)value)->precision

Definition at line 243 of file tool_lib.c.

#define ARGS_STS

(

T

)

Value:

stat_to_str(((struct T *)value)->status),   \
    sevr_to_str(((struct T *)value)->severity)

Definition at line 218 of file tool_lib.c.

#define ARGS_STS_UNSIGNED

(

T

)

Value:

stat_to_str_unsigned(((struct T *)value)->status),  \
    sevr_to_str_unsigned(((struct T *)value)->severity)

Definition at line 222 of file tool_lib.c.

#define ARGS_TIME

(

T

)

timeText

Definition at line 211 of file tool_lib.c.

#define ARGS_UNITS

(

T

)

((struct T *)value)->units

Definition at line 237 of file tool_lib.c.

#define DBR_PRINT_BUFFER_SIZE

Value:

50                        /* timestamp */                         \
    + 2 * 30                    /* status / Severity */                 \
    + 2 * 30                    /* acks / ackt */                       \
    + 20 + MAX_UNITS_SIZE       /* units */                             \
    + 30                        /* precision */                         \
    + 6 * 45                    /* graphic limits */                    \
    + 2 * 45                    /* control limits */                    \
    + 30 + (MAX_ENUM_STATES * (20 + MAX_ENUM_STRING_SIZE)) /* enums */  \
    + 50                        /* just to be sure */

Definition at line 322 of file tool_lib.c.

#define FMT_ACK

Value:

"    Ack transient?:   %s\n"                \
    "    Ack severity:     %s"

Definition at line 226 of file tool_lib.c.

#define FMT_CTRL

(

FMT

)

Value:

"    Lo ctrl limit:    " #FMT "\n"          \
    "    Hi ctrl limit:    " #FMT

Definition at line 262 of file tool_lib.c.

#define FMT_GR

(

FMT

)

Value:

"    Lo disp limit:    " #FMT "\n"          \
    "    Hi disp limit:    " #FMT "\n"          \
    "    Lo alarm limit:   " #FMT "\n"          \
    "    Lo warn limit:    " #FMT "\n"          \
    "    Hi warn limit:    " #FMT "\n"          \
    "    Hi alarm limit:   " #FMT

Definition at line 246 of file tool_lib.c.

#define FMT_PREC   " Precision: %d"

Definition at line 240 of file tool_lib.c.

#define FMT_STS

Value:

"    Status:           %s\n"                \
    "    Severity:         %s"

Definition at line 214 of file tool_lib.c.

#define FMT_TIME   " Timestamp: %s"

Definition at line 208 of file tool_lib.c.

#define FMT_UNITS   " Units: %s"

Definition at line 234 of file tool_lib.c.

#define PRN_DBR_CTRL	(		T,
			F,
			FMT
	)

Value:

sprintf(str,                                                                \
            FMT_STS "\n" FMT_UNITS "\n" FMT_GR(FMT) "\n" FMT_CTRL(FMT),         \
            ARGS_STS(T), ARGS_UNITS(T), ARGS_GR(T,F),    ARGS_CTRL(T,F))

Definition at line 295 of file tool_lib.c.

#define PRN_DBR_CTRL_PREC	(		T,
			F,
			FMT
	)

Value:

sprintf(str,                                                                        \
            FMT_STS "\n" FMT_UNITS "\n" FMT_PREC "\n" FMT_GR(FMT) "\n" FMT_CTRL(FMT),   \
            ARGS_STS(T), ARGS_UNITS(T), ARGS_PREC(T), ARGS_GR(T,F),    ARGS_CTRL(T,F))

Definition at line 300 of file tool_lib.c.

#define PRN_DBR_GR	(		T,
			F,
			FMT
	)

Value:

sprintf(str,                                        \
            FMT_STS "\n" FMT_UNITS "\n" FMT_GR(FMT),    \
            ARGS_STS(T), ARGS_UNITS(T), ARGS_GR(T,F))

Definition at line 285 of file tool_lib.c.

#define PRN_DBR_GR_PREC	(		T,
			F,
			FMT
	)

Value:

sprintf(str,                                                        \
            FMT_STS "\n" FMT_UNITS "\n" FMT_PREC "\n" FMT_GR(FMT),      \
            ARGS_STS(T), ARGS_UNITS(T), ARGS_PREC(T), ARGS_GR(T,F))

Definition at line 290 of file tool_lib.c.

#define PRN_DBR_STS

(

T

)

Value:

sprintf(str,                                \
            FMT_STS,                            \
            ARGS_STS(T))

Definition at line 273 of file tool_lib.c.

#define PRN_DBR_STSACK

(

T

)

Value:

sprintf(str,                                \
            FMT_STS "\n" FMT_ACK,               \
            ARGS_STS_UNSIGNED(T), ARGS_ACK(T))

Definition at line 305 of file tool_lib.c.

#define PRN_DBR_TIME

(

T

)

Value:

epicsTimeToStrftime(timeText, TIMETEXTLEN, timeFormatStr,   \
                        &(((struct T *)value)->stamp));         \
    sprintf(str,                                                \
            FMT_TIME "\n" FMT_STS,                              \
            ARGS_TIME(T), ARGS_STS(T))

Definition at line 278 of file tool_lib.c.

#define PRN_DBR_X_ENUM

(

T

)

Value:

n = ((struct T *)value)->no_str;                    \
    PRN_DBR_STS(T);                                     \
    sprintf(str+strlen(str),                            \
                "\n    Enums:            (%2d)", n);    \
    for (i=0; i<n; i++)                                 \
        sprintf(str+strlen(str),                        \
                "\n                      [%2d] %s", i,  \
                ((struct T *)value)->strs[i]);

Definition at line 310 of file tool_lib.c.

#define PRN_TIME_VAL_STS	(		TYPE,
			TYPE_ENUM
	)

Definition at line 411 of file tool_lib.c.

#define STR   500

#define TIMETEXTLEN   28 /* Length of timestamp text buffer */

Definition at line 58 of file tool_lib.c.

Function Documentation

int connect_pvs	(	pv *	pvs,
		int	nPvs
	)

Definition at line 621 of file tool_lib.c.

{
    int returncode = create_pvs ( pvs, nPvs, 0);
    if ( returncode == 0 ) {
                            /* Wait for channels to connect */
        int result = ca_pend_io (caTimeout);
        if (result == ECA_TIMEOUT)
        {
            if (nPvs > 1)
            {
                fprintf(stderr, "Channel connect timed out: some PV(s) not found.\n");
            } else {
                fprintf(stderr, "Channel connect timed out: '%s' not found.\n",
                        pvs[0].name);
            }
            returncode = 1;
        }
    }
    return returncode;
}

int create_pvs	(	pv *	pvs,
		int	nPvs,
		caCh *	pCB
	)

Definition at line 574 of file tool_lib.c.

{
    int n;
    int result;
    int returncode = 0;

    if (!tsInitC)                /* Initialize start timestamp */
    {
        epicsTimeGetCurrent(&tsStart);
        tsInitC = 1;
    }
                                 /* Issue channel connections */
    for (n = 0; n < nPvs; n++) {
        result = ca_create_channel (pvs[n].name,
                                    pCB,
                                    &pvs[n],
                                    caPriority,
                                    &pvs[n].chid);
        if (result != ECA_NORMAL) {
            fprintf(stderr, "CA error %s occurred while trying "
                    "to create channel '%s'.\n", ca_message(result), pvs[n].name);
            pvs[n].status = result;
            returncode = 1;
        }
    }

    return returncode;
}

char* dbr2str	(	const void *	value,
		unsigned	type
	)

Definition at line 333 of file tool_lib.c.

{
    static char str[DBR_PRINT_BUFFER_SIZE];
    char timeText[TIMETEXTLEN];
    int n, i;

    switch (type) {
    case DBR_STRING:   /* no additional information for basic data types */
    case DBR_INT:
    case DBR_FLOAT:
    case DBR_ENUM:
    case DBR_CHAR:
    case DBR_LONG:
    case DBR_DOUBLE: break;

    case DBR_CTRL_STRING:       /* see db_access.h: not implemented */
    case DBR_GR_STRING:         /* see db_access.h: not implemented */
    case DBR_STS_STRING:  PRN_DBR_STS(dbr_sts_string); break;
    case DBR_STS_SHORT:   PRN_DBR_STS(dbr_sts_short); break;
    case DBR_STS_FLOAT:   PRN_DBR_STS(dbr_sts_float); break;
    case DBR_STS_ENUM:    PRN_DBR_STS(dbr_sts_enum); break;
    case DBR_STS_CHAR:    PRN_DBR_STS(dbr_sts_char); break;
    case DBR_STS_LONG:    PRN_DBR_STS(dbr_sts_long); break;
    case DBR_STS_DOUBLE:  PRN_DBR_STS(dbr_sts_double); break;

    case DBR_TIME_STRING: PRN_DBR_TIME(dbr_time_string); break;
    case DBR_TIME_SHORT:  PRN_DBR_TIME(dbr_time_short); break;
    case DBR_TIME_FLOAT:  PRN_DBR_TIME(dbr_time_float); break;
    case DBR_TIME_ENUM:   PRN_DBR_TIME(dbr_time_enum); break;
    case DBR_TIME_CHAR:   PRN_DBR_TIME(dbr_time_char); break;
    case DBR_TIME_LONG:   PRN_DBR_TIME(dbr_time_long); break;
    case DBR_TIME_DOUBLE: PRN_DBR_TIME(dbr_time_double); break;

    case DBR_GR_CHAR:
        PRN_DBR_GR(dbr_gr_char, char, %8d); break;
    case DBR_GR_INT:
        PRN_DBR_GR(dbr_gr_int,  int,  %8d); break;
    case DBR_GR_LONG:
        PRN_DBR_GR(dbr_gr_long, long int, %8ld); break;
    case DBR_GR_FLOAT:
        PRN_DBR_GR_PREC(dbr_gr_float,  float, %g); break;
    case DBR_GR_DOUBLE:
        PRN_DBR_GR_PREC(dbr_gr_double, double, %g); break;
    case DBR_GR_ENUM:
        PRN_DBR_X_ENUM(dbr_gr_enum); break;
    case DBR_CTRL_CHAR:
        PRN_DBR_CTRL(dbr_ctrl_char,   char,     %8d); break;
    case DBR_CTRL_INT:
        PRN_DBR_CTRL(dbr_ctrl_int,    int,      %8d); break;
    case DBR_CTRL_LONG:
        PRN_DBR_CTRL(dbr_ctrl_long,   long int, %8ld); break;
    case DBR_CTRL_FLOAT:
        PRN_DBR_CTRL_PREC(dbr_ctrl_float,  float,  %g); break;
    case DBR_CTRL_DOUBLE:
        PRN_DBR_CTRL_PREC(dbr_ctrl_double, double, %g); break;
    case DBR_CTRL_ENUM:
        PRN_DBR_X_ENUM(dbr_ctrl_enum); break;
    case DBR_STSACK_STRING:
        PRN_DBR_STSACK(dbr_stsack_string); break;
    default : strcpy (str, "can't print data type");
    }
    return str;
}

void print_time_val_sts	(	pv *	pv,
		unsigned long	reqElems
	)

Definition at line 503 of file tool_lib.c.

{
    char timeText[2*TIMETEXTLEN+2];
    int i, printAbs;
    void* value = pv->value;
    epicsTimeStamp *ptsRefC, *ptsRefS;  /* Reference timestamps (client, server) */
    epicsTimeStamp *ptsNewC, *ptsNewS;  /* Update timestamps (client, server) */
    epicsTimeStamp tsNow;

    epicsTimeGetCurrent(&tsNow);
    epicsTimeToStrftime(timeText, TIMETEXTLEN, timeFormatStr, &tsNow);

    if (pv->nElems <= 1 && fieldSeparator == ' ') printf("%-30s", pv->name);
    else                                            printf("%s", pv->name);
    printf("%c", fieldSeparator);
    if (!pv->onceConnected)
        printf("*** Not connected (PV not found)\n");
    else if (pv->status == ECA_DISCONN)
        printf("%s *** disconnected\n", timeText);
    else if (pv->status == ECA_NORDACCESS)
        printf("%s *** no read access\n", timeText);
    else if (pv->status != ECA_NORMAL)
        printf("%s *** CA error %s\n", timeText, ca_message(pv->status));
    else if (pv->value == 0)
        printf("%s *** no data available (timeout)\n", timeText);
    else
        switch (pv->dbrType) {
        case DBR_TIME_STRING:
            PRN_TIME_VAL_STS(dbr_time_string, DBR_TIME_STRING);
            break;
        case DBR_TIME_SHORT:
            PRN_TIME_VAL_STS(dbr_time_short, DBR_TIME_SHORT);
            break;
        case DBR_TIME_FLOAT:
            PRN_TIME_VAL_STS(dbr_time_float, DBR_TIME_FLOAT);
            break;
        case DBR_TIME_ENUM:
            PRN_TIME_VAL_STS(dbr_time_enum, DBR_TIME_ENUM);
            break;
        case DBR_TIME_CHAR:
            PRN_TIME_VAL_STS(dbr_time_char, DBR_TIME_CHAR);
            break;
        case DBR_TIME_LONG:
            PRN_TIME_VAL_STS(dbr_time_long, DBR_TIME_LONG);
            break;
        case DBR_TIME_DOUBLE:
            PRN_TIME_VAL_STS(dbr_time_double, DBR_TIME_DOUBLE);
            break;
        default: printf("can't print data type\n");
        }
}

char* val2str	(	const void *	v,
		unsigned	type,
		int	index
	)

Definition at line 109 of file tool_lib.c.

{
#define STR 500
    static char str[STR];
    char ch;
    void *val_ptr;
    unsigned base_type;
    dbr_long_t val_long;

    if (!dbr_type_is_valid(type)) {
        strcpy (str, "*** invalid type");
        return str;
    }
    strcpy (str, "!!!");

    base_type = type % (LAST_TYPE+1);

    if (type == DBR_STSACK_STRING || type == DBR_CLASS_NAME)
        base_type = DBR_STRING;

    val_ptr = dbr_value_ptr(v, type);

    switch (base_type) {
    case DBR_STRING:
        epicsStrnEscapedFromRaw(str, STR, ((dbr_string_t*) val_ptr)[index], strlen(((dbr_string_t*) val_ptr)[index]));
        break;
    case DBR_FLOAT:
        if (outTypeF == dec) {
          sprintf(str, dblFormatStr, ((dbr_float_t*) val_ptr)[index]);
        } else {
          if (((dbr_float_t*) val_ptr)[index] > 0.0)
            val_long = ((dbr_float_t*) val_ptr)[index] + 0.5;
          else
            val_long = ((dbr_float_t*) val_ptr)[index] - 0.5;
          sprint_long(str, val_long, outTypeF);
        }
        break;
    case DBR_DOUBLE:
        if (outTypeF == dec) {
          sprintf(str, dblFormatStr, ((dbr_double_t*) val_ptr)[index]);
        } else {
          if (((dbr_double_t*) val_ptr)[index] > 0.0)
            val_long = ((dbr_double_t*) val_ptr)[index] + 0.5;
          else
            val_long = ((dbr_double_t*) val_ptr)[index] - 0.5;
          sprint_long(str, val_long, outTypeF);
        }
        break;
    case DBR_CHAR:
        ch = ((dbr_char_t*) val_ptr)[index];
        sprintf(str, "%d", ch);
        break;
    case DBR_INT:
        sprint_long(str, ((dbr_int_t*) val_ptr)[index], outTypeI);
        break;
    case DBR_LONG:
        sprint_long(str, ((dbr_long_t*) val_ptr)[index], outTypeI);
        break;
    case DBR_ENUM:
        {
            dbr_enum_t *val = (dbr_enum_t *)val_ptr;
            if (dbr_type_is_GR(type) && !enumAsNr) {
                if (val[index] >= MAX_ENUM_STATES)
                    sprintf(str, "Illegal Value (%d)", val[index]);
                else if (val[index] >= ((struct dbr_gr_enum *)v)->no_str)
                    sprintf(str, "Enum Index Overflow (%d)", val[index]);
                else
                    sprintf(str, "%s", ((struct dbr_gr_enum *)v)->strs[val[index]]);
            } else if (dbr_type_is_CTRL(type) && !enumAsNr) {
                if (val[index] >= MAX_ENUM_STATES)
                    sprintf(str, "Illegal Value (%d)", val[index]);
                else if (val[index] >= ((struct dbr_ctrl_enum *)v)->no_str)
                    sprintf(str, "Enum Index Overflow (%d)", val[index]);
                else
                    sprintf(str, "%s", ((struct dbr_ctrl_enum *)v)->strs[val[index]]);
            } else
                sprintf(str, "%d", val[index]);
        }
    }
    return str;
}

Variable Documentation

capri caPriority = DEFAULT_CA_PRIORITY

Definition at line 56 of file tool_lib.c.

double caTimeout = 1.0

Definition at line 55 of file tool_lib.c.

int charArrAsStr = 0

Definition at line 54 of file tool_lib.c.

char dblFormatStr[30] = "%g"

Definition at line 49 of file tool_lib.c.

int enumAsNr = 0

Definition at line 53 of file tool_lib.c.

char fieldSeparator = ' '

Definition at line 51 of file tool_lib.c.

IntFormatT outTypeF = dec

Definition at line 47 of file tool_lib.c.

IntFormatT outTypeI = dec

Definition at line 46 of file tool_lib.c.

char timeFormatStr[30] = "%Y-%m-%d %H:%M:%S.%06f"

Definition at line 50 of file tool_lib.c.

int tsSrcClient = 0

Definition at line 45 of file tool_lib.c.

int tsSrcServer = 1

Definition at line 44 of file tool_lib.c.

TimeT tsType = absolute

Definition at line 43 of file tool_lib.c.