PolicyHelper Class Reference

#include <policyHelper.h>

Inheritance diagram for PolicyHelper:
Helper

List of all members.

Public Member Functions

 PolicyHelper ()
 ~PolicyHelper ()
int getChannelGetActionWhenMonitorPolicy (unsigned int _handle, ChannelGetActionWhenMonitorPolicy &awmp)
 PolicyHelper::getChannelGetActionWhenMonitorPolicy
Retrieves ChannelGetActionWhenMonitorPolicy object whose method getWhenKind()
determines if ChannelGetActionWhenMonitorPolicyKind CAFENUM::GET_FROM_CACHE or CAFENUM::GET_FROM_IOC
.
int setChannelGetActionWhenMonitorPolicy (unsigned int _handle, ChannelGetActionWhenMonitorPolicy awmp)
 PolicyHelper::setChannelGetActionWhenMonitorPolicy
Retrieves ChannelGetActionWhenMonitorPolicy object whose method getWhenKind()
determines if ChannelGetActionWhenMonitorPolicyKind CAFENUM::GET_FROM_CACHE CAFENUM::GET_FROM_IOC
.
int setChannelGetActionWhenMonitorPolicy (ChannelGetActionWhenMonitorPolicy awmp)
 PolicyHelper::setChannelGetActionWhenMonitorPolicy
Retrieves ChannelGetActionWhenMonitorPolicy object (for all handles) whose method getWhenKind()
determines if ChannelGetActionWhenMonitorPolicyKind CAFENUM::GET_FROM_CACHE or CAFENUM::GET_FROM_IOC
.
int setChannelGetActionWhenMonitorPolicyAllHandles (ChannelGetActionWhenMonitorPolicy awmp)
int getChannelGetCacheWaitPolicy (unsigned int _handle, ChannelGetCacheWaitPolicy &cwp)
 PolicyHelper::getChannelGetCacheWaitPolicy
Retrieves ChannelGetCacheWaitPolicy object whose method getWhenKind()
determines if ChannelGetCacheWaitPolicyKind CAFENUM::GET_CACHE_NO_WAIT or CAFENUM::GET_CACHE_WAIT
.
int setChannelGetCacheWaitPolicy (unsigned int _handle, ChannelGetCacheWaitPolicy cwp)
 PolicyHelper::setChannelGetCacheWaitPolicy
Sets ChannelGetCacheWaitPolicy object whose method getWhenKind()
determines if ChannelGetCacheWaitPolicyKind CAFENUM::GET_CACHE_NO_CHECK CAFENUM::GET_CACHE_NO_WAIT or CAFENUM::GET_CACHE_WAIT
.
int setChannelGetCacheWaitPolicy (ChannelGetCacheWaitPolicy cwp)
 PolicyHelper::setChannelGetCacheWaitPolicy
Sets the ChannelGetCacheWaitPolicy object (for all handles) whose method getWhenKind()
determines if ChannelGetCacheWaitPolicyKind CAFENUM::GET_CACHE_NO_CEHCK CAFENUM::GET_CACHE_NO_WAIT or CAFENUM::GET_CACHE_WAIT
.
int setChannelGetCacheWaitPolicyAllHandles (ChannelGetCacheWaitPolicy cwp)
int getChannelRequestDataTypePolicy (unsigned int _handle, ChannelRequestDataTypePolicy &crdtp)
 PolicyHelper::getChannelRequestDataTypePolicy
Retrieves ChannelRequestDataTypePolicy object whose method getRequestKind()
determines if ChannelRequestDataTypePolicyKind CAFENUM::NATIVE_DATATYPE or CAFENUM::LOWEST_DATATYPE,
which is the smaller in byte size of type requested and native datatype,
is being used for get/set operations.
int setChannelRequestDataTypePolicy (unsigned int _handle, ChannelRequestDataTypePolicy crdtp)
 PolicyHelper::setChannelRequestDataTypePolicy
.
int setChannelRequestDataTypePolicy (ChannelRequestDataTypePolicy crdtp)
 PolicyHelper::setChannelRequestDataTypePolicy
.
int setChannelRequestDataTypePolicyAllHandles (ChannelRequestDataTypePolicy crdtp)
int getChannelRequestPolicyGet (unsigned int _handle, ChannelRequestPolicy &crpg)
 PolicyHelper::getChannelRequestPolicyGet
.
int setChannelRequestPolicyGet (unsigned int _handle, ChannelRequestPolicy crpg)
 PolicyHelper::setChannelRequestPolicyGet
.
int setChannelRequestPolicyGet (ChannelRequestPolicy crpg)
 PolicyHelper::setChannelRequestPolicyGet
.
int setChannelRequestPolicyGetAllHandles (ChannelRequestPolicy crpg)
int getChannelRequestPolicyPut (unsigned int _handle, ChannelRequestPolicy &crpp)
 PolicyHelper::getChannelRequestPolicyPut
