agi.foundation.segmentpropagation

(agi.foundation.segmentpropagation-2024r2.jar)

Class InvalidFuelStateException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

agi.foundation.segmentpropagation.InvalidFuelStateException

All Implemented Interfaces:

Serializable

public class InvalidFuelStateException
extends RuntimeException

An exception that indicates a maneuver caused a craft to run out of fuel.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InvalidFuelStateException() Initializes a new instance with a default message.
InvalidFuelStateException(SegmentDefinition segmentIdentifier, String propagationElementThatRanOut, SegmentListResults cumulativeResults) Initializes a new instance.
InvalidFuelStateException(String message) Initializes a new instance with a specified message.
InvalidFuelStateException(String message, RuntimeException inner) Initializes a new instance with a specified error message and a reference to the inner exception that is the cause of this exception.

Method Summary

Modifier and Type	Method and Description
SegmentListResults	getCumulativeResults() Gets the results of the entire propagation, if available.
String	getPropagationElementThatRanOut() Gets the name of the propagation element that ran out of fuel.
SegmentDefinition	getSegmentIdentifier() Gets the identifier of the segment that ran out of fuel, if available.
String	getSegmentName() Gets the name of the SegmentPropagator that threw the exception.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InvalidFuelStateException

public InvalidFuelStateException()

Initializes a new instance with a default message.

InvalidFuelStateException

public InvalidFuelStateException(String message)

Initializes a new instance with a specified message.

Parameters:

message - The error message that explains the reason for the exception.

InvalidFuelStateException

public InvalidFuelStateException(String message,
                                 RuntimeException inner)

Initializes a new instance with a specified error message and a reference to the inner exception that is the cause of this exception.

Parameters:

message - The error message that explains the reason for the exception.

inner - The exception that is the cause of the current exception.

InvalidFuelStateException

public InvalidFuelStateException(@Nonnull
                                 SegmentDefinition segmentIdentifier,
                                 String propagationElementThatRanOut,
                                 SegmentListResults cumulativeResults)

Initializes a new instance.

Parameters:

segmentIdentifier - The identifier of the segment that ran out of fuel.

cumulativeResults - The SegmentListResults of propagation up to the SegmentPropagator that encountered this exception. This should not include the SegmentResults of the segment that encountered this RuntimeException.

propagationElementThatRanOut - The name of the propagated position and velocity that ran out of fuel.

Method Detail

getSegmentIdentifier

public final SegmentDefinition getSegmentIdentifier()

Gets the identifier of the segment that ran out of fuel, if available.

getPropagationElementThatRanOut

public final String getPropagationElementThatRanOut()

Gets the name of the propagation element that ran out of fuel.

getCumulativeResults

public final SegmentListResults getCumulativeResults()

Gets the results of the entire propagation, if available. This will not include the SegmentResults of the SegmentPropagator that contained the maneuver that ran out of fuel.

getSegmentName

public final String getSegmentName()

Gets the name of the SegmentPropagator that threw the exception.