Motion Library - Pipe Network

Name	Description	Return type
MLPipeAct	Activates a pipe	BOOL
MLPipeAddBlock	Adds a Pipe Block to a pipe	BOOL
MLPipeCreate	Creates a new pipe object	None
MLPipeDeact	Deactivates a pipe	BOOL

MLPipeAct

Description

Activates a pipe. 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. The figure below shows two Pipes, both with the same Master Input Pipe Block. The first ends with the first converter, and has a Gear Pipe Block to transform the input values from the Master. The second pipe ends with the second converter, and has a CAM Pipe Block to modify the input values from the Master.

Once a Pipe is activated then history on the values in the Pipe's Blocks are saved and updated each program cycle. A Converter object connected to a destination Axis object cannot send updated position values unless its Pipe is activated.

Figure 8-62: MLPipeAct

• 
  

• All Pipes in the Pipe Network can be activated at once with the command PipeNetwork(MLPN_ACTIVATE). This calls automatically generated code with MLPipeAct commands for each Pipe object. Therefore, in a multi-pipe program only one command can be used to activate Pipes instead of writing code for each Pipe separately.

Arguments

Input

PipeID	Description	ID number of a created Pipe object
	Data type	DINT
	Range	[-2147483648, 2147483648]
	Unit	N/A
	Default	—

Output

Default (.Q)	Description	Returns TRUE if the Pipe is activated See more details here.
	Data type	BOOL
	Unit	N/A

Return Type

BOOL

Related Functions

MLPipeDeact

MLCNVConnect

PipeNetwork(MLPN_ACTIVATE)

MLPipeAddBlock

Example

Structured Text

//Activate a Pipe MLPipeAct( PipeAXIS1 );

Ladder Diagram

 

Function Block Diagram

 [Top]

MLPipeAddBlock

Description

Add a Pipe Block to a pipe. 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.

The figure below shows two Pipes, both with the same Master Input Pipe Block. If a user were to create the Pipe 1 below without using the Graphical Engine, they would use the following commands once a Pipe and the Pipe Blocks have been created.

MLPipeAddBlock( PipeAXIS1, MASTER);

MLPipeAddBlock( PipeAXIS1, MyGear);

MLPipeAddBlock( PipeAXIS1, CNV1);

Figure 8-63: MLPipeAddBlock

• 
  

• All Blocks in the Pipe Network are added to a Pipe automatically. Code with MLPipeAddBlock commands are automatically generated and called in a program with PipeNetwork(MLPN_CREATE_OBJECTS). Therefore, when using the Pipe Network graphical engine to create Pipe Blocks the user does not have to manually add MLPipeAddBlock commands to the Project.

Arguments

Input

PipeID	Description	ID number of a created Pipe
	Data type	DINT
	Range	[-2147483648, 2147483648]
	Unit	N/A
	Default	—
BlockID	Description	ID number of a created Pipe object to add to the selected Pipe
	Data type	DINT
	Range	[-2147483648, 2147483648]
	Unit	N/A
	Default	—

Output

Default (.Q)	Description	Returns TRUE if the Pipe Block is added to the Pipe See more details here.
	Data type	BOOL
	Unit	N/A

Return Type

BOOL

Related Functions

PipeNetwork(MLPN_CREATE_OBJECTS)

MLPipeAct

MLPipeCreate

MLPipeDeact

Example

Structured Text

//Add a block to a pipe MLPipeAddBlock( PipeAXIS1, MyGear );

Ladder Diagram

 

Function Block Diagram

 [Top]

MLPipeCreate

Description

Create a new pipe object. 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. The figure below shows two Pipes, both with the same Master Input Pipe Block.

• 
  

• Pipes are normally created in the Pipe Network using the graphical engine. Then you do not have to add MLPipeCreate function blocks to their programs. Pipes are created graphically, and the code with MLPipeCreate commands are automatically generated and called in a program with PipeNetwork(MLPN_CREATE_OBJECTS).

Arguments

Input

Name	Description	Desired name for the newly created Pipe
	Data type	String
	Range	—
	Unit	N/A
	Default	—

Output

ID	Description	Assigned ID number of the created Pipe
	Data type	DINT
	Unit	N/A
	Default	—

Related Functions

PipeNetwork(MLPN_CREATE_OBJECTS)

MLPipeAddBlock

MLPipeAct

MLPipeDeact

Example

Structured Text

//Create a new pipe PipeAXIS1 := MLPipeCreate( 'PipeAXIS1' );

 

Ladder Diagram

 

Function Block Diagram

 [Top]

MLPipeDeact

Description

Deactivates a pipe. 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. The figure below shows two Pipes, both with the same Master Input Pipe Block. The first ends with the first converter, and has a Gear Pipe Block to transform the input values from the Master. The second pipe ends with the second converter, and has a CAM Pipe Block to modify the input values from the Master.

Once a Pipe is activated then history on the values in the Pipe's Blocks are lost and no longer updated. A Converter object connected to a destination Axis object cannot send updated position values once its Pipe is deactivated.

Figure 8-64: 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. Therefore, in a multi-pipe program only one command can be used to deactivate Pipes instead of writing code for each Pipe separately.

Arguments

Input

PipeID	Description	ID number of a created Pipe object
	Data type	DINT
	Range	[-2147483648, 2147483648]
	Unit	N/A
	Default	—

Output

Default (.Q)	Description	Returns TRUE if the Pipe is deactivated See more details here.
	Data type	BOOL
	Unit	N/A

Return Type

BOOL

Related Functions

MLPipeAct

MLCNVDisconnect

PipeNetwork(MLPN_DEACTIVATE)

MLPipeAddBlock

Example

Structured Text

//Deactivate a Pipe MLPipeDeact( PipeAXIS1 );

Ladder Diagram

Function Block Diagram

 [Top]