.
int setChannelRequestPolicyPut (unsigned int _handle, ChannelRequestPolicy crpp)
 PolicyHelper::setChannelRequestPolicyPut
.
int setChannelRequestPolicyPut (ChannelRequestPolicy crpp)
 PolicyHelper::setChannelRequestPolicyPut
.
int setChannelRequestPolicyPutAllHandles (ChannelRequestPolicy crpp)
int getChannelTimeoutPolicyGet (unsigned int _handle, ChannelTimeoutPolicy &ctpg)
 PolicyHelper::getChannelTimeoutPolicyGet
.
int setChannelTimeoutPolicyGet (unsigned int _handle, ChannelTimeoutPolicy ctpg)
 PolicyHelper::setChannelTimeoutPolicyGet
.
int getChannelTimeoutPolicyPut (unsigned int _handle, ChannelTimeoutPolicy &ctpp)
 PolicyHelper::getChannelTimeoutPolicyPut
.
int setChannelTimeoutPolicyPut (unsigned int _handle, ChannelTimeoutPolicy ctpp)
 PolicyHelper::setChannelTimeoutPolicyPut
.
int setSelfGoverningTimeout (bool b)
 Allows user to set the policy that governs the corrective adaption of timeouts for put/get operations for all handles.
int setSelfGoverningTimeout (unsigned int _handle, bool b)
 Allows user to set the policy that governs the corrective adaption of timeouts for put/get operations for a given handle.
int setSelfGoverningTimeoutPut (unsigned int _handle, bool p)
 Allows user to set the policy that governs the corrective adaption of timeouts for put operations for a given handle.
int setSelfGoverningTimeoutGet (unsigned int _handle, bool g)
 Allows user to set the policy that governs the corrective adaption of timeouts for get operations for a given handle.
int getSelfGoverningTimeout (unsigned int _handle, bool &p, bool &g)
 Allows user to rerieve the policy that governs the corrective adaption of timeouts for put/get operations for a given handle.
int setSGSelfGoverningTimeout (bool b)
 Allows user to set the policy that governs the corrective adaption of timeouts for SG put/get operations for all group handles.
int setSGSelfGoverningTimeout (unsigned int _handle, bool b)
 Allows user to set the policy that governs the corrective adaption of timeouts for SG put/get operations for a given handle.
int setSGSelfGoverningTimeoutPut (unsigned int _handle, bool p)
 Allows user to set the policy that governs the corrective adaption of timeouts for SG put operations for a given group handle.
int setSGSelfGoverningTimeoutGet (unsigned int _handle, bool g)
 Allows user to set the policy that governs the corrective adaption of timeouts for SG get operations for a given group handle.
int getSGSelfGoverningTimeout (unsigned int _handle, bool &p, bool &g)
 Allows user to retrieve the policy that governs the corrective adaption of timeouts for put/get operations for a given handle.
int getTimeoutRange (double &p, double &p2, double &g, double &g2)
int getTimeoutMin (double &p, double &g)
 Allows user to retrieve minimum timeout for put/get operations.
int getTimeoutMax (double &p, double &g)
 Allows user to retrieve minimum timeout for put/get operations.
int getTimeout (unsigned int _handle, double &p, double &g)
 Allows user to retrieve timeout for put/get operations
.
int getTimeout (unsigned int _handle, double &pg)
int getTimeoutPut (unsigned int _handle, double &p)
int getTimeoutGet (unsigned int _handle, double &g)
int printTimeout ()
 Prints timeout for put/get operations.
int printTimeout (unsigned int _handle)
 Prints timeout for put/get operations for given handle.
int setTimeout (double p, double g)
 Allows user to set timeout for put/get operations (within allowed default min/max values) for all handles.
int setTimeout (double pg)
int setTimeoutPut (double p)
int setTimeoutGet (double g)
int setTimeout (unsigned int _handle, double p, double g)
 Allows user to set timeoout for put/get operations (within allowed default min/max values).
int setTimeout (unsigned int _handle, double pg)
int setTimeoutPut (unsigned int _handle, double p)
int setTimeoutGet (unsigned int _handle, double g)
int setTimeoutToDefault (unsigned int _handle)
 Allows user to reset timeout for put/get operations to default values for given handle.
int setTimeoutToDefault ()
 Allows user to reset timeout for put/get operations to default values for all handles.
int getSGTimeoutRange (double &p, double &p2, double &g, double &g2)
int getSGTimeoutMin (double &p, double &g)
 Allows user to retrieve minimum timeout for SG put/get operations.
int getSGTimeoutMax (double &p, double &g)
 Allows user to retrieve minimum timeout for put/get operations.
int printSGTimeout ()
 Prints timeout for SG put/get operations.
int printSGTimeout (unsigned int _handle)
 Prints timeout for put/get operations for given handle.
