Configure

Configuring the algorithm. The output cascades can be set using the SetCascades() method.

Syntax

Definition:

METHOD Configure : BOOL
VAR_INPUT
    nNumCascades : UDINT;
    fSampleRate : LREAL;
    eStartupBehaviour : E_ALY_CascadeStartupBehaviour;
END_VAR

Configure 1: Inputs

Name

Type

Description

nNumCascades

UDINT

Number of output cascades

fSampleRate

LREAL

Sampling rate of the system to be analyzed in Hz

eStartupBehaviour

E_ALY_CascadeStartupBehaviour

Start-up behavior

WaitUntilFilled

Waits until the configured timespan of the cascade has elapsed. The RMS result and the Boolean flag "NewResult" are only set for the first time after the timespan has elapsed.

UsePreviousCascadeValue

The RMS cascades whose configured timespan has not yet expired use the next smallest RMS result already set.

Configure 2: Return value

Name

Type

Description

Configure

BOOL

Returns TRUE if successful.