Engee documentation

Function-Call Generator

Function call events to control the execution of a subsystem or model.

blockType: FunctionCallGenerator

Path in the library:

/Basic/Ports & Subsystems/Function-Call Generator

Description

Block Function-Call Generator provides function call events that execute the function call subsystem or the function call model with the frequency specified by the Sample time parameter. A function call subsystem or function call model is a subsystem or model containing a block Trigger, for which the Trigger type parameter is set to function-call.

To iteratively execute each function call subsystem or function call model several times at each time step, use the Number of iterations parameter.

To execute several function call subsystems or function call models in a specific order, use the block Function-Call Generator with a block Function-Call Split.

Ports

Output

# OUT_1 — Output signal
FunctionCallEvent

Details

Sends function call events to the input port of the function call subsystem or the function call model. This port has no name in the block.

FunctionCallEvent — this is a special output signal type that the unit produces Function-Call Generator, showing the need for a function call event.

Data types

Float64

Complex numbers support

I don’t

Parameters

Main

# Sample time — time interval
SampleTime (real number / vector of two real numbers)

Details

Specify the time interval between function call events for the function call subsystem or the function call model. If the actual frequency of calls to the subsystem or model differs from the interval specified by this parameter, the system displays an error.

By default block Function-Call Generator uses a time interval equal to 1. To set a different interval, enter a valid sampling step or specify -1 to inherit the time interval from the model.

Default value

1

Program usage name

SampleTime

Tunable

No

Evaluatable

Yes

# Number of iterations — number of function calls at each time step
Int64 integer

Details

Number of function calls at each time step:

  • 1 — provides a function call once at each time step.

  • an integer — an integer with or without a sign. Provides a specified number of function calls at each time step.

Default value

1

Program usage name

NumberOfIterations

Tunable

No

Evaluatable

Yes

Examples