int getSGTimeout (unsigned int _handle, double &p, double &g)
 Allows user to retrieve timeout for SG put/get operations
.
int getSGTimeout (unsigned int _handle, double &pg)
int getSGTimeoutPut (unsigned int _handle, double &p)
int getSGTimeoutGet (unsigned int _handle, double &g)
int setSGTimeout (double p, double g)
 Allows user to set timeout for SG put/get operations (within allowed default min/max values) for all handles.
int setSGTimeout (double pg)
int setSGTimeoutPut (double p)
int setSGTimeoutGet (double g)
int setSGTimeout (unsigned int _gHandle, double p, double g)
 Allows user to set timeoout for SG put/get operations (within allowed default min/max values).
int setSGTimeout (unsigned int _gHandle, double pg)
int setSGTimeoutPut (unsigned int _gHandle, double p)
int setSGTimeoutGet (unsigned int _gHandle, double g)
int setSGTimeoutToDefault (unsigned int _handle)
 Allows user to reset synchronous group timeout for put/get operations to default values for given handle.
int setSGTimeoutToDefault ()
 Allows user to reset synchronous group timeout for put/get operations to default values for all group handles.

Private Member Functions

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.

Private Attributes

CAFEStatus cafeStatus
cafeConduit_set::iterator itcs
cafeGroup_set::iterator itgs

Constructor & Destructor Documentation

PolicyHelper::PolicyHelper (  )  [inline]
PolicyHelper::~PolicyHelper (  )  [inline]

Member Function Documentation

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

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 [inherited]
unsigned int Helper::convertToUniqueNumber ( const char *  pv,
ca_client_context *  ccc 
) [inherited]

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 
) [inherited]

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.

int PolicyHelper::getChannelGetActionWhenMonitorPolicy ( unsigned int  _handle,
ChannelGetActionWhenMonitorPolicy awmp 
)

PolicyHelper::getChannelGetActionWhenMonitorPolicy
Retrieves ChannelGetActionWhenMonitorPolicy object whose method getWhenKind()
determines if ChannelGetActionWhenMonitorPolicyKind CAFENUM::GET_FROM_CACHE or CAFENUM::GET_FROM_IOC
.

Parameters:
_handle input: reference handle
awmp output: ChannelGetActionWhenMonitorPolicy object
Returns:
status ICAFE_NORMAL else ECAFE_INVALID_HANDLE

References cs, ECAFE_INVALID_HANDLE, and ICAFE_NORMAL.

Referenced by CAFE::get().

int PolicyHelper::getChannelGetCacheWaitPolicy ( unsigned int  _handle,
ChannelGetCacheWaitPolicy cwp 
)

PolicyHelper::getChannelGetCacheWaitPolicy
Retrieves ChannelGetCacheWaitPolicy object whose method getWhenKind()
determines if ChannelGetCacheWaitPolicyKind CAFENUM::GET_CACHE_NO_WAIT or CAFENUM::GET_CACHE_WAIT
.

Parameters:
_handle input: reference handle
cwp output: ChannelGetCacheWaitPolicy object
Returns:
status ICAFE_NORMAL else ECAFE_INVALID_HANDLE

References cs, ECAFE_INVALID_HANDLE, and ICAFE_NORMAL.

int PolicyHelper::getChannelRequestDataTypePolicy ( unsigned int  _handle,
ChannelRequestDataTypePolicy crdtp 
)

PolicyHelper::getChannelRequestDataTypePolicy
Retrieves ChannelRequestDataTypePolicy object whose method getRequestKind()
determines if ChannelRequestDataTypePolicyKind CAFENUM::NATIVE_DATATYPE or CAFENUM::LOWEST_DATATYPE,
which is the smaller in byte size of type requested and native datatype,
is being used for get/set operations.

Parameters:
_handle input: reference handle
crdtp output: ChannelRequestDataTypePolicy object
Returns:
status ICAFE_NORMAL else ECAFE_INVALID_HANDLE

References cs, ECAFE_INVALID_HANDLE, and ICAFE_NORMAL.

int PolicyHelper::getChannelRequestPolicyGet ( unsigned int  _handle,
ChannelRequestPolicy crpg 
)

PolicyHelper::getChannelRequestPolicyGet
.

Retrieves the Callback Policy for get operations

Parameters:
_handle input: reference handle
crpg output: ChannelRequestPolicyGet object
Returns:
status ICAFE_NORMAL if all OK else ECAFE_INVALID_HANDLE

References cs, ECAFE_INVALID_HANDLE, and ICAFE_NORMAL.

int PolicyHelper::getChannelRequestPolicyPut ( unsigned int  _handle,
ChannelRequestPolicy crpp 
)

PolicyHelper::getChannelRequestPolicyPut
.

Retrieves the Blocking Policy for put operations

Parameters:
_handle input: reference handle
crpp output: ChannelRequestPolicyPut object
Returns:
status ICAFE_NORMAL if all OK

