addSymbol

Add a symbol object definition to a Python Code block

Since R2025a

collapse all in page

Syntax

mySymbol = addSymbol(mySymbolSpec)
mySymbol = addSymbol(mySymbolSpec, name)

Description

mySymbol = addSymbol(mySymbolSpec) creates a Symbol object, mySymbol, and adds the symbol to the SymbolSpec object, mySymbolSpec.

example

mySymbol = addSymbol(mySymbolSpec, name) creates a Symbol object, mySymbol, with the Name property specified by name and adds the symbol to the SymbolSpec object mySymbolSpec.

example

Examples

collapse all

Access and edit the properties of a symbol used in a Python Code block.

Obtain the SymbolSpec object of the Python Code block in your model using get_param. For example, select the Python Code block in the model canvas and enter the following at the command line.

mySymbolSpec = get_param(gcb, 'SymbolSpec');

Use the addSymbol function to specify a new parameter symbol, myParam, in your Python Code block code.

myParam = addSymbol(mySymbolSpec, 'myParam')

The Symbol object, myParam, uses default properties. Specify the scope of the symbol using the Scope property.

myParam.Scope = 'Parameter';

You can use the getSymbol function to access symbols specified for the block. For example, access the parameter symbol you added.

myParam = getSymbol(mySymbolSpec, 'myParam');

Edit the label of the parameter in the Block Parameters dialog box using the Label property.

myParam.Label = 'Amplitude';

To delete a symbol from the SymbolSpec object, use the deleteSymbol function.

deleteSymbol(mySymbolSpec, 'myParam');

Input Arguments

collapse all

Symbol specifications of Python Code block, specified as a SymbolSpec object.

Name of the symbol, specified as a character vector.

Data Types: character

Output Arguments

collapse all

Symbol added to the Python Code block, returned as a Symbol object. The Symbol object has default properties, except when you specify a name for the symbol in the input arguments. You can edit the properties of the Symbol object after creation.

Version History

Introduced in R2025a

See Also

Functions

Objects

Blocks

Topics