MLPipeDeact

Pipe Network motion icon

 FunctionClosed A function calculates a result according to the current value of its inputs. A function has no internal data and is not linked to declared instances. - Deactivates a pipe.

Inputs

Input

Data Type

Range

Unit

Default

Description

PipeID

DINT

-2147483648 to 2147483647

N/A

No default

ID number of a created Pipe object.

Outputs

Output

Data Type

Range

Unit

Description

Default (.Q)

BOOL

 

N/A

Returns TRUE if the Pipe is deactivated.

See Pipe Network - General Rules.

Remarks

A Pipe contains an Input Pipe Block (Master, PMP, or Sampler), a Converter Output Pipe Block, and any Transformation Pipe Block that can be in between.

Figure 1: MLPipeDeact


  • All Pipes in the Pipe Network can be deactivated at once with the command PipeNetwork(MLPN_DEACTIVATE).
    This calls automatically generated code with MLPipeDeact commands for each Pipe object.
    In a multi-pipe programClosed The act of performing a sequence of instructions or commands., only one command can be used to deactivate Pipes instead of writing code for each Pipe separately.

FBD Language Example

FFLD Language Example

IL Language Example

Not available.

ST Language Example

//Deactivate a Pipe
MLPipeDeact( PipeAXIS1 );

See Also