References cs, ECAFE_INVALID_HANDLE, and ICAFE_NORMAL.

Referenced by Instant< CTYPE >::set(), CAFE::set(), Instant< CTYPE >::setAndMatch(), and Instant< CTYPE >::setAndMatchMany().

int PolicyHelper::getChannelTimeoutPolicyGet ( unsigned int  _handle,
ChannelTimeoutPolicy ctpg 
)

PolicyHelper::getChannelTimeoutPolicyGet
.

Retrieves the Timeout Policy for get operations

Parameters:
_handle input: reference handle
ctpg output: ChannelTimeoutPolicyGet object
Returns:
status ICAFE_NORMAL if all OK

References cs, ECAFE_INVALID_HANDLE, and ICAFE_NORMAL.

int PolicyHelper::getChannelTimeoutPolicyPut ( unsigned int  _handle,
ChannelTimeoutPolicy ctpp 
)

PolicyHelper::getChannelTimeoutPolicyPut
.

Retrieves the Timeout Policy for put operations

Parameters:
_handle input: reference handle
ctpp output: ChannelTimeoutPolicyPut object
Returns:
status ICAFE_NORMAL if all OK

References cs, ECAFE_INVALID_HANDLE, and ICAFE_NORMAL.

int PolicyHelper::getSelfGoverningTimeout ( unsigned int  _handle,
bool &  p,
bool &  g 
)

Allows user to rerieve the policy that governs the corrective adaption of timeouts for put/get operations for a given handle.

Parameters:
_handle input: Conduit object reference
p output: bool for put operations
g output: bool for get operations
Returns:
ICAFE_NORMAL or ECAFE_INVALID_HANDLE

References cafeStatus, cs, ECAFE_INVALID_HANDLE, ChannelTimeoutPolicy::getSelfGoverningTimeout(), ICAFE_NORMAL, and CAFEStatus::report().

int PolicyHelper::getSGSelfGoverningTimeout ( unsigned int  _gHandle,
bool &  p,
bool &  g 
)

Allows user to retrieve the policy that governs the corrective adaption of timeouts for put/get operations for a given handle.

Parameters:
_gHandle input: Conduit Group object reference
p output: bool for put operations
g output: bool for get operations
Returns:
ICAFE_NORMAL or ECAFE_INVALID_HANDLE

References cafeStatus, ECAFE_INVALID_HANDLE, ChannelTimeoutPolicy::getSelfGoverningTimeout(), gs, ICAFE_NORMAL, and CAFEStatus::report().

int PolicyHelper::getSGTimeout ( unsigned int  _handle,
double &  pg 
) [inline]

References getSGTimeout().

int PolicyHelper::getSGTimeout ( unsigned int  _gHandle,
double &  p,
double &  g 
)

Allows user to retrieve timeout for SG put/get operations
.

Parameters:
_gHandle input: Conduit Group object reference
p output: SG put timeout
g output: SG get timeout
Returns:
ICAFE_NORMAL or ECAFE_INVALID_GROUP_HANDLE

References cafeStatus, ECAFE_INVALID_GROUP_HANDLE, ChannelTimeoutPolicy::getTimeout(), gs, ICAFE_NORMAL, and CAFEStatus::report().

Referenced by getSGTimeout(), getSGTimeoutGet(), getSGTimeoutPut(), HandleHelper::printHandle(), HandleHelper::printHandles(), and HandleHelper::printHandlesV().

int PolicyHelper::getSGTimeoutGet ( unsigned int  _handle,
double &  g 
) [inline]

References getSGTimeout().

int PolicyHelper::getSGTimeoutMax ( double &  p,
double &  g 
)

Allows user to retrieve minimum timeout for put/get operations.

Parameters:
p,: output: SG put timeout
g,: output: SG get timeout
Returns:
ICAFE_NORMAL

References DEFAULT_TIMEOUT_SG_PEND_IO, ChannelTimeoutPolicy::getTimeout(), gs, ICAFE_NORMAL, itgs, and TIMEOUT_PEND_IO_MIN.

Referenced by getSGTimeoutRange().

int PolicyHelper::getSGTimeoutMin ( double &  p,
double &  g 
)

Allows user to retrieve minimum timeout for SG put/get operations.

Parameters:
p,: output: SG put timeout
g,: output: SG get timeout
Returns:
ICAFE_NORMAL

References DEFAULT_TIMEOUT_SG_PEND_IO, ChannelTimeoutPolicy::getTimeout(), gs, ICAFE_NORMAL, itgs, and TIMEOUT_PEND_IO_MAX.

Referenced by getSGTimeoutRange().

int PolicyHelper::getSGTimeoutPut ( unsigned int  _handle,
double &  p 
) [inline]

References getSGTimeout().

int PolicyHelper::getSGTimeoutRange ( double &  p,
double &  p2,
double &  g,
double &  g2 
) [inline]
int PolicyHelper::getTimeout ( unsigned int  _handle,
double &  pg 
) [inline]

