Technical information

Programming - Asset Management
57
RMS Enterprise - NetLinx Programmer’s Guide
Asset Parameters Registration and Update Functions
The Asset Parameters Registration and Update functions in the RmsApi.axi Include File are described in the following table:
Asset Parameters Registration and Update Functions
RmsAssetParameter
EnqueueEnumeration
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: ENUMERATION. The enumeration values should
be provided as a pipe "|" delimited list of string values.
Arguments: see method signature below
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsAssetParameterEnqueueEnumeration(CHAR assetClientKey[],
CHAR parameterKey[],
CHAR parameterName[],
CHAR parameterDescription[],
CHAR reportingType[],
CHAR initialValue[],
CHAR enumeration[],
CHAR allowReset,
CHAR resetValue[],
CHAR trackChanges)
{
STACK_VAR RmsAssetParameter parameter
// set all parameter properties for number param
parameter.dataType = RMS_ASSET_PARAM_DATA_TYPE_ENUMERATION;
parameter.key = parameterKey;
parameter.name = parameterName;
parameter.description = parameterDescription;
parameter.reportingType = reportingType;
parameter.initialValue
= initialValue;
parameter.allowReset = allowReset;
parameter.resetValue = resetValue;
parameter.trackChanges = trackChanges;
parameter.enumeration = enumeration;
RETURN RmsAssetParameterEnqueue(assetClientKey, parameter);
}
RmsAssetParameter
EnqueueDecimal
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: DECIMAL
Arguments: see method signature below
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsAssetParameterEnqueueDecimal(CHAR assetClientKey[],
CHAR parameterKey[],
CHAR parameterName[],
CHAR parameterDescription[],
CHAR reportingType[],
DOUBLE initialValue,
SLONG minimumValue,
SLONG maximumValue,
CHAR units[],
CHAR allowReset,
DOUBLE resetValue,
CHAR trackChanges)
{
STACK_VAR RmsAssetParameter parameter
// set all parameter properties for number param
parameter.dataType = RMS_ASSET_PARAM_DATA_TYPE_DECIMAL;
parameter.key = parameterKey;
parameter.name = parameterName;
parameter.description = parameterDescription;
parameter.reportingType = reportingType;
parameter.initialValue = FTOA(initialValue);
parameter.units = units;
parameter.allowReset = allowReset;
parameter.resetValue = FTOA(resetValue);
parameter.trackChanges = trackChanges;
parameter.minimumValue = minimumValue;
parameter.maximumValue = maximumValue;
RETURN RmsAssetParameterEnqueue(assetClientKey, parameter);
}