FB_CoreStation - AddCarrier (Method)

Overview

Type:	Method
Available as of:	V1.0.0.0

Adding a carrier to the station.

With the method AddCarrier, you can add a carrier object from the Multicarrier library to the station.

In a typical implementation, the procedure is as follows:

When the Lexium™ MC multi carrier track is enabled, the carriers are moved into the first station.
The carriers must be added to this first station.
Once the carriers have been added to the first station, you do not need to add them to further stations. Instead, the carriers are handed over to the next station with the method HandoverCarriersToTargetStation.

For a visual illustration of the method AddCarrier, refer to the AddCarrier video sequence.

Input	Data type	Description
i_ifCarrier	MCR.IF_Carrier	Carrier object from the Multicarrier library. For more information, refer to the Multicarrier library.

Input

Data type

Description

i_ifCarrier

MCR.IF_Carrier

Carrier object from the Multicarrier library.

For more information, refer to the Multicarrier library.

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.

The method AddCarrier is assigned the access specifier FINAL. This helps to protect the method from being overwritten.