defines.h File Reference

#include <cadef.h>
#include <iostream>

Go to the source code of this file.

Classes
struct	etsDate
struct	etsNorm
Defines
#define	EV   EPICSVERSION(HAVE_EPICS)
#define	MASK_CTRL   DBE_VALUE | DBE_LOG | DBE_ALARM | DBE_PROPERTY
Typedefs
typedef void(*	pCallback )(struct event_handler_args ARGS)
typedef void(*	pCallbackConnection )(struct connection_handler_args ARGS)
typedef char	pv_string_t [PVNAME_SIZE]
Variables
const unsigned short	ALARM_SEVERITY_STRING_LENGTH = 4
const unsigned short	ALARM_STATUS_STRING_LENGTH = 22
const bool	ADD_EXCEPTION_EVENT = false
const short	PVNAME_SIZE = MAX_STRING_SIZE +20
const short	PVGROUP_PSEUDO_SIZE = 1024
const std::string	DEFAULT_DEVICE_ATTRIBUTE_DELIMINATOR = ":"
const bool	DEFAULT_SELF_GOVERNING_TIMEOUT = true
const double	DEFAULT_TIMEOUT_PEND_IO_WF = 5.0
const double	TIMEOUT_PEND_IO_MIN = 0.0001
const double	TIMEOUT_PEND_IO_MAX = 20.0
const unsigned short	DEFAULT_PEND_IO_NO_TRIES = 2
const unsigned short	PEND_IO_MAX_TRIES = 10
const double	DEFAULT_PEND_IO_INCREMENT_TIME = 2.0
const double	PEND_IO_INCREMENT_TIME_MIN = 0.05
const double	PEND_IO_INCREMENT_TIME_MAX = 10.0
const double	DEFAULT_TIMEOUT_PEND_EVENT = 0.4
const double	DEFAULT_TIMEOUT_PEND_IO = 0.4
const double	DEFAULT_TIMEOUT_SG_PEND_EVENT = 0.5
const double	NMEMBER_PER_SEC_SG_PEND_EVENT = 400
const double	DEFAULT_TIMEOUT_SG_PEND_IO = 5.0
const unsigned int	MAX_NELEM_FOR_CTRL_BUFFER = 8192
const unsigned int	MAX_NELEM_FOR_STSACK_BUFFER = 1
const unsigned int	DEFAULT_NELEM_FOR_CTRL_BUFFER = 256
const unsigned int	DEFAULT_NELEM_FOR_STSACK_BUFFER = 1
const unsigned short	MAX_NO_MONITORS_PER_CHANNEL = 4
const double	BSREAD_MAX_CONNECT_TIME = 20
const unsigned short	BSREAD_ZEROMQ_HIGH_WATER_MARK = 1
const short	BSREAD_ZEROMQ_TIMEOUT_MS = 2000
const unsigned short	BSREAD_PREBLOB_BYTES = 12
const std::string	SF_PULSE_ID_PV = "SIN-TIMAST-EVG0:TX-PULSEID"
const unsigned short	SF_PULSE_ID_BUFFER_SIZE = 10

---

Detailed Description

Author:

Jan Chrin, PSI

Date:

Release: February 2015

Version:

CAFE 1.0.0

---

Define Documentation

#define EV   EPICSVERSION(HAVE_EPICS)

#define MASK_CTRL   DBE_VALUE | DBE_LOG | DBE_ALARM | DBE_PROPERTY

---

Typedef Documentation

typedef void(* pCallback)(struct event_handler_args ARGS)

Define pCallback

typedef void(* pCallbackConnection)(struct connection_handler_args ARGS)

typedef char pv_string_t[PVNAME_SIZE]

---

Variable Documentation

const bool ADD_EXCEPTION_EVENT = false

Referenced by Connect::createChannel(), and Connect::createChannelWithinGroup().

const unsigned short ALARM_SEVERITY_STRING_LENGTH = 4

Referenced by Conduit::getAlarmSeverityAsString().

const unsigned short ALARM_STATUS_STRING_LENGTH = 22

Referenced by Conduit::getAlarmStatusAsString().

const double BSREAD_MAX_CONNECT_TIME = 20

const unsigned short BSREAD_PREBLOB_BYTES = 12

Referenced by CAFE_BSHELPER::bitshuffleDecompress().

const unsigned short BSREAD_ZEROMQ_HIGH_WATER_MARK = 1

Referenced by CAFEBS::BSDataHolder::BSDataHolder().

const short BSREAD_ZEROMQ_TIMEOUT_MS = 2000

Referenced by CAFEBS::BSDataHolder::BSDataHolder().

const std::string DEFAULT_DEVICE_ATTRIBUTE_DELIMINATOR = ":"

