#include <policyHelper.h>
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 |
| PolicyHelper::PolicyHelper | ( | ) | [inline] |
| PolicyHelper::~PolicyHelper | ( | ) | [inline] |
| std::string Helper::concatToString | ( | dbr_char_t * | inpChar, | |
| unsigned int | nChar | |||
| ) | [inherited] |
Concatinates dbr_char_t(unsigned char) into a string.
| inpChar | input: Array of dbr_char_t data types | |
| nChar | input: size of array |
| CAFENUM::DBR_TYPE Helper::convertToCAFEDbrTypeClass | ( | const chtype | _chtype | ) | const [inherited] |
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
| _chtype | input: channel 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 | |||
| ) | [inherited] |
Produces a unique identifier from the pvName and ca_client_context for entry into hash table.
| pv | input: process variable name | |
| ccc | input: current context |
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.
| pv | input: process variable name | |
| ccc | input: current context | |
| ghs | input: size of gs (group handle set) |
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
.
| _handle | input: reference handle | |
| awmp | output: ChannelGetActionWhenMonitorPolicy object |
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
.
| _handle | input: reference handle | |
| cwp | output: ChannelGetCacheWaitPolicy object |
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.
| _handle | input: reference handle | |
| crdtp | output: ChannelRequestDataTypePolicy object |
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
| _handle | input: reference handle | |
| crpg | output: ChannelRequestPolicyGet object |
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
| _handle | input: reference handle | |
| crpp | output: ChannelRequestPolicyPut object |
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
| _handle | input: reference handle | |
| ctpg | output: ChannelTimeoutPolicyGet object |
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
| _handle | input: reference handle | |
| ctpp | output: ChannelTimeoutPolicyPut object |
References cs, ECAFE_INVALID_HANDLE, and ICAFE_NORMAL.
Allows user to rerieve the policy that governs the corrective adaption of timeouts for put/get operations for a given handle.
| _handle | input: Conduit object reference | |
| p | output: bool for put operations | |
| g | output: bool for get operations |
References cafeStatus, cs, ECAFE_INVALID_HANDLE, ChannelTimeoutPolicy::getSelfGoverningTimeout(), ICAFE_NORMAL, and CAFEStatus::report().
Allows user to retrieve the policy that governs the corrective adaption of timeouts for put/get operations for a given handle.
| _gHandle | input: Conduit Group object reference | |
| p | output: bool for put operations | |
| g | output: bool for get operations |
References cafeStatus, ECAFE_INVALID_HANDLE, ChannelTimeoutPolicy::getSelfGoverningTimeout(), gs, ICAFE_NORMAL, and CAFEStatus::report().
References getSGTimeout().
Allows user to retrieve timeout for SG put/get operations
.
| _gHandle | input: Conduit Group object reference | |
| p | output: SG put timeout | |
| g | output: SG get timeout |
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().
References getSGTimeout().
| int PolicyHelper::getSGTimeoutMax | ( | double & | p, | |
| double & | g | |||
| ) |
Allows user to retrieve minimum timeout for put/get operations.
| p,: | output: SG put timeout | |
| g,: | output: SG get timeout |
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.
| p,: | output: SG put timeout | |
| g,: | output: SG get timeout |
References DEFAULT_TIMEOUT_SG_PEND_IO, ChannelTimeoutPolicy::getTimeout(), gs, ICAFE_NORMAL, itgs, and TIMEOUT_PEND_IO_MAX.
Referenced by getSGTimeoutRange().
References getSGTimeout().
| int PolicyHelper::getSGTimeoutRange | ( | double & | p, | |
| double & | p2, | |||
| double & | g, | |||
| double & | g2 | |||
| ) | [inline] |
References getSGTimeoutMax(), getSGTimeoutMin(), and ICAFE_NORMAL.
References getTimeout().
Allows user to retrieve timeout for put/get operations
.
| _handle | input: Conduit object reference | |
| p | output: put timeout | |
| g | output: get timeout |
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().
References getTimeout().
| int PolicyHelper::getTimeoutMax | ( | double & | p, | |
| double & | g | |||
| ) |
Allows user to retrieve minimum timeout for put/get operations.
| p,: | output: put timeout | |
| g,: | output: get timeout |
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.
| p,: | output: put timeout | |
| g,: | output: get timeout |
References cs, DEFAULT_TIMEOUT_PEND_IO, ChannelTimeoutPolicy::getTimeout(), ICAFE_NORMAL, itcs, and TIMEOUT_PEND_IO_MAX.
Referenced by getTimeoutRange().
References getTimeout().
| int PolicyHelper::getTimeoutRange | ( | double & | p, | |
| double & | p2, | |||
| double & | g, | |||
| double & | g2 | |||
| ) | [inline] |
References getTimeoutMax(), getTimeoutMin(), and ICAFE_NORMAL.
Prints timeout for put/get operations for given handle.
| _gHandle | input: handle to ConduitGroup Object |
References cafeStatus, ECAFE_INVALID_HANDLE, ChannelTimeoutPolicy::getTimeout(), gs, ICAFE_NORMAL, and CAFEStatus::report().
| int PolicyHelper::printSGTimeout | ( | ) |
Prints timeout for SG put/get operations.
References ChannelTimeoutPolicy::getTimeout(), gs, ICAFE_NORMAL, and itgs.
Prints timeout for put/get operations for given handle.
| _handle | input: handle to Conduit Object |
References cafeStatus, cs, ECAFE_INVALID_HANDLE, ChannelTimeoutPolicy::getTimeout(), ICAFE_NORMAL, and CAFEStatus::report().
| int PolicyHelper::printTimeout | ( | ) |
Prints timeout for put/get operations.
References cs, ChannelTimeoutPolicy::getTimeout(), ICAFE_NORMAL, and itcs.
| void Helper::removeLeadingAndTrailingSpaces | ( | const char * | pv, | |
| char | pvStripped[PVNAME_SIZE] | |||
| ) | [inherited] |
Removes leading and trailing blanks.
| 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] | |||
| ) | [inherited] |
Removes leading and trailing blanks.
| 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.
| 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
.
| awmp | input: ChannelGetActionWhenMonitorPolicy object |
References cs, ICAFE_NORMAL, itcs, and setChannelGetActionWhenMonitorPolicy().
| int PolicyHelper::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
.
| _handle | input: reference handle | |
| awmp | input: ChannelGetActionWhenMonitorPolicy object |
References __METHOD__, cafeMutex, cs, ECAFE_INVALID_CAFENUM_POLICY_TYPE, ECAFE_INVALID_HANDLE, CAFENUM::GET_FROM_CACHE, CAFENUM::GET_FROM_IOC, ChannelGetActionWhenMonitorPolicy::getActionKind(), ICAFE_NORMAL, and MUTEX.
Referenced by setChannelGetActionWhenMonitorPolicy(), and setChannelGetActionWhenMonitorPolicyAllHandles().
| int PolicyHelper::setChannelGetActionWhenMonitorPolicyAllHandles | ( | ChannelGetActionWhenMonitorPolicy | awmp | ) | [inline] |
References setChannelGetActionWhenMonitorPolicy().
| 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
.
| cwp | input: ChannelGetCacheWaitPolicy object |
References cs, ICAFE_NORMAL, itcs, and setChannelGetCacheWaitPolicy().
| int PolicyHelper::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
.
| _handle | input: reference handle | |
| cwp | input: ChannelGetCacheWaitPolicy object |
References __METHOD__, cafeMutex, cs, ECAFE_INVALID_CAFENUM_POLICY_TYPE, ECAFE_INVALID_HANDLE, CAFENUM::GET_CACHE_NO_CHECK, CAFENUM::GET_CACHE_WAIT, ChannelGetCacheWaitPolicy::getWaitKind(), ICAFE_NORMAL, and MUTEX.
Referenced by setChannelGetCacheWaitPolicy(), and setChannelGetCacheWaitPolicyAllHandles().
| int PolicyHelper::setChannelGetCacheWaitPolicyAllHandles | ( | ChannelGetCacheWaitPolicy | cwp | ) | [inline] |
References setChannelGetCacheWaitPolicy().
| 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
| crdtp | input: ChannelRequestDataTypePolicy object |
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
| _handle | input: reference handle | |
| crdtp | input: ChannelRequestDataTypePolicy object |
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] |
References setChannelRequestDataTypePolicy().
| int PolicyHelper::setChannelRequestPolicyGet | ( | ChannelRequestPolicy | crpg | ) |
PolicyHelper::setChannelRequestPolicyGet
.
Sets the Blocking Policy for all handles within context
| crpg | input: Channel.RequestPolicyGet object |
References __METHOD__, cafeMutex, cs, ChannelRequestPolicy::getHandler(), ChannelRequestPolicy::getMethodKind(), ICAFE_CHANNEL_BLOCKING_POLICY_CONFLICT, ICAFE_NORMAL, itcs, MUTEX, ChannelRequestPolicy::setMethodKind(), Connect::status, CAFENUM::WITH_CALLBACK_DEFAULT, and CAFENUM::WITH_CALLBACK_USER_SUPPLIED.
| int PolicyHelper::setChannelRequestPolicyGet | ( | unsigned int | _handle, | |
| ChannelRequestPolicy | crpg | |||
| ) |
PolicyHelper::setChannelRequestPolicyGet
.
Sets the Blocking Policy for get operations
| _handle | input: reference handle | |
| crpg | input: Channel.RequestPolicyGet object |
References __METHOD__, cafeMutex, cs, ECAFE_INVALID_HANDLE, ChannelRequestPolicy::getHandler(), ChannelRequestPolicy::getMethodKind(), ICAFE_CHANNEL_BLOCKING_POLICY_CONFLICT, ICAFE_NORMAL, MUTEX, ChannelRequestPolicy::setMethodKind(), Connect::status, CAFENUM::WITH_CALLBACK_DEFAULT, and CAFENUM::WITH_CALLBACK_USER_SUPPLIED.
Referenced by setChannelRequestPolicyGetAllHandles().
| int PolicyHelper::setChannelRequestPolicyGetAllHandles | ( | ChannelRequestPolicy | crpg | ) | [inline] |
References setChannelRequestPolicyGet().
| int PolicyHelper::setChannelRequestPolicyPut | ( | ChannelRequestPolicy | crpp | ) |
PolicyHelper::setChannelRequestPolicyPut
.
Sets the Blocking Policy for put operations
| crpp | input: ChannelRequestPolicyPut object |
References __METHOD__, cafeMutex, cs, ChannelRequestPolicy::getHandler(), ChannelRequestPolicy::getMethodKind(), ICAFE_CHANNEL_BLOCKING_POLICY_CONFLICT, ICAFE_NORMAL, itcs, MUTEX, ChannelRequestPolicy::setMethodKind(), Connect::status, CAFENUM::WITH_CALLBACK_DEFAULT, and CAFENUM::WITH_CALLBACK_USER_SUPPLIED.
| int PolicyHelper::setChannelRequestPolicyPut | ( | unsigned int | _handle, | |
| ChannelRequestPolicy | crpp | |||
| ) |
PolicyHelper::setChannelRequestPolicyPut
.
Sets the Blocking Policy for put operations
| _handle | input: reference handle | |
| crpp | input: ChannelRequestPolicyPut object |
References __METHOD__, cafeMutex, cs, ECAFE_INVALID_HANDLE, ChannelRequestPolicy::getHandler(), ChannelRequestPolicy::getMethodKind(), ICAFE_CHANNEL_BLOCKING_POLICY_CONFLICT, ICAFE_NORMAL, MUTEX, ChannelRequestPolicy::setMethodKind(), Connect::status, CAFENUM::WITH_CALLBACK_DEFAULT, and CAFENUM::WITH_CALLBACK_USER_SUPPLIED.
Referenced by Instant< CTYPE >::set(), CAFE::set(), Instant< CTYPE >::setAndMatch(), Instant< CTYPE >::setAndMatchMany(), and setChannelRequestPolicyPutAllHandles().
| int PolicyHelper::setChannelRequestPolicyPutAllHandles | ( | ChannelRequestPolicy | crpp | ) | [inline] |
References setChannelRequestPolicyPut().
| int PolicyHelper::setChannelTimeoutPolicyGet | ( | unsigned int | _handle, | |
| ChannelTimeoutPolicy | ctpg | |||
| ) |
PolicyHelper::setChannelTimeoutPolicyGet
.
Sets the Timeout Policy for put operations
| _handle | input: reference handle | |
| ctpg | input: ChannelTimeoutPolicyGet object |
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
| _handle | input: reference handle | |
| ctpp | input: ChannelTimeoutPolicyPut object |
References cafeMutex, cs, ECAFE_INVALID_HANDLE, ICAFE_NORMAL, and MUTEX.
Allows user to set the policy that governs the corrective adaption of timeouts for put/get operations for a given handle.
| _handle | input: Conduit object reference | |
| b | input: bool |
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.
| b | input: bool |
References cs, ICAFE_NORMAL, and itcs.
Allows user to set the policy that governs the corrective adaption of timeouts for get operations for a given handle.
| _handle | input: Conduit object reference | |
| b | input: bool |
References cafeMutex, cafeStatus, cs, ECAFE_INVALID_HANDLE, ICAFE_NORMAL, MUTEX, CAFEStatus::report(), and ChannelTimeoutPolicy::setSelfGoverningTimeout().
Allows user to set the policy that governs the corrective adaption of timeouts for put operations for a given handle.
| _handle | input: Conduit object reference | |
| b | input: bool |
References cafeMutex, cafeStatus, cs, ECAFE_INVALID_HANDLE, ICAFE_NORMAL, MUTEX, CAFEStatus::report(), and ChannelTimeoutPolicy::setSelfGoverningTimeout().
Allows user to set the policy that governs the corrective adaption of timeouts for SG put/get operations for a given handle.
| _gHandle | input: Conduit Group object reference | |
| b | input: bool |
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.
| b | input: bool |
References gs, ICAFE_NORMAL, and itgs.
Allows user to set the policy that governs the corrective adaption of timeouts for SG get operations for a given group handle.
| _gHandle | input: Conduit Group object reference | |
| b | input: bool |
References cafeMutex, cafeStatus, ECAFE_INVALID_GROUP_HANDLE, gs, ICAFE_NORMAL, MUTEX, CAFEStatus::report(), and ChannelTimeoutPolicy::setSelfGoverningTimeout().
Allows user to set the policy that governs the corrective adaption of timeouts for SG put operations for a given group handle.
| _gHandle | input: Conduit Group object reference | |
| b | input: bool |
References cafeMutex, cafeStatus, ECAFE_INVALID_GROUP_HANDLE, gs, ICAFE_NORMAL, MUTEX, CAFEStatus::report(), and ChannelTimeoutPolicy::setSelfGoverningTimeout().
References setSGTimeout().
Referenced by setSGTimeout().
Allows user to set timeoout for SG put/get operations (within allowed default min/max values).
| _gHandle | input: Conduit Group object reference | |
| p | input: SG put timeout | |
| g | input: SG get timeout |
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.
| p | input: SG put timeout | |
| g | input: SG get timeout |
References gs, ICAFE_NORMAL, and itgs.
Referenced by setSGTimeoutGet(), and setSGTimeoutPut().
References setSGTimeout().
| int PolicyHelper::setSGTimeoutGet | ( | double | g | ) | [inline] |
References setSGTimeout().
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.
References gs, ICAFE_NORMAL, and itgs.
Allows user to reset synchronous group timeout for put/get operations to default values for given handle.
| _gHandle | input: ConduitGroup object reference |
References cafeMutex, cafeStatus, ECAFE_INVALID_GROUP_HANDLE, gs, ICAFE_NORMAL, MUTEX, CAFEStatus::report(), and ChannelTimeoutPolicy::setTimeoutToDefault().
References setTimeout().
Referenced by setTimeout().
Allows user to set timeoout for put/get operations (within allowed default min/max values).
| _handle | input: Conduit object reference | |
| p | input: put timeout | |
| g | input: get timeout |
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.
| p | input: put timeout | |
| g | input: get timeout |
References cs, ICAFE_NORMAL, and itcs.
Referenced by setTimeoutGet(), and setTimeoutPut().
References setTimeout().
| int PolicyHelper::setTimeoutGet | ( | double | g | ) | [inline] |
References setTimeout().
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.
References cs, ICAFE_NORMAL, and itcs.
Allows user to reset timeout for put/get operations to default values for given handle.
| _handle | input: Conduit object reference |
References cafeMutex, cafeStatus, cs, ECAFE_INVALID_HANDLE, ICAFE_NORMAL, MUTEX, CAFEStatus::report(), and ChannelTimeoutPolicy::setTimeoutToDefault().
CAFEStatus PolicyHelper::cafeStatus [private] |
Referenced by getSelfGoverningTimeout(), getSGSelfGoverningTimeout(), getSGTimeout(), getTimeout(), printSGTimeout(), printTimeout(), setSelfGoverningTimeout(), setSelfGoverningTimeoutGet(), setSelfGoverningTimeoutPut(), setSGSelfGoverningTimeout(), setSGSelfGoverningTimeoutGet(), setSGSelfGoverningTimeoutPut(), setSGTimeout(), setSGTimeoutToDefault(), setTimeout(), and setTimeoutToDefault().
cafeConduit_set::iterator PolicyHelper::itcs [private] |
cafeGroup_set::iterator PolicyHelper::itgs [private] |
Referenced by getSGTimeoutMax(), getSGTimeoutMin(), printSGTimeout(), setSGSelfGoverningTimeout(), setSGTimeout(), and setSGTimeoutToDefault().
1.6.1