References getTimeout().

int PolicyHelper::getTimeout ( unsigned int  _handle,
double &  p,
double &  g 
)

Allows user to retrieve timeout for put/get operations
.

Parameters:
_handle input: Conduit object reference
p output: put timeout
g output: get timeout
Returns:
ICAFE_NORMAL or ECAFE_INVALID_HANDLE

References cafeStatus, cs, ECAFE_INVALID_HANDLE, ChannelTimeoutPolicy::getTimeout(), ICAFE_NORMAL, and CAFEStatus::report().

Referenced by getTimeout(), getTimeoutGet(), getTimeoutPut(), HandleHelper::printHandle(), HandleHelper::printHandles(), HandleHelper::printHandlesV(), and HandleHelper::printMonitors().

int PolicyHelper::getTimeoutGet ( unsigned int  _handle,
double &  g 
) [inline]

References getTimeout().

int PolicyHelper::getTimeoutMax ( double &  p,
double &  g 
)

Allows user to retrieve minimum timeout for put/get operations.

Parameters:
p,: output: put timeout
g,: output: get timeout
Returns:
ICAFE_NORMAL or ECAFE_INVALID_HANDLE

References cs, DEFAULT_TIMEOUT_PEND_IO, ChannelTimeoutPolicy::getTimeout(), ICAFE_NORMAL, itcs, and TIMEOUT_PEND_IO_MIN.

Referenced by getTimeoutRange().

int PolicyHelper::getTimeoutMin ( double &  p,
double &  g 
)

Allows user to retrieve minimum timeout for put/get operations.

Parameters:
p,: output: put timeout
g,: output: get timeout
Returns:
ICAFE_NORMAL or ECAFE_INVALID_HANDLE

References cs, DEFAULT_TIMEOUT_PEND_IO, ChannelTimeoutPolicy::getTimeout(), ICAFE_NORMAL, itcs, and TIMEOUT_PEND_IO_MAX.

Referenced by getTimeoutRange().

int PolicyHelper::getTimeoutPut ( unsigned int  _handle,
double &  p 
) [inline]

References getTimeout().

int PolicyHelper::getTimeoutRange ( double &  p,
double &  p2,
double &  g,
double &  g2 
) [inline]
int PolicyHelper::printSGTimeout ( unsigned int  _gHandle  ) 

Prints timeout for put/get operations for given handle.

Parameters:
_gHandle input: handle to ConduitGroup Object
Returns:
ICAFE_NORMAL

References cafeStatus, ECAFE_INVALID_HANDLE, ChannelTimeoutPolicy::getTimeout(), gs, ICAFE_NORMAL, and CAFEStatus::report().

int PolicyHelper::printSGTimeout (  ) 

Prints timeout for SG put/get operations.

Returns:
ICAFE_NORMAL

References ChannelTimeoutPolicy::getTimeout(), gs, ICAFE_NORMAL, and itgs.

int PolicyHelper::printTimeout ( unsigned int  _handle  ) 

Prints timeout for put/get operations for given handle.

Parameters:
_handle input: handle to Conduit Object
Returns:
ICAFE_NORMAL

References cafeStatus, cs, ECAFE_INVALID_HANDLE, ChannelTimeoutPolicy::getTimeout(), ICAFE_NORMAL, and CAFEStatus::report().

int PolicyHelper::printTimeout (  ) 

Prints timeout for put/get operations.

Returns:
ICAFE_NORMAL

References cs, ChannelTimeoutPolicy::getTimeout(), ICAFE_NORMAL, and itcs.

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

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] 
) [inherited]

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().

int PolicyHelper::setChannelGetActionWhenMonitorPolicy ( ChannelGetActionWhenMonitorPolicy  awmp  ) 

PolicyHelper::setChannelGetActionWhenMonitorPolicy
Retrieves ChannelGetActionWhenMonitorPolicy object (for all handles) whose method getWhenKind()
determines if ChannelGetActionWhenMonitorPolicyKind CAFENUM::GET_FROM_CACHE or CAFENUM::GET_FROM_IOC
.

Parameters:
awmp input: ChannelGetActionWhenMonitorPolicy object
Returns:
status ICAFE_NORMAL else ECAFE_INVALID_HANDLE

References cs, ICAFE_NORMAL, itcs, and setChannelGetActionWhenMonitorPolicy().

int PolicyHelper::setChannelGetActionWhenMonitorPolicy ( unsigned int  _handle,
ChannelGetActionWhenMonitorPolicy  awmp 
)
int PolicyHelper::setChannelGetActionWhenMonitorPolicyAllHandles ( ChannelGetActionWhenMonitorPolicy  awmp  )  [inline]
int PolicyHelper::setChannelGetCacheWaitPolicy ( ChannelGetCacheWaitPolicy  cwp  ) 