Referenced by Conduit::Conduit(), and Connect::Connect().

const unsigned int DEFAULT_NELEM_FOR_CTRL_BUFFER = 256

Referenced by change_connectionHandlerArgs::operator()().

const unsigned int DEFAULT_NELEM_FOR_STSACK_BUFFER = 1

Referenced by change_connectionHandlerArgs::operator()().

const double DEFAULT_PEND_IO_INCREMENT_TIME = 2.0

const unsigned short DEFAULT_PEND_IO_NO_TRIES = 2

const bool DEFAULT_SELF_GOVERNING_TIMEOUT = true

Default configuration parameters. Recall that if pend_event is too short
then create callback function will still be called after the specified period

const double DEFAULT_TIMEOUT_PEND_EVENT = 0.4

Referenced by ChannelOpenPolicy::ChannelOpenPolicy(), and Connect::Connect().

const double DEFAULT_TIMEOUT_PEND_IO = 0.4

Referenced by Connect::Connect(), PolicyHelper::getTimeoutMax(), and PolicyHelper::getTimeoutMin().

const double DEFAULT_TIMEOUT_PEND_IO_WF = 5.0

Referenced by change_connectionHandlerArgs::operator()().

const double DEFAULT_TIMEOUT_SG_PEND_EVENT = 0.5

Referenced by Connect::Connect().

const double DEFAULT_TIMEOUT_SG_PEND_IO = 5.0

Referenced by ConduitGroup::ConduitGroup(), PolicyHelper::getSGTimeoutMax(), and PolicyHelper::getSGTimeoutMin().

const unsigned int MAX_NELEM_FOR_CTRL_BUFFER = 8192

Referenced by Granules::channelPrepareGetCtrl(), change_connectionHandlerArgs::operator()(), HandleHelper::setNelemCtrl(), and HandleHelper::setNelemToRetrieveFromCtrlCache().

const unsigned int MAX_NELEM_FOR_STSACK_BUFFER = 1

Referenced by change_connectionHandlerArgs::operator()().

const unsigned short MAX_NO_MONITORS_PER_CHANNEL = 4

Referenced by Connect::monitorStart(), and change_monitorPolicyInsert::operator()().

const double NMEMBER_PER_SEC_SG_PEND_EVENT = 400

Referenced by Connect::groupOpen().

const double PEND_IO_INCREMENT_TIME_MAX = 10.0

Referenced by ChannelTimeoutPolicy::setDeltaTimeout().

const double PEND_IO_INCREMENT_TIME_MIN = 0.05

Referenced by ChannelTimeoutPolicy::setDeltaTimeout().

const unsigned short PEND_IO_MAX_TRIES = 10

Referenced by ChannelTimeoutPolicy::setNtries().

const short PVGROUP_PSEUDO_SIZE = 1024

Referenced by Connect::getPVData().

const short PVNAME_SIZE = MAX_STRING_SIZE +20

Size of char * array to hold pv and pvAlias names

Referenced by CAFEBS::BSChannel::BSChannel(), Connect::callbackHandlerException(), Connect::collectionFetch(), Connect::collectionMemberList(), Connect::devicePositionMap(), Connect::devicePositionOrderedMultiMap(), Connect::devicePositionV(), Connect::fetchIndexOfCollectionMember(), Connect::fetchIndexOfGroupMember(), CAFEBS::BSDataHolder::getAttributeAsDoubleV(), HandleHelper::getContextFromPV(), HandleHelper::getHandleFromPV(), HandleHelper::getHandleFromPVAlias(), HandleHelper::getHandleFromPVWithinGroup(), HandleHelper::getHandlesFromPVs(), MemberMap::getIndex(), deviceCollection::getPosition(), Connect::groupCombine(), Connect::groupDefine(), Connect::groupMemberList(), Connect::isCollection(), Connect::isGroup(), Connect::open(), and Connect::setPVAlias().

const unsigned short SF_PULSE_ID_BUFFER_SIZE = 10

Referenced by Conduit::Conduit().

const std::string SF_PULSE_ID_PV = "SIN-TIMAST-EVG0:TX-PULSEID"

Referenced by MonitorPolicy::callbackHandlerMonitor(), Connect::monitorPulseID(), and Connect::monitorStopPulseID().

const double TIMEOUT_PEND_IO_MAX = 20.0

Referenced by PolicyHelper::getSGTimeoutMin(), PolicyHelper::getTimeoutMin(), and ChannelTimeoutPolicy::setTimeout().

const double TIMEOUT_PEND_IO_MIN = 0.0001

Referenced by PolicyHelper::getSGTimeoutMax(), PolicyHelper::getTimeoutMax(), and ChannelTimeoutPolicy::setTimeout().