SetInital

Initialize internal values of the algorithm.

Syntax

Definition:

METHOD SetInitial : BOOL
VAR_INPUT
    eHistMode : E_ALY_HistMode;
    nNumValues : ULINT;
    pHistArrayIn : PVOID;
    nHistArrayInSize : UDINT;
END_VAR

SetInital 1: Inputs

Name

Type

Description

eStateHistMode

E_ALY_HistMode

Operation mode of the histogram.

Abs: Absolute values

Rel: Relative values to show the percentage distribution.

nNumValues

ULINT

Number of values that will be stored in the histogram.

pHistArrayIn

PVOID

Pointer to the histogram array that is to be defined as the output values. The data type depends on the configured mode.

Abs: ULINT

Rel: LREAL

nHistArrayInSize

UDINT

Size of the histogram array to be defined as the output values. Dim.: nMax – nMin + 3

SetInital 2: Return value

Name

Type

Description

SetInitial

BOOL

Returns TRUE if successful.