Click or drag to resize

FiniteManeuverSegmentCreateLimitedFuelStoppingCondition Method (Scalar, Double, String, Boolean, Double)

Creates a ScalarStoppingCondition that will stop when the fuel amount reaches the specified value.

Namespace:  AGI.Foundation.SegmentPropagation
Assembly:  AGI.Foundation.SegmentPropagation (in AGI.Foundation.SegmentPropagation.dll) Version: 20.3.405.0 (20.3.405.0)
Syntax
public static ScalarStoppingCondition CreateLimitedFuelStoppingCondition(
	Scalar fuelAmount,
	double fuelAmountThreshold,
	string stoppingConditionIdentification,
	bool stopPropagation,
	double tolerance
)

Parameters

fuelAmount
Type: AGI.Foundation.GeometryScalar
The amount of fuel, often the IntegrationValue of a PropagationScalar.
fuelAmountThreshold
Type: SystemDouble
The amount of fuel that the returned condition will stop at.
stoppingConditionIdentification
Type: SystemString
A name for the StoppingCondition.
stopPropagation
Type: SystemBoolean
Indicates if the StoppingCondition actually stops propagation, or if it should only indicate when fuel runs out but allow propagation continue with 0 fuel remaining.
tolerance
Type: SystemDouble
The tolerance to use.

Return Value

Type: ScalarStoppingCondition
A ScalarStoppingCondition that will stop when the fuel amount reaches the specified value.
See Also