ISIS Logo
NetShrVar
An EPICS support module to export National Instruments Network Shared Variables as process variables
Functions | Variables
NetShrVarDriver.cpp File Reference

Implementation of NetShrVarDriver class and NetShrVarConfigure() iocsh command. More...

#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <errno.h>
#include <math.h>
#include <exception>
#include <iostream>
#include <shareLib.h>
#include <epicsTypes.h>
#include <epicsTime.h>
#include <epicsThread.h>
#include <epicsString.h>
#include <epicsTimer.h>
#include <epicsMutex.h>
#include <epicsEvent.h>
#include <errlog.h>
#include <iocsh.h>
#include <alarm.h>
#include <epicsExport.h>
#include "convertToString.h"
#include "NetShrVarInterface.h"
#include "NetShrVarDriver.h"

Go to the source code of this file.

Functions

int NetShrVarConfigure (const char *portName, const char *configSection, const char *configFile, int pollPeriod, int options)
 EPICS iocsh callable function to call constructor of NetShrVarInterface(). More...
 
static void initCallFunc (const iocshArgBuf *args)
 
static void NetShrVarRegister (void)
 Register new commands with EPICS IOC shell. More...
 
 epicsExportRegistrar (NetShrVarRegister)
 

Variables

static const char * driverName ="NetShrVarDriver"
 Name of driver for use in message printing. More...
 
static const iocshArg initArg0 = { "portName", iocshArgString}
 The name of the asyn driver port we will create. More...
 
static const iocshArg initArg1 = { "configSection", iocshArgString}
 section name of configFile to use to configure this asyn port More...
 
static const iocshArg initArg2 = { "configFile", iocshArgString}
 Path to the XML input file to load configuration information from. More...
 
static const iocshArg initArg3 = { "pollPeriod", iocshArgInt}
 poll period (ms) for BufferedReaders More...
 
static const iocshArg initArg4 = { "options", iocshArgInt}
 options as per NetShrVarOptions enum More...
 
static const iocshArg *const initArgs []
 
static const iocshFuncDef initFuncDef = {"NetShrVarConfigure", sizeof(initArgs) / sizeof(iocshArg*), initArgs}
 

Detailed Description

Implementation of NetShrVarDriver class and NetShrVarConfigure() iocsh command.

Author
Freddie Akeroyd, STFC ISIS Facility, GB

Definition in file NetShrVarDriver.cpp.

Function Documentation

epicsExportRegistrar ( NetShrVarRegister  )
static void initCallFunc ( const iocshArgBuf *  args)
static

Definition at line 475 of file NetShrVarDriver.cpp.

References NetShrVarConfigure().

Referenced by NetShrVarRegister().

int NetShrVarConfigure ( const char *  portName,
const char *  configSection,
const char *  configFile,
int  pollPeriod,
int  options 
)

EPICS iocsh callable function to call constructor of NetShrVarInterface().

The function is registered via NetShrVarRegister().

Parameters
[in]portNameThe name of the asyn driver port we will create.
[in]configSectionsection name of configFile to use to configure this asyn port
[in]configFilePath to the XML input file to load configuration information from.
[in]pollPeriodpoll period (ms) for BufferedReaders
[in]optionsoptions as per NetShrVarOptions enum
Examples:
NetShrVarConfig.xsd, netvarconfig.xml, and st.cmd.

Definition at line 435 of file NetShrVarDriver.cpp.

Referenced by initCallFunc().

static void NetShrVarRegister ( void  )
static

Register new commands with EPICS IOC shell.

Definition at line 481 of file NetShrVarDriver.cpp.

References initCallFunc().

Variable Documentation

const char* driverName ="NetShrVarDriver"
static
const iocshArg initArg0 = { "portName", iocshArgString}
static

The name of the asyn driver port we will create.

Definition at line 461 of file NetShrVarDriver.cpp.

const iocshArg initArg1 = { "configSection", iocshArgString}
static

section name of configFile to use to configure this asyn port

Definition at line 462 of file NetShrVarDriver.cpp.

const iocshArg initArg2 = { "configFile", iocshArgString}
static

Path to the XML input file to load configuration information from.

Definition at line 463 of file NetShrVarDriver.cpp.

const iocshArg initArg3 = { "pollPeriod", iocshArgInt}
static

poll period (ms) for BufferedReaders

Definition at line 464 of file NetShrVarDriver.cpp.

const iocshArg initArg4 = { "options", iocshArgInt}
static

options as per NetShrVarOptions enum

Definition at line 465 of file NetShrVarDriver.cpp.

const iocshArg* const initArgs[]
static
Initial value:
= { &initArg0,
static const iocshArg initArg2
Path to the XML input file to load configuration information from.
static const iocshArg initArg0
The name of the asyn driver port we will create.
static const iocshArg initArg4
options as per NetShrVarOptions enum
static const iocshArg initArg1
section name of configFile to use to configure this asyn port
static const iocshArg initArg3
poll period (ms) for BufferedReaders

Definition at line 467 of file NetShrVarDriver.cpp.

const iocshFuncDef initFuncDef = {"NetShrVarConfigure", sizeof(initArgs) / sizeof(iocshArg*), initArgs}
static

Definition at line 473 of file NetShrVarDriver.cpp.

Copyright © 2013 Science and Technology Facilities Council | Generated by   doxygen 1.8.5