agi.foundation.infrastructure

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

Interface IThreadAware

All Superinterfaces:

ICloneWithContext

All Known Subinterfaces:

IAdjustableState, ICachingEvaluator, IDoubleFunctionSampler, IDurationFunctionSampler, IEvaluator, IEvaluator1<T>, IEvaluatorOverIntervals<TResult,TResultOverIntervals>, IJulianDateFunctionSampler, IParameterizedEvaluator1<TParameter1,TResult>, IParameterizedEvaluator2<TParameter1,TParameter2,TResult>, IParameterizedEvaluator3<TParameter1,TParameter2,TParameter3,TResult>, IParameterizedEvaluator4<TParameter1,TParameter2,TParameter3,TParameter4,TResult>, IParameterizedEvaluator5<TParameter1,TParameter2,TParameter3,TParameter4,TParameter5,TResult>, IParameterizedEvaluator6<TParameter1,TParameter2,TParameter3,TParameter4,TParameter5,TParameter6,TResult>, IParameterizedEvaluator7<TParameter1,TParameter2,TParameter3,TParameter4,TParameter5,TParameter6,TParameter7,TResult>, IParameterizedEvaluatorWithIntervals1<TParameter1,TResult,TResultOverIntervals>, IParameterizedEvaluatorWithIntervals2<TParameter1,TParameter2,TResult,TResultOverIntervals>, IParameterizedEvaluatorWithIntervals3<TParameter1,TParameter2,TParameter3,TResult,TResultOverIntervals>, IParameterizedEvaluatorWithIntervals4<TParameter1,TParameter2,TParameter3,TParameter4,TResult,TResultOverIntervals>, IParameterizedEvaluatorWithIntervals5<TParameter1,TParameter2,TParameter3,TParameter4,TParameter5,TResult,TResultOverIntervals>, IParameterizedEvaluatorWithIntervals6<TParameter1,TParameter2,TParameter3,TParameter4,TParameter5,TParameter6,TResult,TResultOverIntervals>, IParameterizedEvaluatorWithIntervals7<TParameter1,TParameter2,TParameter3,TParameter4,TParameter5,TParameter6,TParameter7,TResult,TResultOverIntervals>, ITimeBasedState, IUpdatePriorToStep, IValueEvaluator<T>

All Known Implementing Classes:

