coder.descriptor.DataTransferFunction Class

Namespace: coder.descriptor
Superclasses: coder.descriptor.FunctionInterface

Return information about function prototypes for data transfer service interfaces

Since R2022b

Description

An object of the coder.descriptor.DataTransferFunction class represents the data transfer function interface in the generated code.

Properties

Prototype — Description of function prototype

coder.descriptor.Prototype object

Description of the function prototype, including the function return value, name, arguments, header, and source file, specified as a coder.descriptor.Prototype object.

Attributes:

GetAccess	public
SetAccess	public

ActualReturn — Return arguments from function

coder.descriptor.DataInterface object

Return arguments from the function, specified as a coder.descriptor.DataInterface object. When the function returns no data, this field is empty.

Attributes:

GetAccess	public
SetAccess	public

VariantInfo — Variant conditions in model

coder.descriptor.VariantInfo object

Variant conditions in the model that interact with the function interface, specified as a coder.descriptor.VariantInfo object.

Attributes:

GetAccess	public
SetAccess	public

FunctionOwner — Function owner

coder.descriptor.TypedRegion object

Function owner of the class that the function belongs to, specified as a coder.descriptor.TypedRegion object. For C code generation, this property is empty.

Attributes:

GetAccess	public
SetAccess	public

Timing — Function access rate in target environment

coder.descriptor.TimingInterface object

Function access rate in the target environment, specified as a coder.descriptor.TimingInterface object.

Attributes:

GetAccess	public
SetAccess	public

ActualArgs — Input arguments to the function

coder.descriptor.DataInterfaceList object

Input arguments to the function, specified as a coder.descriptor.DataInterfaceList object. When there is no data passed as an argument to the function, this property is empty.

Attributes:

GetAccess

public

FunctionType — Function type

Set | Get

Type of access function, specified as an enumerated value of Set or Get.

Attributes:

GetAccess	public
SetAccess	public

Version History

Introduced in R2022b