Differences
This shows you the differences between two versions of the page.
— | ref:script_measure [2023/12/14 16:03] (current) – created - external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== ScriptMeasure ====== | ||
+ | [[measure|Measure]] defined through a Lua script. | ||
+ | |||
+ | Runs the script defined in the file defined by '' | ||
+ | -- This function is called at the start of the simulation | ||
+ | -- ' | ||
+ | end | ||
+ | |||
+ | function update( model ) | ||
+ | -- This function is called at each simulation timestep | ||
+ | -- Use it to update the internal variables of the measure (if needed) | ||
+ | return false -- change to ' | ||
+ | end | ||
+ | |||
+ | function result( model ) | ||
+ | -- This function is called at the end of the simulation | ||
+ | -- It should return the result of the measure | ||
+ | return 0.0 | ||
+ | end | ||
+ | |||
+ | function store_data( current_frame ) | ||
+ | -- This function is called at each simulation timestep | ||
+ | -- ' | ||
+ | end | ||
+ | </ | ||
+ | |||
+ | **Inherits from** [[measure|Measure]]. | ||
+ | |||
+ | ==== Public Attributes ==== | ||
+ | ^ Parameter ^ Type ^ Description ^ | ||
+ | ^ script_file | path | filename of the Lua script, path is relative to the .scone file | | ||
+ | ^ external_files | std:: | ||
+ | ^ name | String | Name of the [[measure|Measure]], | ||
+ | ^ weight | Real | Weighting factor applied to the result of the measure; default = 1. | | ||
+ | ^ threshold | Real | Threshold above / below which the measure becomes zero; default = 0. | | ||
+ | ^ threshold_transition | Real | Transition range above '' | ||
+ | ^ result_offset | Real | Offset added to measure result; default = 0. | | ||
+ | ^ minimize | bool | Indicate whether this measure should be minimized; default value depends on the measure type (usually true). | | ||
+ | ^ start_time | TimeInSeconds | Time [s] at which [[controller|Controller]] becomes active; default = 0. | | ||
+ | ^ stop_time | TimeInSeconds | Time [s] at which [[controller|Controller]] becomes inactive; default = until simulation ends. | | ||
+ | ^ signature_prefix | String | Prefix signature with custom string. Special tags: DATE_TIME, DATE_TIME_EXACT, | ||
+ | ^ signature_postfix | String | Append custom string to signature. Special tags: DATE_TIME, DATE_TIME_EXACT, | ||
+ | ^ signature | String | Set custom signature and omit the auto-generated signature. | | ||
+ | |||
+ | < | ||