tool_lib.h File Reference

#include <epicsTime.h>

Include dependency graph for tool_lib.h:

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

Go to the source code of this file.

Classes
struct	pv

Macros
#define	stat_to_str(stat)
#define	sevr_to_str(stat)
#define	stat_to_str_unsigned(stat)
#define	sevr_to_str_unsigned(stat)
#define	DEFAULT_CA_PRIORITY   0 /* Default CA priority */
#define	DEFAULT_TIMEOUT   1.0 /* Default CA timeout */
#define	LINE_BUFFER(stream)   setvbuf(stream, NULL, _IOLBF, BUFSIZ)

Enumerations
enum	TimeT { absolute, relative, incremental, incrementalByChan }
enum	IntFormatT { dec, bin, oct, hex }

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
int	tsSrcServer
int	tsSrcClient
IntFormatT	outTypeI
IntFormatT	outTypeF
int	enumAsNr
int	charArrAsStr
double	caTimeout
char	dblFormatStr []
char	fieldSeparator
capri	caPriority

Macro Definition Documentation

#define DEFAULT_CA_PRIORITY   0 /* Default CA priority */

Definition at line 49 of file tool_lib.h.

#define DEFAULT_TIMEOUT   1.0 /* Default CA timeout */

Definition at line 50 of file tool_lib.h.

#define LINE_BUFFER

(

stream

)

setvbuf(stream, NULL, _IOLBF, BUFSIZ)

Definition at line 53 of file tool_lib.h.

#define sevr_to_str

(

stat

)

Value:

((stat) >= 0 && (stat) <= (signed)lastEpicsAlarmSev) ?  \
        epicsAlarmSeverityStrings[stat] : "??"

Definition at line 31 of file tool_lib.h.

#define sevr_to_str_unsigned

(

stat

)

Value:

((stat) <= lastEpicsAlarmSev) ?         \
        epicsAlarmSeverityStrings[stat] : "??"

Definition at line 39 of file tool_lib.h.

#define stat_to_str

(

stat

)

Value:

((stat) >= 0 && (stat) <= (signed)lastEpicsAlarmCond) ? \
        epicsAlarmConditionStrings[stat] : "??"

Definition at line 27 of file tool_lib.h.

#define stat_to_str_unsigned

(

stat

)

Value:

((stat) <= lastEpicsAlarmCond) ?        \
        epicsAlarmConditionStrings[stat] : "??"

Definition at line 35 of file tool_lib.h.

Enumeration Type Documentation

enum IntFormatT

Enumerator
dec
bin
oct
hex

Definition at line 64 of file tool_lib.h.

{ dec, bin, oct, hex } IntFormatT;

enum TimeT

Enumerator
absolute
relative
incremental
incrementalByChan

Definition at line 61 of file tool_lib.h.

{ absolute, relative, incremental, incrementalByChan } TimeT;

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

Definition at line 56 of file tool_lib.c.

double caTimeout

Definition at line 55 of file tool_lib.c.

int charArrAsStr

Definition at line 54 of file tool_lib.c.

char dblFormatStr[]

Definition at line 49 of file tool_lib.c.

int enumAsNr

Definition at line 53 of file tool_lib.c.

char fieldSeparator

Definition at line 51 of file tool_lib.c.

IntFormatT outTypeF

Definition at line 47 of file tool_lib.c.

IntFormatT outTypeI

Definition at line 46 of file tool_lib.c.

int tsSrcClient

Definition at line 45 of file tool_lib.c.

int tsSrcServer

Definition at line 44 of file tool_lib.c.

TimeT tsType

Definition at line 43 of file tool_lib.c.