Technical information

Programming - Asset Management
61
RMS Enterprise - NetLinx Programmer’s Guide
Asset Parameters Registration and Update Functions (Cont.)
RmsAssetParameter
EnqueueString
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: STRING
Arguments: see method signature below
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsAssetParameterEnqueueString(CHAR assetClientKey[],
CHAR parameterKey[],
CHAR parameterName[],
CHAR parameterDescription[],
CHAR reportingType[],
CHAR initialValue[],
CHAR units[],
CHAR allowReset,
CHAR resetValue[],
CHAR trackChanges)
{
STACK_VAR RmsAssetParameter parameter
// set all parameter properties for string param
parameter.dataType = RMS_ASSET_PARAM_DATA_TYPE_STRING;
parameter.key = parameterKey;
parameter.name = parameterName;
parameter.description = parameterDescription;
parameter.reportingType = reportingType;
parameter.
initialValue = initialValue;
parameter.units = units;
parameter.allowReset = allowReset;
parameter.resetValue = resetValue;
parameter.trackChanges = trackChanges;
RETURN RmsAssetParameterEnqueue(assetClientKey, parameter);
}
RmsAssetParameter
EnqueueBoolean
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: BOOLEAN
Arguments: see method signature below
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsAssetParameterEnqueueBoolean(CHAR assetClientKey[],
CHAR parameterKey[],
CHAR parameterName[],
CHAR parameterDescription[],
CHAR reportingType[],
CHAR initialValue,
CHAR allowReset,
CHAR resetValue,
CHAR trackChanges)
{
STACK_VAR RmsAssetParameter parameter
// set all parameter properties for boolean param
parameter.dataType = RMS_ASSET_PARAM_DATA_TYPE_BOOLEAN;
parameter.key = parameterKey;
parameter.name = parameterName;
parameter.description = parameterDescription;
parameter.reportingType = reportingType;
parameter.initialValue = RmsBooleanString(initialValue
);
parameter.allowReset = allowReset;
parameter.resetValue = RmsBooleanString(resetValue);
parameter.trackChanges = trackChanges;
RETURN RmsAssetParameterEnqueue(assetClientKey, parameter);
}