MLCompWriteRef

Pipe Network motion icon

Function - Sets the reference position of a comparator block.

Inputs

Input	Data Type	Range	Unit	Default	Description
BlockID	DINT	-2147483648 to 2147483647	N/A	No default	ID number of an initiated Comparator object.
ThroughZero	BOOL	0, 1	N/A	No default	When TRUE, the system must cross zero and then the reference position before the Transition Flag is set. When FALSE, the Transition Flag is set immediately if the input pipe position is greater then or equal to the Reference value.
Reference	LREAL	No range	User units	No default	New reference position to set in the selected Comparator object.

Output	Data Type	Range	Unit	Description
Default (.Q)	BOOL	FALSE, TRUE	N/A	Returns TRUE when function starts to execute. See Function - General Rules.

Output

Data Type

Range

Unit

Description

Default (.Q)

BOOL

FALSE, TRUE

N/A

Returns TRUE when function starts to execute.

See Function - General Rules.

The Transition Flag of a comparator object turns TRUE if the input position to the comparator is greater or equal to the reference.
The Comparator Transition Flag stays TRUE until it is reset.
If the input ThroughZero is set to TRUE, system must cross zero and then the reference position before the Transition Flag is set.
If ThroughZero is FALSE, Transition Flag is set immediately if the input pipe position is greater then or equal to the Reference value.

Not available.

//Set the Comparator Reference value 
MLCompWriteRef( PipeNetwork.MyComp , TRUE , 45 );