ISIS Logo
NetShrVar
An EPICS support module to export National Instruments Network Shared Variables as process variables
Public Types | Public Member Functions | Public Attributes | List of all members
NvItem Struct Reference

details about a network shared variable we have connected to an asyn parameter More...

Public Types

enum  {
  Read =0x1, Write =0x2, BufferedRead =0x4, BufferedWrite =0x8,
  SingleRead =0x10
}
 

Public Member Functions

 NvItem (const std::string &nv_name_, const char *type_, unsigned access_, int field_, const std::string &ts_param_, bool with_ts_)
 
void report (const std::string &name, FILE *fp)
 helper for asyn driver report function More...
 
void report (FILE *fp, const char *conn_type, void *handle, bool buffered)
 

Public Attributes

enum NvItem:: { ... }  NvAccessMode
 possible access modes to network shared variable More...
 
std::string nv_name
 full path to network shared variable More...
 
std::string type
 type as specified in the XML file e.g. float64array More...
 
unsigned access
 combination of NvAccessMode More...
 
int field
 if we refer to a struct, this is the index of the field (starting at 0), otherwise it is -1 More...
 
int id
 asyn parameter id, -1 if not assigned More...
 
std::string ts_param
 parameter that is timestamp source More...
 
bool with_ts
 timestamp is encoded in first few array elements More...
 
bool connected_alarm
 
std::vector< char > array_data
 only used for array parameters, contains cached copy of data as this is not stored in usual asyn parameter map More...
 
CNVSubscriber subscriber
 
CNVBufferedSubscriber b_subscriber
 
CNVWriter writer
 
CNVReader reader
 
CNVBufferedWriter b_writer
 
epicsTimeStamp epicsTS
 timestamp of shared variable update More...
 

Detailed Description

details about a network shared variable we have connected to an asyn parameter

Definition at line 141 of file NetShrVarInterface.cpp.

Member Enumeration Documentation

anonymous enum
Enumerator
Read 
Write 
BufferedRead 
BufferedWrite 
SingleRead 

Definition at line 143 of file NetShrVarInterface.cpp.

Constructor & Destructor Documentation

NvItem::NvItem ( const std::string &  nv_name_,
const char *  type_,
unsigned  access_,
int  field_,
const std::string &  ts_param_,
bool  with_ts_ 
)
inline

Definition at line 159 of file NetShrVarInterface.cpp.

References epicsTS, and nv_name.

Member Function Documentation

void NvItem::report ( const std::string &  name,
FILE *  fp 
)
inline

helper for asyn driver report function

Definition at line 166 of file NetShrVarInterface.cpp.

References array_data, b_subscriber, b_writer, epicsTS, field, nv_name, reader, subscriber, type, and writer.

Referenced by NetShrVarInterface::report().

void NvItem::report ( FILE *  fp,
const char *  conn_type,
void *  handle,
bool  buffered 
)
inline

Definition at line 189 of file NetShrVarInterface.cpp.

References connectionStatus(), and ERROR_CHECK.

Member Data Documentation

unsigned NvItem::access
std::vector<char> NvItem::array_data

only used for array parameters, contains cached copy of data as this is not stored in usual asyn parameter map

Definition at line 152 of file NetShrVarInterface.cpp.

Referenced by NetShrVarInterface::readArrayValue(), and report().

CNVBufferedSubscriber NvItem::b_subscriber
CNVBufferedWriter NvItem::b_writer
bool NvItem::connected_alarm

Definition at line 151 of file NetShrVarInterface.cpp.

Referenced by NetShrVarInterface::connectVars().

epicsTimeStamp NvItem::epicsTS

timestamp of shared variable update

Definition at line 158 of file NetShrVarInterface.cpp.

Referenced by NvItem(), and report().

int NvItem::field

if we refer to a struct, this is the index of the field (starting at 0), otherwise it is -1

Definition at line 147 of file NetShrVarInterface.cpp.

Referenced by report(), NetShrVarInterface::setValueCNV(), and NetShrVarInterface::updateParamCNV().

int NvItem::id
std::string NvItem::nv_name
enum { ... } NvItem::NvAccessMode

possible access modes to network shared variable

CNVReader NvItem::reader
CNVSubscriber NvItem::subscriber

Definition at line 153 of file NetShrVarInterface.cpp.

Referenced by NetShrVarInterface::connectVars(), and report().

std::string NvItem::ts_param

parameter that is timestamp source

Definition at line 149 of file NetShrVarInterface.cpp.

std::string NvItem::type

type as specified in the XML file e.g. float64array

Definition at line 145 of file NetShrVarInterface.cpp.

Referenced by NetShrVarInterface::initAsynParamIds(), report(), and NetShrVarInterface::updateParamCNV().

bool NvItem::with_ts

timestamp is encoded in first few array elements

Definition at line 150 of file NetShrVarInterface.cpp.

CNVWriter NvItem::writer

The documentation for this struct was generated from the following file:
Copyright © 2013 Science and Technology Facilities Council | Generated by   doxygen 1.8.5