Transpose< CTYPE > Class Template Reference

#include <transpose.h>

List of all members.

Public Member Functions

 Transpose ()
 ~Transpose ()
int put (const unsigned int _handle, const CTYPE *val, const chtype cdt)
 Transforms data from CTYPE * val to PutBuffer.
int put (const unsigned int _handle, CAFE_DATATYPE_UNION_SEQ val, CAFE_DATATYPE cdt)
int putString (const unsigned int _handle, dbr_string_t *val)
int get (const unsigned int _handle, CTYPE *val, dbr_short_t &alarmStatus, dbr_short_t &alarmSeverity, epicsTimeStamp &ts, bool isCacheRequest)
 Retrieves data transmitted by CA with dbrTypeRequest_DataBuffer and then converts to CTYPE i.e. _dataTypeClient.
int get (const unsigned int _handle, CTYPE *val, dbr_short_t &alarmStatus, dbr_short_t &alarmSeverity, bool isCacheRequest)
int get (const unsigned int _handle, CTYPE *val, bool isCacheRequest)
int getCtrl (const unsigned int _handle, CTYPE *val, dbr_short_t &alarmStatus, dbr_short_t &alarmSeverity, dbr_short_t &precision, CTYPE &RISC_pad, CTYPE &upperDispLimit, CTYPE &lowerDispLimit, CTYPE &upperAlarmLimit, CTYPE &upperWarningLimit, CTYPE &lowerWarningLimit, CTYPE &lowerAlarmLimit, CTYPE &upperCtrlLimit, CTYPE &lowerCtrlLimit, char units[MAX_UNITS_SIZE], short &noStr, char strs[MAX_ENUM_STATES][MAX_ENUM_STRING_SIZE], bool isCacheRequest)
 Retrieves ctrl data from buffer.

Public Attributes

HandleHelper handleHelper

Private Attributes

CTYPE * val
int status
CAFEStatus cafeStatus
CAFEDataTypeCode cafeDataTypeCode
union db_access_val * PVDataL
unsigned int nelem
unsigned int offset
chtype dbrTypeRequest_DataBuffer
chtype dbrTypeRequest_CtrlBuffer
chtype _dataTypeClient
char stig [MAX_ENUM_STATES][MAX_ENUM_STRING_SIZE]

Detailed Description

template<class CTYPE>
class Transpose< CTYPE >

Transpose Template
CTYPE is the type of data to be rendered to/from the client
method get() will receive data transmitted by CA with dataTypeRequest
and then convert to CTYPE method getString() will receive data transmitted by CA with dataTypeRequest
and then convert to a string method put() will convert data of type CTYPE to the native type
and then transmit to CA method putString() will convert a string type to the native type
and then transmit to CA

Constructor & Destructor Documentation

template<class CTYPE>
Transpose< CTYPE >::Transpose (  )  [inline]
template<class CTYPE>
Transpose< CTYPE >::~Transpose (  )  [inline]

Member Function Documentation

template<class CTYPE>
int Transpose< CTYPE >::get ( const unsigned int  _handle,
CTYPE *  val,
bool  isCacheRequest 
) [inline]
template<class CTYPE>
int Transpose< CTYPE >::get ( const unsigned int  _handle,
CTYPE *  val,
dbr_short_t &  alarmStatus,
dbr_short_t &  alarmSeverity,
bool  isCacheRequest 
) [inline]
template<class CTYPE>
int Transpose< CTYPE >::get ( const unsigned int  _handle,
CTYPE *  val,
dbr_short_t &  alarmStatus,
dbr_short_t &  alarmSeverity,
epicsTimeStamp &  ts,
bool  isCacheRequest 
) [inline]

Retrieves data transmitted by CA with dbrTypeRequest_DataBuffer and then converts to CTYPE i.e. _dataTypeClient.

Parameters:
_handle input: handle to Conduit object
val output: CTYPE datatype
alarmStatus output: dbr_short_t
alarmSeverity output: dbr_short_t
ts output: epicsTimeStamp
isCacheRequest input: bool
Returns:
ICAFE_NORMAL as local data conversion should not incur an error

References __METHOD__, Transpose< CTYPE >::_dataTypeClient, Transpose< CTYPE >::cafeStatus, cs, Transpose< CTYPE >::dbrTypeRequest_DataBuffer, ECAFE_INVALID_HANDLE, ECAFE_INVALID_SWITCH_CASE, Transpose< CTYPE >::handleHelper, ICAFE_NORMAL, Transpose< CTYPE >::nelem, Transpose< CTYPE >::offset, Transpose< CTYPE >::PVDataL, CAFEStatus::report(), and HandleHelper::setSTS().

