SCDDS class wrapper API documentation

class SCDDSclass_wrapper

Bases: SCDDSclass_component

Wrapper class containing algos

[ SCDDS - Simulink Control Development & Deployment Suite ] Copyright SPC-EPFL Lausanne 2022. Distributed under the terms of the GNU Lesser General Public License, LGPL-3.0-only.

Property Summary
createdd

automatically create fresh dd during wrapper init

Method Summary
build()

generates c/c++ code for the wrapper slx model this method can only be called for wrappers whose ‘obj.buildable’ is set to ‘true’ syntax obj.build

getbuildargs()

grabs build arguments from the attached algo objects in this wrapper syntax build_args = obj.getbuildargs

init()

initializes this wrapper object. During initialization, the following steps are performed: - put a SimulinkConfiguration set in the base WS that can be referred to in the model slx (needs to be done manually) - create a fresh new sldd - call the parameter and bus init fcns of all algo objects

attached to this wrapper and

  • stick their nominal values in the freshly created sldd

syntax obj.init

printinfo()

prints some info of this wrapper object syntax obj.printinfo

setup()

method to setup the wrapper object. Calling this method automatically calls all setups of all underlying algo objects attached to this wrapper. After init+setup, a wrapper block diagram should pass ctrl+d (slx model update) syntax obj.setup

updatetemplatetp()

updates linked tunable parameters in all algos in this wrapper syntax obj.updatetemplatetp