Accessor: utilities/GetAccessor

utilities/GetAccessor

Subclass of the GetResource accessor intended to obtain accessors for reification in a mutable accessor. In addition to the GetResource accessor's functionality, this accessor produces a parameterMap and inputMap along with the accessor. It also ignores all triggers until after this accessor's "resource" input value has been changed from the default (an empty string). This feature is useful if the desired accessor resource is unknown until runtime. If the resource is given as the boolean value false, this accessor will produce an empty string as output. This functionality is useful for clearing a mutable of its reified accessor.

Once a resource has been provided as input to this accessor, that input will be remembered in a local variable and treated as the new default value for future triggers.

Refer to utilities/GetResource for further documentation.

Version:
  • $$Id$$
Author:
  • Matt Weber
Source:
Inputs:
Name Type Description
options Options passed to the getResources() function, see utilities/GetResource.
resource JSON The accessor to be read OR a special value. Unlike superclass, defaults to an empty string. If triggered with the empty string as the value of this input, this accessor will ignore the trigger. If triggered with the boolean value false, this accessor will not get an accessor but will instead produce an empty string as output.
trigger boolean Send a token to this input to get the specified resource.
parameterMap JSON Parameter settings for the retrieved accessor to be provided along with that accessor.
inputMap JSON Default input settings for the retrieved accessor to be provided along with that accessor.
Outputs:
Name Type Description
output JSON An object with "accessor", "parameterMap", and "inputMap" properties. This format is compatible with Mutable accessors.
Parameters:
Name Type Description
synchronous boolean Perform a synchronous or asynchronous call of getResource. Note some hosts do not currently implement both versions.