IF_MulticarrierConfiguration - ConfigureArrayOfMulticarrierCarriers (Method)

Overview

Type:	Method
Available as of:	V1.0.0.0

Task

Setting the array of IF_MulticarrierCarrier and the number of carriers.

Description

With the method ConfigureArrayOfMulticarrierCarriers, you can set the array of IF_MulticarrierCarrier for the Lexium™ MC multi carrier transport system. This array represents the physical alignment of the carriers.

Before calling this method, you must assign carrier objects to the array [1.. GPL.Gc_udiMaxNumberOfCarriers] of SystemConfigurationItf.IF_MulticarrierCarrier. For more information on system configuration, refer to the SystemConfigurationItf library.

Additionally, you can specify the number of carriers on the Lexium™ MC multi carrier track with the input i_udiNumberOfCarriers.

Inputs

Input	Data type	Value range	Description
i_aifMulticarrierCarriers	ARRAY [1.. GPL.Gc_udiMaxNumberOfCarriers] OF SystemConfigurationItf.IF_MulticarrierCarrier	–	Specifies the array of IF_MulticarrierCarrier.
i_udiNumberOfCarriers	UDINT	1 ≤ i_udiNumberOfCarriers ≤ 1.. GPL.Gc_udiMaxNumberOfCarriers	Specifies the number of carriers on the Lexium™ MC multi carrier track.

Outputs

Output	Data type	Description
q_xError	BOOL	Indicates TRUE if an error has been detected. For details, refer to q_etResult and q_sResultMsg.
q_etResult	ET_Result	Provides diagnostic and status information as a numeric value. If q_xError = FALSE, q_etResult provides status information. If q_xError = TRUE, q_etResult provides diagnostic/error information.
q_sResultMsg	STRING [255]	Provides additional diagnostic and status information as a text message.

Call examples

The elements of the array must be assigned in the order of the carrier alignment, starting with array element 1.

GVL.G_aifMulticarrierCarriers[1] = MC_Carrier_1
GVL.G_aifMulticarrierCarriers[2] = MC_Carrier_2
...
ifMulticarrierConfiguration.ConfigureArrayOfMulticarrierCarriers(…)