POPULATION

Concept Link IconSee also Concept Link IconExample Concept Link IconFurther information

A Population is a filter which may be applied to the database of a station (using the instruction STATION_FILTER) to control the distribution of variable values and calculation of alarm synthesis.

The POPULATION instruction allows populations to be created using the program language. Populations may also be created interactively from the POPULATION node in the Application Explorer.

WebVue support - Yes.

Mode

Mnemonic

Syntax

1 CREATE 1
2 ADDLINE 2
3 DUMP 3

Syntax 1

IntVal = POPULATION(Mode, Handle);

Return type: INTEGER.

Argument

Meaning

Handle

The handle of a memory buffer.

Execution

Mode

Mnemonic

Action

1

CREATE

One or more populations are created using the definition supplied by the contents of the memory buffer. The contents of the buffer can be created using either Seq_Buffer or Population mode ADDLINE. See example.

Return: 1 if successful, else 0.

Defining the Population

See the topic Defining a Population.

Syntax 2

IntVal = POPULATION(Mode, Handle, Line);

Return type: INTEGER.

Argument

Meaning

Handle

The handle of a memory buffer.

Line A line of a filter. Type STR.

Execution

Mode

Mnemonic

Action

2

ADDLINE

To add a line to a filter. One or more ADDLINE instructions must be followed by a CREATE instruction to complete the population creation.

Return: 1 if successful, else 0.

Syntax 3

IntVal = POPULATION(Mode, Name);

Return type: INTEGER.

Argument

Meaning

Name

See Syntax 1.

Execution

Mode

Mnemonic

Action

3

DUMP

The definition of the named population is displayed in the results area of the Program Management dialog box.

Return: 1 if successful, else 0.

Example

For an example, select the Example link above.