Technical information

Programming - Asset Management
71
RMS Enterprise - NetLinx Programmer’s Guide
Asset Parameter Set Value Functions via Update Queue
The Asset Parameter Set Value functions (via Update Queue) in the RmsApi.axi Include File are described in the following table:
Asset Parameter Set Value Functions via Update Queue
RmsAssetParameter
EnqueueSetValueBoolean
Description: This function is used to set a new asset parameter value to the RMS server. The update is not sent
immediately, but rather placed in an update queue waiting for a submission call.
This function will set an asset parameter of data type: BOOLEAN
Arguments:
• CHAR assetClientKey[] - asset client key
• CHAR parameterKey[] - monitored parameter key
• CHAR parameterValue - monitored parameter value
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsAssetParameterEnqueueSetValueBoolean(CHAR assetClientKey[],
CHAR parameterKey[],
CHAR parameterValue)
{
// enqueue the asset parameter update
RETURN RmsAssetParameterEnqueueSetValue(assetClientKey,
parameterKey,
RmsBooleanString(parameterValue));
}
RmsAssetParameter
EnqueueSetValueNumber
Description: This function is used to set a new asset parameter value to the RMS server. The update is not sent
immediately, but rather placed in an update queue waiting for a submission call.
This function will set an asset parameter of data type: NUMBER
Arguments:
• CHAR assetClientKey[] - asset client key
• CHAR parameterKey[] - monitored parameter key
• SLONG parameterValue - monitored parameter value
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsAssetParameterEnqueueSetValueNumber(CHAR assetClientKey[],
CHAR parameterKey[],
SLONG parameterValue)
{
// enqueue the asset parameter update
RETURN RmsAssetParameterEnqueueSetValue(assetClientKey,
parameterKey,
ITOA(parameterValue));
}
RmsAssetParameter
EnqueueSetValueDecimal
Description: This function is used to set a new asset parameter value to the RMS server. The update is not sent
immediately, but rather placed in an update queue waiting for a submission call.
This function will set an asset parameter of data type: DECIMAL
Arguments:
• CHAR assetClientKey[] - asset client key
• CHAR parameterKey[] - monitored parameter key
• DOUBLE parameterValue - monitored parameter value
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsAssetParameterEnqueueSetValueDecimal(CHAR assetClientKey[],
CHAR parameterKey[],
DOUBLE parameterValue)
{
// enqueue the asset parameter update
RETURN RmsAssetParameterEnqueueSetValue(assetClientKey,
parameterKey,
FTOA(parameterValue));
}