ScriptMeasure

Measure defined through a Lua script.

Runs the script defined in the file defined by script_file, which is relative to the folder of the scone scenario. See also LuaModel, LuaBody, LuaDof, LuaActuator, LuaMuscle, LuaFrame. Example of a Lua measure script:

function init( model )
    -- This function is called at the start of the simulation
    -- 'model' can be used to initialize the measure parameters (see LuaModel)
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 'return true' to terminate the simulation early
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
    -- 'current_frame' can be used to store values for analysis (see LuaFrame)
end

See Tutorial 6a and 6b for more information.

Inherits from Measure.

Public Attributes

Parameter Type Description
script_file path filename of the Lua script, path is relative to the .scone file
external_files std::vector< path > Array of files used by the Lua script; files included by 'require' should be added here.
name String Name of the Measure, to be used in reporting; defaults to measure type.
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 threshold between which the measure linearly decreases to zero; default = 0.
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 becomes active; default = 0.
stop_time TimeInSeconds Time [s] at which Controller becomes inactive; default = until simulation ends.
signature_prefix String Prefix signature with custom string. Special tags: DATE_TIME, DATE_TIME_EXACT, SCONE_VERSION.
signature_postfix String Append custom string to signature. Special tags: DATE_TIME, DATE_TIME_EXACT, SCONE_VERSION.

Converted from doxygen using dokugen

  • (external edit)