PolicyHelper::setChannelGetCacheWaitPolicy
Sets the ChannelGetCacheWaitPolicy object (for all handles) whose method getWhenKind()
determines if ChannelGetCacheWaitPolicyKind CAFENUM::GET_CACHE_NO_CEHCK CAFENUM::GET_CACHE_NO_WAIT or CAFENUM::GET_CACHE_WAIT
.

Parameters:
cwp input: ChannelGetCacheWaitPolicy object
Returns:
status ICAFE_NORMAL else ECAFE_INVALID_HANDLE

References cs, ICAFE_NORMAL, itcs, and setChannelGetCacheWaitPolicy().

int PolicyHelper::setChannelGetCacheWaitPolicy ( unsigned int  _handle,
ChannelGetCacheWaitPolicy  cwp 
)
int PolicyHelper::setChannelGetCacheWaitPolicyAllHandles ( ChannelGetCacheWaitPolicy  cwp  )  [inline]
int PolicyHelper::setChannelRequestDataTypePolicy ( ChannelRequestDataTypePolicy  crdtp  ) 

PolicyHelper::setChannelRequestDataTypePolicy
.

Sets ChannelRequestDataTypePolicy object (for all handles) whose
method setRequestKind(ChannelRequestDataTypePolicyKind)
determines if CAFENUM::NATIVE_DATATYPE or CAFENUM::LOWEST_DATATYPE,
which is the smaller in byte size of type requested and native datatype,
is being used for get/set operations

Parameters:
crdtp input: ChannelRequestDataTypePolicy object
Returns:
status ICAFE_NORMAL else ECAFE_INVALID_HANDLE

References cs, ICAFE_NORMAL, itcs, and setChannelRequestDataTypePolicy().

int PolicyHelper::setChannelRequestDataTypePolicy ( unsigned int  _handle,
ChannelRequestDataTypePolicy  crdtp 
)

PolicyHelper::setChannelRequestDataTypePolicy
.

Sets ChannelRequestDataTypePolicy object whose method
setRequestKind(ChannelRequestDataTypePolicyKind)
determines if CAFENUM::NATIVE_DATATYPE or CAFENUM::LOWEST_DATATYPE,
which is the smaller in byte size of type requested and native datatype,
is being used for get/set operations

Parameters:
_handle input: reference handle
crdtp input: ChannelRequestDataTypePolicy object
Returns:
status ICAFE_NORMAL else ECAFE_INVALID_HANDLE

References __METHOD__, cafeMutex, cs, ECAFE_INVALID_CAFENUM_POLICY_TYPE, ECAFE_INVALID_HANDLE, ChannelRequestDataTypePolicy::getRequestKind(), ICAFE_NORMAL, CAFENUM::LOWEST_DATATYPE, MUTEX, and CAFENUM::NATIVE_DATATYPE.

Referenced by setChannelRequestDataTypePolicy(), and setChannelRequestDataTypePolicyAllHandles().

int PolicyHelper::setChannelRequestDataTypePolicyAllHandles ( ChannelRequestDataTypePolicy  crdtp  )  [inline]
int PolicyHelper::setChannelRequestPolicyGet ( ChannelRequestPolicy  crpg  ) 
int PolicyHelper::setChannelRequestPolicyGet ( unsigned int  _handle,
ChannelRequestPolicy  crpg 
)
int PolicyHelper::setChannelRequestPolicyGetAllHandles ( ChannelRequestPolicy  crpg  )  [inline]
int PolicyHelper::setChannelRequestPolicyPut ( ChannelRequestPolicy  crpp  ) 
int PolicyHelper::setChannelRequestPolicyPut ( unsigned int  _handle,
ChannelRequestPolicy  crpp 
)
int PolicyHelper::setChannelRequestPolicyPutAllHandles ( ChannelRequestPolicy  crpp  )  [inline]
int PolicyHelper::setChannelTimeoutPolicyGet ( unsigned int  _handle,
ChannelTimeoutPolicy  ctpg 
)

PolicyHelper::setChannelTimeoutPolicyGet
.

Sets the Timeout Policy for put operations

Parameters:
_handle input: reference handle
ctpg input: ChannelTimeoutPolicyGet object
Returns:
status ICAFE_NORMAL if all OK

References cafeMutex, cs, ECAFE_INVALID_HANDLE, ICAFE_NORMAL, and MUTEX.

int PolicyHelper::setChannelTimeoutPolicyPut ( unsigned int  _handle,
ChannelTimeoutPolicy  ctpp 
)

PolicyHelper::setChannelTimeoutPolicyPut
.

Sets the Timout Policy for put operations

Parameters:
_handle input: reference handle
ctpp input: ChannelTimeoutPolicyPut object
Returns:
status ICAFE_NORMAL if all OK

References cafeMutex, cs, ECAFE_INVALID_HANDLE, ICAFE_NORMAL, and MUTEX.

