PreviousNext
Help > Schema > Load > LoadSummary Property
LoadSummary Property

Applies To

API.Load

Description

Gets the summary of the load created by the calculation.

Syntax

Property LoadSummary As API.Load.

Data Type

API. Load.LoadSummary

Remarks

Use this member to access the summarized information of the load. It talks about the number of cargoes loaded and left. And the number of containers filled by the calculation. They are useful for making a quick decision before accessing the other member FilledContainers.

The following parameters are available.

Parameter

Description

CargoesLoaded

The total number of cargoes loaded in the load plan.

PiecesLoaded

The total number of pieces of the cargoes loaded in the load plan.

CargoesLeft

The total number of cargoes left.

PiecesLeft

The total number of pieces of the cargoes left.

UnitloadsLoaded

The total number of unit loads in the load plan.

VolumeLoaded

The total volume of loads in the load plan.

VolPercentLoaded

The total percentage of fill volume to the empty volume in the load plan.

WeightLoaded

The total weight of loads in the load plan.

WeightPercentLoaded

The total percentage of fill weight to the max weight in the load plan.

ContainersLoaded

The total number of containers filled in the load plan.

PriceLoaded

The total price of loads in the load plan.