Referenced by Instant< CTYPE >::clientRequests().

template<class CTYPE>
int Transpose< CTYPE >::getCtrl ( const unsigned int  _handle,
CTYPE *  val,
dbr_short_t &  alarmStatus,
dbr_short_t &  alarmSeverity,
dbr_short_t &  precision,
CTYPE &  RISC_pad,
CTYPE &  upperDispLimit,
CTYPE &  lowerDispLimit,
CTYPE &  upperAlarmLimit,
CTYPE &  upperWarningLimit,
CTYPE &  lowerWarningLimit,
CTYPE &  lowerAlarmLimit,
CTYPE &  upperCtrlLimit,
CTYPE &  lowerCtrlLimit,
char  units[MAX_UNITS_SIZE],
short &  noStr,
char  strs[MAX_ENUM_STATES][MAX_ENUM_STRING_SIZE],
bool  isCacheRequest 
) [inline]

Retrieves ctrl data from buffer.

Parameters:
_handle input: handle to Conduit Object
val output: CTYPE
alarmStatus output: dbr_short_t
alarmSeverity output: dbr_short_t
precision output: dbr_short_t
RISC_pad deprecated!
upperDispLimit output
lowerDispLimit output
upperAlarmLimit output
upperWarningLimit output
lowerWarningLimit output
lowerAlarmLimit output
upperCtrlLimit output
lowerCtrlLimit output
units output: units
noStr output: No of ENUM Choices
strs output: ENUM Choices
isCacheRequest input: bool true or false
Returns:
ICAFE_NORMAL

References __METHOD__, Transpose< CTYPE >::_dataTypeClient, Transpose< CTYPE >::cafeStatus, cs, Transpose< CTYPE >::dbrTypeRequest_CtrlBuffer, ECAFE_INVALID_HANDLE, ECAFE_INVALID_SWITCH_CASE, ICAFE_NORMAL, Transpose< CTYPE >::nelem, Transpose< CTYPE >::offset, Transpose< CTYPE >::PVDataL, and CAFEStatus::report().

template<class CTYPE>
int Transpose< CTYPE >::put ( const unsigned int  _handle,
CAFE_DATATYPE_UNION_SEQ  val,
CAFE_DATATYPE  cdt 
) [inline]

Transforms data from CAFE_DATATYPE_UNION_SEQ to PutBuffer

Parameters:
_handle input: Conduit object
val input: CAFE_DATATYPE_UNION_SEQ
cdt input: CAFE_DATATYPE
Returns:
ICAFE_NORMAL as local data conversion should not incur an error

References __METHOD__, CAFE_CHAR, CAFE_DOUBLE, CAFE_ENUM, CAFE_FLOAT, CAFE_LONG, CAFE_SHORT, CAFE_STRING, Transpose< CTYPE >::cafeDataTypeCode, Transpose< CTYPE >::cafeStatus, CAFE_DATATYPE_UNION::ch, cs, CAFE_DATATYPE_UNION::d, Transpose< CTYPE >::dbrTypeRequest_DataBuffer, ECAFE_INVALID_ENUM_INDEX, ECAFE_INVALID_HANDLE, ECAFE_INVALID_SWITCH_CASE, CAFE_DATATYPE_UNION::f, ICAFE_NORMAL, CAFE_DATATYPE_UNION::l, CAFEDataTypeCode::message(), Transpose< CTYPE >::nelem, Transpose< CTYPE >::putString(), Transpose< CTYPE >::PVDataL, CAFEStatus::report(), CAFE_DATATYPE_UNION::s, Transpose< CTYPE >::status, Transpose< CTYPE >::stig, and CAFE_DATATYPE_UNION::us.

template<class CTYPE>
int Transpose< CTYPE >::put ( const unsigned int  _handle,
const CTYPE *  val,
const chtype  _dbrType 
) [inline]

Transforms data from CTYPE * val to PutBuffer.

Parameters:
_handle input: Conduit object
val input: CTYPE datatype
_dbrType input: chtype
Returns:
ICAFE_NORMAL as local data conversion should not incur an error

References __METHOD__, CAFE_CHAR, CAFE_DOUBLE, CAFE_ENUM, CAFE_FLOAT, CAFE_LONG, CAFE_SHORT, CAFE_STRING, Transpose< CTYPE >::cafeDataTypeCode, Transpose< CTYPE >::cafeStatus, cs, Transpose< CTYPE >::dbrTypeRequest_DataBuffer, ECAFE_INVALID_ENUM_INDEX, ECAFE_INVALID_HANDLE, ECAFE_INVALID_SWITCH_CASE, ICAFE_NORMAL, CAFEDataTypeCode::message(), Transpose< CTYPE >::nelem, Transpose< CTYPE >::putString(), Transpose< CTYPE >::PVDataL, CAFEStatus::report(), Transpose< CTYPE >::status, and Transpose< CTYPE >::stig.