int PolicyHelper::setSelfGoverningTimeout ( unsigned int  _handle,
bool  b 
)

Allows user to set the policy that governs the corrective adaption of timeouts for put/get operations for a given handle.

Parameters:
_handle input: Conduit object reference
b input: bool
Returns:
ICAFE_NORMAL or ECAFE_INVALID_HANDLE

References cafeMutex, cafeStatus, cs, ECAFE_INVALID_HANDLE, ICAFE_NORMAL, MUTEX, CAFEStatus::report(), and ChannelTimeoutPolicy::setSelfGoverningTimeout().

int PolicyHelper::setSelfGoverningTimeout ( bool  b  ) 

Allows user to set the policy that governs the corrective adaption of timeouts for put/get operations for all handles.

Parameters:
b input: bool
Returns:
ICAFE_NORMAL or ECAFE_INVALID_HANDLE

References cs, ICAFE_NORMAL, and itcs.

int PolicyHelper::setSelfGoverningTimeoutGet ( unsigned int  _handle,
bool  b 
)

Allows user to set the policy that governs the corrective adaption of timeouts for get operations for a given handle.

Parameters:
_handle input: Conduit object reference
b input: bool
Returns:
ICAFE_NORMAL or ECAFE_INVALID_HANDLE

References cafeMutex, cafeStatus, cs, ECAFE_INVALID_HANDLE, ICAFE_NORMAL, MUTEX, CAFEStatus::report(), and ChannelTimeoutPolicy::setSelfGoverningTimeout().

int PolicyHelper::setSelfGoverningTimeoutPut ( unsigned int  _handle,
bool  b 
)

Allows user to set the policy that governs the corrective adaption of timeouts for put operations for a given handle.

Parameters:
_handle input: Conduit object reference
b input: bool
Returns:
ICAFE_NORMAL or ECAFE_INVALID_HANDLE

References cafeMutex, cafeStatus, cs, ECAFE_INVALID_HANDLE, ICAFE_NORMAL, MUTEX, CAFEStatus::report(), and ChannelTimeoutPolicy::setSelfGoverningTimeout().

int PolicyHelper::setSGSelfGoverningTimeout ( unsigned int  _gHandle,
bool  b 
)

Allows user to set the policy that governs the corrective adaption of timeouts for SG put/get operations for a given handle.

Parameters:
_gHandle input: Conduit Group object reference
b input: bool
Returns:
ICAFE_NORMAL or ECAFE_INVALID_HANDLE

References cafeMutex, cafeStatus, ECAFE_INVALID_GROUP_HANDLE, gs, ICAFE_NORMAL, MUTEX, CAFEStatus::report(), and ChannelTimeoutPolicy::setSelfGoverningTimeout().

int PolicyHelper::setSGSelfGoverningTimeout ( bool  b  ) 

Allows user to set the policy that governs the corrective adaption of timeouts for SG put/get operations for all group handles.

Parameters:
b input: bool
Returns:
ICAFE_NORMAL or ECAFE_INVALID_HANDLE

References gs, ICAFE_NORMAL, and itgs.

int PolicyHelper::setSGSelfGoverningTimeoutGet ( unsigned int  _gHandle,
bool  b 
)

Allows user to set the policy that governs the corrective adaption of timeouts for SG get operations for a given group handle.

Parameters:
_gHandle input: Conduit Group object reference
b input: bool
Returns:
ICAFE_NORMAL or ECAFE_INVALID_HANDLE

References cafeMutex, cafeStatus, ECAFE_INVALID_GROUP_HANDLE, gs, ICAFE_NORMAL, MUTEX, CAFEStatus::report(), and ChannelTimeoutPolicy::setSelfGoverningTimeout().

int PolicyHelper::setSGSelfGoverningTimeoutPut ( unsigned int  _gHandle,
bool  b 
)

Allows user to set the policy that governs the corrective adaption of timeouts for SG put operations for a given group handle.

Parameters:
_gHandle input: Conduit Group object reference
b input: bool
Returns:
ICAFE_NORMAL or ECAFE_INVALID_HANDLE

References cafeMutex, cafeStatus, ECAFE_INVALID_GROUP_HANDLE, gs, ICAFE_NORMAL, MUTEX, CAFEStatus::report(), and ChannelTimeoutPolicy::setSelfGoverningTimeout().

int PolicyHelper::setSGTimeout ( unsigned int  _gHandle,
double  pg 
) [inline]

References setSGTimeout().

Referenced by setSGTimeout().

int PolicyHelper::setSGTimeout ( unsigned int  _gHandle,
double  p,
double  g 
)

Allows user to set timeoout for SG put/get operations (within allowed default min/max values).

Parameters:
_gHandle input: Conduit Group object reference
p input: SG put timeout
g input: SG get timeout
Returns:
ICAFE_NORMAL or ECAFE_INVALID_GROUP_HANDLE

