FiniteManeuverSegmentCreateLimitedFuelStoppingCondition Method (Scalar, Double, String, Boolean, Double) |
Namespace:
AGI.Foundation.SegmentPropagation
Assembly:
AGI.Foundation.SegmentPropagation (in AGI.Foundation.SegmentPropagation.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax public static ScalarStoppingCondition CreateLimitedFuelStoppingCondition(
Scalar fuelAmount,
double fuelAmountThreshold,
string stoppingConditionIdentification,
bool stopPropagation,
double tolerance
)
Public Shared Function CreateLimitedFuelStoppingCondition (
fuelAmount As Scalar,
fuelAmountThreshold As Double,
stoppingConditionIdentification As String,
stopPropagation As Boolean,
tolerance As Double
) As ScalarStoppingCondition
public:
static ScalarStoppingCondition^ CreateLimitedFuelStoppingCondition(
Scalar^ fuelAmount,
double fuelAmountThreshold,
String^ stoppingConditionIdentification,
bool stopPropagation,
double tolerance
)
static member CreateLimitedFuelStoppingCondition :
fuelAmount : Scalar *
fuelAmountThreshold : float *
stoppingConditionIdentification : string *
stopPropagation : bool *
tolerance : float -> ScalarStoppingCondition
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:
ScalarStoppingConditionA
ScalarStoppingCondition that will stop when the fuel amount reaches the specified value.
See Also