Parm Functions

Every Parm in OpenVSP can be accessed and modified through the functions defined in this API group. Every Parm has an associated ParmContainer.

GetParm(std, std, std)
ValidParm(std)
SetParmVal(-> double)
SetParmValLimits(std, double val, ...)
SetParmValUpdate(-> double)
GetParmVal(-> double)
GetIntParmVal(std)
GetBoolParmVal(std)
SetParmUpperLimit(std, double val)
GetParmUpperLimit(std)
SetParmLowerLimit(std, double val)
GetParmLowerLimit(std)
GetParmType(std)
GetParmName(std)
GetParmGroupName(std)
GetParmDisplayGroupName(std)
GetParmContainer(std)
SetParmDescript(std, std)
GetParmDescript(std)
FindParm(std, std, std)

Details

openvsp.GetParm(std: :string const & geom_id, std: :string const & name, std: :string const & group) → std::string

openvsp.ValidParm(std: :string const & id) → bool

openvsp.SetParmVal(std: :string const & parm_id, double val) → double

openvsp.SetParmVal(std: :string const & geom_id, std: :string const & name, std: :string const & group, double val) → double

openvsp.SetParmValLimits(std: :string const & parm_id, double val, double lower_limit, double upper_limit) → double

openvsp.SetParmValUpdate(std: :string const & parm_id, double val) → double

openvsp.SetParmValUpdate(std: :string const & geom_id, std: :string const & parm_name, std: :string const & parm_group_name, double val) → double

openvsp.GetParmVal(std: :string const & parm_id) → double

openvsp.GetParmVal(std: :string const & geom_id, std: :string const & name, std: :string const & group) → double

openvsp.GetIntParmVal(std: :string const & parm_id) → int

openvsp.GetBoolParmVal(std: :string const & parm_id) → bool

openvsp.SetParmUpperLimit(std: :string const & parm_id, double val)

openvsp.GetParmUpperLimit(std: :string const & parm_id) → double

openvsp.SetParmLowerLimit(std: :string const & parm_id, double val)

openvsp.GetParmLowerLimit(std: :string const & parm_id) → double

openvsp.GetParmType(std: :string const & parm_id) → int

openvsp.GetParmName(std: :string const & parm_id) → std::string

openvsp.GetParmGroupName(std: :string const & parm_id) → std::string

openvsp.GetParmDisplayGroupName(std: :string const & parm_id) → std::string

openvsp.GetParmContainer(std: :string const & parm_id) → std::string

openvsp.SetParmDescript(std: :string const & parm_id, std: :string const & desc)

openvsp.GetParmDescript(std: :string const & parm_id) → std::string

openvsp.FindParm(std: :string const & parm_container_id, std: :string const & parm_name, std: :string const & group_name) → std::string