References __METHOD__, cafeMutex, cafeStatus, ECAFE_INVALID_GROUP_HANDLE, gs, ICAFE_NORMAL, MUTEX, CAFEStatus::report(), and ChannelTimeoutPolicy::setTimeout().

int PolicyHelper::setSGTimeout ( double  pg  )  [inline]

References setSGTimeout().

Referenced by setSGTimeout().

int PolicyHelper::setSGTimeout ( double  p,
double  g 
)

Allows user to set timeout for SG put/get operations (within allowed default min/max values) for all handles.

Parameters:
p input: SG put timeout
g input: SG get timeout
Returns:
ICAFE_NORMAL or ECAFE_INVALID_GROUP_HANDLE

References gs, ICAFE_NORMAL, and itgs.

Referenced by setSGTimeoutGet(), and setSGTimeoutPut().

int PolicyHelper::setSGTimeoutGet ( unsigned int  _gHandle,
double  g 
) [inline]

References setSGTimeout().

int PolicyHelper::setSGTimeoutGet ( double  g  )  [inline]

References setSGTimeout().

int PolicyHelper::setSGTimeoutPut ( unsigned int  _gHandle,
double  p 
) [inline]

References setSGTimeout().

int PolicyHelper::setSGTimeoutPut ( double  p  )  [inline]

References setSGTimeout().

int PolicyHelper::setSGTimeoutToDefault (  ) 

Allows user to reset synchronous group timeout for put/get operations to default values for all group handles.

Returns:
ICAFE_NORMAL or ECAFE_INVALID_HANDLE

References gs, ICAFE_NORMAL, and itgs.

int PolicyHelper::setSGTimeoutToDefault ( unsigned int  _gHandle  ) 

Allows user to reset synchronous group timeout for put/get operations to default values for given handle.

Parameters:
_gHandle input: ConduitGroup object reference
Returns:
ICAFE_NORMAL or ECAFE_INVALID_HANDLE

References cafeMutex, cafeStatus, ECAFE_INVALID_GROUP_HANDLE, gs, ICAFE_NORMAL, MUTEX, CAFEStatus::report(), and ChannelTimeoutPolicy::setTimeoutToDefault().

int PolicyHelper::setTimeout ( unsigned int  _handle,
double  pg 
) [inline]

References setTimeout().

Referenced by setTimeout().

int PolicyHelper::setTimeout ( unsigned int  _handle,
double  p,
double  g 
)

Allows user to set timeoout for put/get operations (within allowed default min/max values).

Parameters:
_handle input: Conduit object reference
p input: put timeout
g input: get timeout
Returns:
ICAFE_NORMAL or ECAFE_INVALID_HANDLE

References __METHOD__, cafeMutex, cafeStatus, cs, ECAFE_INVALID_HANDLE, ICAFE_NORMAL, MUTEX, CAFEStatus::report(), and ChannelTimeoutPolicy::setTimeout().

int PolicyHelper::setTimeout ( double  pg  )  [inline]

References setTimeout().

Referenced by setTimeout().

int PolicyHelper::setTimeout ( double  p,
double  g 
)

Allows user to set timeout for put/get operations (within allowed default min/max values) for all handles.

Parameters:
p input: put timeout
g input: get timeout
Returns:
ICAFE_NORMAL or ECAFE_INVALID_HANDLE

References cs, ICAFE_NORMAL, and itcs.

Referenced by setTimeoutGet(), and setTimeoutPut().

int PolicyHelper::setTimeoutGet ( unsigned int  _handle,
double  g 
) [inline]

References setTimeout().

int PolicyHelper::setTimeoutGet ( double  g  )  [inline]

References setTimeout().

int PolicyHelper::setTimeoutPut ( unsigned int  _handle,
double  p 
) [inline]

References setTimeout().

int PolicyHelper::setTimeoutPut ( double  p  )  [inline]

References setTimeout().

int PolicyHelper::setTimeoutToDefault (  ) 

Allows user to reset timeout for put/get operations to default values for all handles.

Returns:
ICAFE_NORMAL or ECAFE_INVALID_HANDLE

References cs, ICAFE_NORMAL, and itcs.

int PolicyHelper::setTimeoutToDefault ( unsigned int  _handle  ) 

Allows user to reset timeout for put/get operations to default values for given handle.

Parameters:
_handle input: Conduit object reference
Returns:
ICAFE_NORMAL or ECAFE_INVALID_HANDLE

References cafeMutex, cafeStatus, cs, ECAFE_INVALID_HANDLE, ICAFE_NORMAL, MUTEX, CAFEStatus::report(), and ChannelTimeoutPolicy::setTimeoutToDefault().


Member Data Documentation

cafeConduit_set::iterator PolicyHelper::itcs [private]
cafeGroup_set::iterator PolicyHelper::itgs [private]

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

Generated on 3 May 2017 for CAFE by  doxygen 1.6.1