STATELOAD – Load multiple block states and parameters

Block SymbolLicensing group: ADVANCED

Function Description
The STATELOAD block reloads values of state and parameters from a file or string. The file is specified by the filename parameter and must be in JSON format, usually stored by the STATESAVE block. It is also possible to read data from the InState input, which is a JSON string in the same format as the input file. The InState input is used if the filename parameter is empty.

All values configured by the parameters blocks, depth, and mask that are stored in the file are loaded. If the parameter Strict is set to on, the block checks if the configured blocks and values match those stored in the file, and the file is refused if there is a mismatch.

Inputs

LOAD	Trigger to load the state	Bool
InState	JSON string to load if the filename parameter is empty	String
uChain	This input is not used by the block but is useful for placing the block in the correct execution order	Long (I32)

Parameters

filename	Filename from which to load	String
blocks	List of blocks to load. The block name must be a relative connection string (e.g. beginning with a dot) and they are separated by semicolons. All blocks (in the current subsystem) are loaded if this parameter is empty	String
depth	If the loading block is a subsystem, this parameter specifies how many levels are also loaded. 0 = current level only, 1 = current level and blocks directly in the current level subsystems, etc. $↓$ 0 $↑$ 65535	Long (I32)
mask	Select which objects are loaded. Each bit of the number signifies: 1 ... inputs 2 ... outputs 4 ... parameters 8 ... internal states 16 ... array parameters 32 ... array states 64 ... cyclic (trend) buffers 256 ... metadata (STATESAVE only) $↓$ 0 $↑$ 65535 $⊙$ 65535	Long (I32)
LoadOnInit	The file is loaded during the configuration initialization $⊙$ on	Bool
STRICT	If set, the file is checked against the current configuration and data are refused if there is a mismatch $⊙$ on	Bool

Outputs

DONE	State has been loaded	Bool
iE	Error code if block execution fails	Error

[Previous] [Back to top] [Up] [Next]