Skip to content

model.name

since 1.1.0

Get / Set the model name.

local name = model.name([name])

Parameters

Name Type Required Description
name string optional

Returns

name (string)

Examples

local name = model.name()                         -- current model's name
local safe = name:gsub("[^%w_-]", "_")            -- safe for file names
local logFile = "LOGS:/mytool/" .. safe .. ".csv"

Real-world usage

Called 32 times across 6 open-source Ethos Lua projects. A few short excerpts:
ofs3.session.craftName = model.name and model.name() or ofs3.session.craftName

src/ofs3/lib/runtime.lua:571

dashx.session.craftName = model.name and model.name() or dashx.session.craftName

src/dashx/lib/runtime.lua:706

displayValue = session.craftName or (model and model.name and model.name()) or nil

src/rfsuite/widgets/dashboard/themes/danielrc/common.lua:425