getSymbol - Get a symbol object definition of a C Function block - MATLAB (original) (raw)

• Documentation
• Examples
• Functions
• Blocks
• Apps
• Videos
• Answers

Main Content

Get a symbol object definition of a C Function block

Syntax

Description

[mySymbol](#mw%5F3a61f51a-b5a0-4bbc-9cdb-5d1412202535) = getSymbol([mySymbolSpec](#mw%5Fd680943e-607a-4327-b29c-46e7b6a92543), [name](#mw%5F33cfe957-1ec9-4671-b289-88b8dfacc235)) returns the Symbol object with the Name property specified by name associated with the SymbolSpec object.

example

Examples

collapse all

Access and edit the properties of a symbol used in a C Function block.

Obtain the SymbolSpec object of the C Function block in your model using get_param. For example, select the C Function 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 C Function 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 theLabel property.

myParam.Label = 'Amplitude';

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

deleteSymbol(mySymbolSpec, 'myParam');

Input Arguments

collapse all

Symbol specifications of C Function block, specified as a SymbolSpec object.

Name of the symbol, specified as a character vector.

Data Types: character

Output Arguments

collapse all

Symbol associated with the C Function block, returned as a Symbol object.

Version History

Introduced in R2020a