Technical information
Programming - Asset Management
59
RMS Enterprise - NetLinx Programmer’s Guide
Asset Parameters Registration and Update Functions (Cont.)
RmsAssetParameter
EnqueueLevel
Description: This function is used to place an asset parameter registration in queue for a specified asset client key. The
asset parameter being registered is of asset parameter data type: LEVEL
Arguments: see method signature below
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsAssetParameterEnqueueLevel (CHAR assetClientKey[],
CHAR parameterKey[],
CHAR parameterName[],
CHAR parameterDescription[],
CHAR reportingType[],
SLONG initialValue,
SLONG minimumValue,
SLONG maximumValue,
CHAR units[],
CHAR allowReset,
SLONG resetValue,
CHAR trackChanges,
CHAR bargraphKey[])
{
STACK_VAR RmsAssetParameter parameter
// set all parameter properties for number param
parameter.dataType = RMS_ASSET_PARAM_DATA_TYPE_LEVEL;
parameter.key = parameterKey;
parameter.name = parameterName;
parameter
.description = parameterDescription;
parameter.reportingType = reportingType;
parameter.initialValue = ITOA(initialValue);
parameter.units = units;
parameter.allowReset = allowReset;
parameter.resetValue = ITOA(resetValue);
parameter.trackChanges = trackChanges;
parameter.minimumValue = minimumValue;
parameter.maximumValue = maximumValue;
parameter.bargraphKey = bargraphKey;
RETURN RmsAssetParameterEnqueue(assetClientKey, parameter);
}
RmsAssetParameter
EnqueueNumber
Description: This function is used to place an asset parameter registration in queue for a specified asset client key. The
asset parameter being registered is of asset parameter data type: NUMBER
Arguments: see method signature below
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsAssetParameterEnqueueNumber(CHAR assetClientKey[],
CHAR parameterKey[],
CHAR parameterName[],
CHAR parameterDescription[],
CHAR reportingType[],
SLONG initialValue,
SLONG minimumValue,
SLONG maximumValue,
CHAR units[],
CHAR allowReset,
SLONG resetValue,
CHAR trackChanges)
{
STACK_VAR RmsAssetParameter parameter
// set all parameter properties for number param
parameter.dataType = RMS_ASSET_PARAM_DATA_TYPE_NUMBER;
parameter.key = parameterKey;
parameter.name = parameterName;
parameter.description = parameterDescription;
parameter.reportingType = reportingType;
parameter.initialValue = ITOA(initialValue);
parameter.units = units;
parameter.allowReset = allowReset;
parameter.resetValue = ITOA(resetValue);
parameter.trackChanges = trackChanges;
parameter.minimumValue = minimumValue;
parameter.maximumValue = maximumValue;
RETURN RmsAssetParameterEnqueue(assetClientKey, parameter);
}