Helper Class Reference

#include <helper.h>

Inheritance diagram for Helper:

List of all members.

Public Member Functions
	Helper ()
void	removeLeadingAndTrailingSpacesDbrString (const char *_pv, char pvStripped[MAX_STRING_SIZE])
	Removes leading and trailing blanks.
void	removeLeadingAndTrailingSpacesPseudo (const char *_pv, char pvStripped[PVGROUP_PSEUDO_SIZE])
	Removes leading and trailing blanks.
void	removeLeadingAndTrailingSpaces (const char *_pv, char pvStripped[PVNAME_SIZE])
	Removes leading and trailing blanks.
unsigned int	convertToUniqueNumber (const char *pv, ca_client_context *ccc, unsigned int ghs)
	Produces a unique identifier from the pvName, ca_client_context, group handle size for entry into hash table.
unsigned int	convertToUniqueNumber (const char *pv, ca_client_context *ccc)
	Produces a unique identifier from the pvName and ca_client_context for entry into hash table.
CAFENUM::DBR_TYPE	convertToCAFEDbrTypeClass (const chtype _chtype) const
	enum CAFENUM::DBR_TYPE {DBR_PRIMITIVE=333,DBR_STS,DBR_TIME, DBR_GR,DBR_CTRL,DBR_NONE}; Extracts the CAFENUM::DBR_TYPE from the channel type
std::string	concatToString (dbr_char_t *inChar, unsigned int nChar)
	Concatinates dbr_char_t(unsigned char) into a string.

---

Constructor & Destructor Documentation

Helper::Helper

(

)

[inline]

---

Member Function Documentation

std::string Helper::concatToString	(	dbr_char_t *	inpChar,
		unsigned int	nChar
	)

Concatinates dbr_char_t(unsigned char) into a string.

Parameters:

	inpChar	input: Array of dbr_char_t data types
	nChar	input: size of array

Returns:

std:string The concatinated string

CAFENUM::DBR_TYPE Helper::convertToCAFEDbrTypeClass

(

const chtype

_chtype

)

const

enum CAFENUM::DBR_TYPE {DBR_PRIMITIVE=333,DBR_STS,DBR_TIME, DBR_GR,DBR_CTRL,DBR_NONE};
Extracts the CAFENUM::DBR_TYPE from the channel type

Parameters:

_chtype

input: channel type

Returns:

CAFENUM::DBR_TYPE

References CAFENUM::DBR_CLASS, CAFENUM::DBR_CTRL, CAFENUM::DBR_GR, CAFENUM::DBR_NONE, CAFENUM::DBR_PRIMITIVE, CAFENUM::DBR_PUT, CAFENUM::DBR_STS, CAFENUM::DBR_STSACK, and CAFENUM::DBR_TIME.

Referenced by Granules::channelVerifyGet(), Granules::channelVerifyGetCtrl(), Granules::channelVerifyPut(), Conduit::getPVCtrlHolder(), Conduit::getPVDataHolder(), and change_eventHandlerArgs::operator()().

unsigned int Helper::convertToUniqueNumber	(	const char *	pv,
		ca_client_context *	ccc
	)

Produces a unique identifier from the pvName and ca_client_context for entry into hash table.

Parameters:

	pv	input: process variable name
	ccc	input: current context

Returns:

unique identifier

References int.

unsigned int Helper::convertToUniqueNumber	(	const char *	pv,
		ca_client_context *	ccc,
		unsigned int	ghs
	)

Produces a unique identifier from the pvName, ca_client_context, group handle size
for entry into hash table.

Parameters:

	pv	input: process variable name
	ccc	input: current context
	ghs	input: size of gs (group handle set)

Returns:

unique identifier

References int.

void Helper::removeLeadingAndTrailingSpaces	(	const char *	pv,
		char	pvStripped[PVNAME_SIZE]
	)

Removes leading and trailing blanks.

Parameters:

	pv	input: process variable name
	pvStripped	output: process variable name stripped of forward and trailing spaces

Referenced by Connect::collectionFetch(), Connect::collectionMemberList(), Connect::fetchIndexOfCollectionMember(), Connect::fetchIndexOfGroupMember(), HandleHelper::getContextFromPV(), PVCtrlHolder::getEnumFromString(), HandleHelper::getHandleFromPV(), HandleHelper::getHandleFromPVAlias(), HandleHelper::getHandleFromPVWithinGroup(), MemberMap::getIndex(), deviceCollection::getPosition(), Connect::groupCombine(), Connect::groupDefine(), Connect::groupMemberList(), Connect::isCollection(), Connect::isGroup(), Instant< dbr_short_t >::setAndGetDbrString(), Instant< dbr_short_t >::setAndGetString(), and Connect::setPVAlias().

void Helper::removeLeadingAndTrailingSpacesDbrString	(	const char *	pv,
		char	pvStripped[MAX_STRING_SIZE]
	)

Removes leading and trailing blanks.

Parameters:

	pv	input: process variable name
	pvStripped	output: process variable name stripped of forward and trailing spaces

void Helper::removeLeadingAndTrailingSpacesPseudo	(	const char *	pv,
		char	pvStripped[PVGROUP_PSEUDO_SIZE]
	)

Removes leading and trailing blanks.

Parameters:

	pv	input: process variable name
	pvStripped	output: process variable name stripped of forward and trailing spaces

Referenced by Connect::getPVData().

---

The documentation for this class was generated from the following files:

• helper.h
• helper.cpp