AccessConstraintEvaluator, AccessEntityFilter, AccessEvaluator, ActiveSetSequentialQuadraticProgrammingOptimizer, AdaptiveNumericalIntegrator, AircraftStateElementConverter, ArielCentralBody, AuxiliaryStateElementConverter, AuxiliaryStateElementEvaluator, AxesEvaluator, BasicLaunchSegmentResults, BasicState, BeamformerWeightsEvaluator, BulirschStoerIntegrator, CachingEvaluator, CachingMotionEvaluator1, CalculationContext, CalculationContextFacet, CallistoCentralBody, CartesianStateElementConverter, CentralBodiesFacet, CentralBody, CeresCentralBody, CharonCentralBody, CircularAccessConstraint.CircularAccessConstraintEvaluator, ConstantEvaluator, ConstantParameterizedEvaluator1, ConstantParameterizedEvaluator2, ConstantParameterizedEvaluator3, ConstantParameterizedEvaluator4, ConstantParameterizedEvaluator5, ConstantParameterizedEvaluator6, ConstantParameterizedEvaluator7, ConstantSolarGeophysicalData, CostFunctionSettings, Covariance3By3Evaluator, CssiSolarGeophysicalData, DeimosCentralBody, DelayedTerrainAzimuthElevationMask, DelegateEntityFilter, DependentVariableDerivatives, DependentVariableDifferentialEquation, DioneCentralBody, DirectionsEvaluator, DynamicMatrixEvaluator, DynamicSensorFieldOfViewEvaluator, EarthCentralBody, EarthMoonBarycenter, EnceladusCentralBody, EntityFilter, EuropaCentralBody, Evaluator, EvaluatorDelayedByLink, FiniteManeuverSegmentResults, FollowSegmentBeginningPropagator, FollowSegmentEndingPropagator, FollowSegmentResults, ForceEvaluator, Function2, Function3, GanymedeCentralBody, GaussJacksonIntegrator, HyperionCentralBody, IapetusCentralBody, ImpulsiveManeuverInformation, ImpulsiveManeuverSegmentResults, InequalityConstraintSettings, InternationalTerrestrialReferenceFrameEvaluator, Interpolator, IoCentralBody, ItuRP676AtmosphericValuesEvaluator, ItuRP840AtmosphericValuesEvaluator, JplDEFileEvaluator, JupiterCentralBody, JupiterSystemBarycenter, LeapSecondsFacet, LinkDelayEvaluator, MarsCentralBody, MarsSystemBarycenter, MatrixStateElementConverter, MercuryCentralBody, MimasCentralBody, MinimumMaximumAccessConstraint.MinMaxThresholdEvaluator, MoonCentralBody, MotionEvaluator1, MotionEvaluator2, MultipleStepIntegrator, MultivariableFunctionDifferentialSolver, MultivariableFunctionSolver, NeptuneCentralBody, NeptuneSystemBarycenter, NewtonRaphsonMultivariableFunctionSolver, NormalizedVectorEvaluator, NumericalIntegrator, NumericalPropagator, NumericalPropagatorState, OptimizerMultivariableFunction, ParameterEvaluator, ParameterizedEvaluator, ParameterizedEvaluator1, ParameterizedEvaluator2, ParameterizedEvaluator3, ParameterizedEvaluator4, ParameterizedEvaluator5, ParameterizedEvaluator6, ParameterizedEvaluator7, ParameterizedEvaluatorWithIntervals, ParameterizedEvaluatorWithIntervals1, ParameterizedEvaluatorWithIntervals2, ParameterizedEvaluatorWithIntervals3, ParameterizedEvaluatorWithIntervals4, ParameterizedEvaluatorWithIntervals5, ParameterizedEvaluatorWithIntervals6, ParameterizedEvaluatorWithIntervals7, ParameterizedMotionEvaluator, ParameterizedMotionEvaluator1, ParameterizedMotionEvaluator2, ParameterizedMotionEvaluator3, ParameterizedMotionEvaluator4, ParameterizedMotionEvaluator5, ParameterizedMotionEvaluator6, ParameterizedMotionEvaluator7, ParameterizedMotionEvaluatorWithDerivativeType, ParameterizedMotionEvaluatorWithDerivativeType1, ParameterizedMotionEvaluatorWithDerivativeType2, ParameterizedMotionEvaluatorWithDerivativeType3, ParameterizedMotionEvaluatorWithDerivativeType4, ParameterizedMotionEvaluatorWithDerivativeType5, ParameterizedMotionEvaluatorWithDerivativeType6, ParameterizedMotionEvaluatorWithDerivativeType7, ParameterizedValueEvaluator1, ParameterizedValueEvaluator2, ParameterizedValueEvaluator3, ParameterizedValueEvaluator4, ParameterizedValueEvaluator5, ParameterizedValueEvaluator6, ParameterizedValueEvaluator7, ParameterOptimizer, PartialDerivativesEvaluator, PhobosCentralBody, PhoebeCentralBody, PlanetarySystemBarycenter, PlutoCentralBody, PlutoSystemBarycenter, PointEvaluator, PropagateSegmentConfiguration, PropagateSegmentResults, PropagationStateConverter, PropagationStateCorrectionEvaluator, PropagationStateElementConverter, PropagationStateElementEvaluator, RealValuedScalarFunctionAdapter, ReferenceFrameEvaluator, RheaCentralBody, RotationVectorAngularVelocityStateElementConverter, RungeKutta4Integrator, RungeKuttaAdaptiveStepIntegrator, RungeKuttaAlgorithm, RungeKuttaCashKarp45Integrator, RungeKuttaFehlberg78Integrator, RungeKuttaFixedStepIntegrator, RungeKuttaVerner89Integrator, SaturnCentralBody, SaturnSystemBarycenter, ScalarEvaluator, SegmentListPropagator, SegmentListResults, SegmentPropagator, SegmentPropagatorConstraintEvaluator, SegmentPropagatorCostFunctionEvaluator, SegmentPropagatorInequalityConstraintEvaluator, SegmentPropagatorVariableEvaluator, SegmentResults, SensorProjectionEvaluator, SequentialQuadraticProgrammingOptimizer, SignalEvaluator, SignalPolarizationEvaluator, SignalPropagator, SinglePointStoppablePropagator, SinglePropagateSegmentResults, SolarGeophysicalData, SolarSystemBarycenter, SolvableMultivariableFunction, SolverConstraintSettings, SolverVariableSettings, SphericalTabularGainData, StateElementAdapter, StateEvaluator, StateUpdaterEvaluator, StoppablePropagator, StoppingConditionConstraintEvaluator, StoppingConditionEvaluator, SunCentralBody, SwitchableSegmentResults, TargetedSegmentListFunction, TargetedSegmentListOperatorEvaluator, TargetedSegmentListOptimizerFunction, TargetedSegmentListResults, TethysCentralBody, ThresholdStoppingConditionConstraintEvaluator, TitanCentralBody, TitaniaCentralBody, TorqueEvaluator, TritonCentralBody, UranusCentralBody, UranusSystemBarycenter, ValueEvaluator, VariableGainAmplifierBackoffCurves, VariableGainAmplifierBackoffPolynomial, VectorEvaluator, VenusCentralBody, VestaCentralBody

public interface IThreadAware
extends ICloneWithContext

An interface to an instance that is thread-aware. A thread-aware instance can report whether or not its instance methods are thread safe. It also offers the option to make a copy of itself that can simultaneously be used with this instance from two different threads.

Method Summary

Modifier and Type	Method and Description
boolean	getIsThreadSafe() Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.

Methods inherited from interface agi.foundation.infrastructure.ICloneWithContext

clone

Method Detail

getIsThreadSafe

boolean getIsThreadSafe()

Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.

If this property is true, all methods and properties are guaranteed to be thread safe. Conceptually, an object that returns true for this method acts as if there is a lock protecting each method and property such that only one thread at a time can be inside any method or property in the class. In reality, such locks are generally not used and are in fact discouraged. However, the user must not experience any exceptions or inconsistent behavior that would not be experienced if such locks were used.

If this property is false, the behavior when using this class from multiple threads simultaneously is undefined and may include inconsistent results and exceptions. Clients wishing to use multiple threads should call CopyForAnotherThread.copy(T) to get a separate instance of the object for each thread.