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. The blocks parameter contains relative paths (starting with a dot) to the loaded blocks separated by semicolons. If blocks is empty, all blocks of the current subsystem are loaded. If the loaded block is a subsystem, the depth parameter specifies how many levels are also loaded:

0: current level only,
n: current level and blocks in subsystems of other n levels.

Furthermore, you can use mask to specify which objects will be loaded. Each bit of a number means:

1: inputs,
2: outputs,
4: parameters,
8: internal states,
16: array parameters,
32: array states,
64: cyclic (trend) buffers,
256: metadata (STATESAVE only).

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.

This block does not propagate the signal quality. More information can be found in the 1.4 section.

Input

LOAD	Trigger to load the state	Bool
InState	JSON string to load if the filename parameter is empty	String
uChain	Useful for placing the block in the correct execution order	Long (I32)

Parameter

filename	Filename from which to load	String
blocks	List of blocks to load	String
depth	Specifies how many levels are loaded $↓$ 0 $↑$ 65535	Long (I32)
mask	Select which objects are loaded $↓$ 0 $↑$ 65535 $⊙$ 65535	Long (I32)
LoadOnInit	The file is loaded during the configuration initialization $⊙$ on	Bool
STRICT	The file is checked against the current configuration $⊙$ on	Bool

Output

DONE	State has been loaded	Bool
iE	Error code	Error

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