IF_MulticarrierConfiguration - ConfigDone (Method)

Overview

Type:

Method

Available as of:

V1.0.0.0

Task

Verifying and completing the configuration of the Lexium™ MC multi carrier transport system.

Description

With the method ConfigDone, the configuration of the Lexium™ MC multi carrier transport system must be verified and completed.

The following aspects are verified:

  • Have the necessary configurations been carried out?

  • Are the configurations valid?

If the configuration is valid and complete, the property xConfigDone in the interface IF_MulticarrierConfiguration is set to the value TRUE.

For more details on the property xConfigDone, refer to IF_MultiCarrierFeedbackConfiguration - General Information.

Inputs

The method has no inputs.

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.

Calls

The following configuration methods must be called successfully before calling the method ConfigDone: 

  1. ifConfiguration.ConfigureMulticarrierTrack(...)
  2. ifConfiguration.ConfigureMulticarrierCarrierPool(...)
  3. ifMulticarrierConfiguration.ConfigureArrayOfMulticarrierSegments(...)
  4. ifMulticarrierConfiguration.ConfigureArrayOfMulticarrierCarriers(...)
  5. ifMulticarrierConfiguration.SetEmergencyParameter(...)