Referenced by Instant< CTYPE >::clientRequests(), CAFE::groupSet(), and CAFE::set().

template<class CTYPE >
int Transpose< CTYPE >::putString ( const unsigned int  _handle,
dbr_string_t *  val 
) [inline]

Converts data from CTYPE to native type in preparation for transmission to CA Server

Parameters:
_handle input: handel to Conduit object
val input: Array of values of datatype dbr_string_t
Returns:
ICAFE_NORMAL else ECAFE_NO_CONVERT

References __METHOD__, cs, ECAFE_INVALID_ENUM_INDEX, ECAFE_INVALID_HANDLE, ECAFE_NO_CONVERT, and ICAFE_NORMAL.

Referenced by Transpose< CTYPE >::put().

Member Data Documentation

template<class CTYPE>
chtype Transpose< CTYPE >::_dataTypeClient [private]

Referenced by Transpose< CTYPE >::get(), and Transpose< CTYPE >::getCtrl().

template<class CTYPE>
CAFEDataTypeCode Transpose< CTYPE >::cafeDataTypeCode [private]

Referenced by Transpose< CTYPE >::put().

template<class CTYPE>
CAFEStatus Transpose< CTYPE >::cafeStatus [private]

Referenced by Transpose< CTYPE >::get(), Transpose< CAFE_DATATYPE_UNION >::get(), Transpose< dbr_string_t >::get(), Transpose< CTYPE >::getCtrl(), Transpose< dbr_string_t >::getCtrl(), Transpose< CTYPE >::put(), and Transpose< dbr_string_t >::putString().

template<class CTYPE>
chtype Transpose< CTYPE >::dbrTypeRequest_CtrlBuffer [private]

Referenced by Transpose< CTYPE >::getCtrl(), and Transpose< dbr_string_t >::getCtrl().

template<class CTYPE>
chtype Transpose< CTYPE >::dbrTypeRequest_DataBuffer [private]

Referenced by Transpose< CTYPE >::get(), Transpose< CAFE_DATATYPE_UNION >::get(), Transpose< dbr_string_t >::get(), Transpose< CTYPE >::put(), and Transpose< dbr_string_t >::putString().

template<class CTYPE>
HandleHelper Transpose< CTYPE >::handleHelper

Referenced by Transpose< CTYPE >::get(), Transpose< CAFE_DATATYPE_UNION >::get(), and Transpose< dbr_string_t >::get().

template<class CTYPE>
unsigned int Transpose< CTYPE >::nelem [private]

Referenced by Transpose< CTYPE >::get(), Transpose< CAFE_DATATYPE_UNION >::get(), Transpose< dbr_string_t >::get(), Transpose< CTYPE >::getCtrl(), Transpose< dbr_string_t >::getCtrl(), Transpose< CTYPE >::put(), and Transpose< dbr_string_t >::putString().

template<class CTYPE>
unsigned int Transpose< CTYPE >::offset [private]

Referenced by Transpose< CTYPE >::get(), Transpose< CAFE_DATATYPE_UNION >::get(), Transpose< dbr_string_t >::get(), Transpose< CTYPE >::getCtrl(), and Transpose< dbr_string_t >::getCtrl().

template<class CTYPE>
union db_access_val* Transpose< CTYPE >::PVDataL [write, private]

Referenced by Transpose< CTYPE >::get(), Transpose< CAFE_DATATYPE_UNION >::get(), Transpose< dbr_string_t >::get(), Transpose< CTYPE >::getCtrl(), Transpose< dbr_string_t >::getCtrl(), Transpose< CTYPE >::put(), and Transpose< dbr_string_t >::putString().

template<class CTYPE>
int Transpose< CTYPE >::status [private]

Referenced by Transpose< CTYPE >::put().

template<class CTYPE>
char Transpose< CTYPE >::stig[MAX_ENUM_STATES][MAX_ENUM_STRING_SIZE] [private]

Referenced by Transpose< dbr_string_t >::get(), Transpose< CTYPE >::put(), and Transpose< dbr_string_t >::putString().

template<class CTYPE>
CTYPE* Transpose< CTYPE >::val [private]

Referenced by Transpose< CAFE_DATATYPE_UNION >::get(), Transpose< dbr_string_t >::get(), and Transpose< dbr_short_t >::get().

The documentation for this class was generated from the following file:
Generated on 3 May 2017 for CAFE by  doxygen 1.6.1