Technical information

RMS NetLinx Virtual Device API
153
RMS Enterprise - NetLinx Programmer’s Guide
RMS Asset Control Method Registration Commands (Cont.)
Command Description
ASSET.METHOD.ARGUMENT-
<asset-client-key>,<method-key>,
<argument-ordinal>,<argument-name>,
(,<argument-description>)
(,<argument-data-type>)
(,<argument-default-value>)
(,<argument-minimum-value>)
(,<argument-maximum-value>)
(,<argument-step-value>)
(,<argument-enumeration-value>)
This command will add an asset control method argument to a control method cur-
rently staged in the control method
registration queue.
• <argument-ordinal>: This property identifies the argument numerical position in the
set of arguments. This ordinal value should start at 1.
• <argument-data-type>: This property defines the data type for the control method
argument. The acceptable values are:
NUMBER
STRING
ENUMERATION
LEVEL
BOOLEAN
DECIMAL
• <argument-default-value>: This property is OPTIONAL and defines the default
value for the argument when prompted in the RMS UI. This default value must
adhere to the data type specified.
• <argument-minimum-value>: This property is OPTIONAL and defines a minimum
possible value to allow for this control method argument. This minimum value only
applies to arguments of data type: NUMBER, DECIMAL, and LEVEL.
• <argument-maximum-value>: This property is OPTIONAL and defines a maximum
possible value to allow for this control method argument. This maximum value only
applies to arguments of data type: NUMBER, DECIMAL, and LEVEL.
• <argument-step-value>: This property is OPTIONAL and defines a step to increase
or decrease the value by when using the UP and DOWN controls in the RMS UI.
This step value only applies to arguments of data type: NUMBER, DECIMAL, and
LEVEL.
• <argument-enumeration-value>: This optional argument that defines a set of
enumeration values. This is a pipe "|" delimited string where each enumeration
value is separated by pipe "|" characters.
ASSET.METHOD.ARGUMENT.BOOLEAN-
<asset-client-key>,<method-key>,
<argument-ordinal>,<argument-name>,
(,<argument-description>)
(,<argument-default-value>)
This command will add an asset control method argument of type "BOOLEAN" to a
control method currently staged in the control method registration queue.
• <argument-default-value>): This is an optional argument and its default value is
'false'. Acceptable values are 'true" and 'false'.
ASSET.METHOD.ARGUMENT.STRING-
<asset-client-key>,<method-key>,
<argument-ordinal>,<argument-name>,
(,<argument-description>)
(,<argument-default-value>)
This command will add an asset control method argument of type "STRING" to a
control method currently staged in the
control method registration queue.
ASSET.METHOD.ARGUMENT.NUMBER-
<asset-client-key>,<method-key>,
<argument-ordinal>,<argument-name>,
(,<argument-description>)
(,<argument-default-value>)
(,<argument-minimum-value>)
(,<argument-maximum-value>)
(,<argument-step-value>)
This command will add an asset control method argument of type "NUMBER" to a
control method currently staged in the control method registration queue.
ASSET.METHOD.ARGUMENT.DECIMAL-
<asset-client-key>,<method-key>,
<argument-ordinal>,<argument-name>,
(,<argument-description>)
(,<argument-default-value>)
(,<argument-minimum-value>)
(,<argument-maximum-value>)
(,<argument-step-value>)
This command will add an asset control method argument of type "DECIMAL" to a
control method currently staged in the control method registration queue.