agi.foundation.segmentpropagation

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

Class SegmentConfiguration

java.lang.Object

agi.foundation.segmentpropagation.SegmentConfiguration

All Implemented Interfaces:

ICloneWithContext

Direct Known Subclasses:

BasicLaunchSegmentConfiguration, ImpulsiveManeuverSegmentConfiguration, InitialStateSegmentConfiguration, ReturnSegmentConfiguration, SegmentListConfiguration, StopSegmentConfiguration, UpdateSegmentConfiguration

public abstract class SegmentConfiguration
extends Object
implements ICloneWithContext

The configuration for a SegmentPropagator. This configuration must be mutable and it must have all of the settings that some outer operation may want to change to drive the segment to propagate towards a common result. SegmentConfigurations will be created by the segment when the propagator is created and potentially changed by a TargetedSegmentListOperator.

If writing your own SegmentDefinition and SegmentPropagator, it is best to create a specific SegmentConfiguration for that new segment. Generally, all of the settings on the SegmentDefinition should be reflected in this configuration.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SegmentConfiguration() Initializes a new instance.
protected	SegmentConfiguration(SegmentConfiguration existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
abstract Object	clone(CopyContext context) Clones this object using the specified context.
ITimeBasedState	getDefaultInitialState() Gets the initial state of the segment.
boolean	getIsNonNominalRunDifferent() Gets a value indicating whether the associated SegmentPropagator will behave differently if it is being run nominally or not.
boolean	getNominalRun() Gets a value indicating whether this segment is being run normally and as such its results should be included as the final results, or if this segment is being run as part of some other operation (commonly this is set to false to indicate if the segment is being run in a TargetedSegmentListOperator).
void	setDefaultInitialState(ITimeBasedState value) Sets the initial state of the segment.
void	setNominalRun(boolean value) Sets a value indicating whether this segment is being run normally and as such its results should be included as the final results, or if this segment is being run as part of some other operation (commonly this is set to false to indicate if the segment is being run in a TargetedSegmentListOperator).

Methods inherited from class java.lang.Object

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

Constructor Detail

SegmentConfiguration

protected SegmentConfiguration()

Initializes a new instance.

SegmentConfiguration

protected SegmentConfiguration(@Nonnull
                               SegmentConfiguration existingInstance,
                               @Nonnull
                               CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

clone

public abstract Object clone(CopyContext context)

Clones this object using the specified context.

This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.

A typical implementation of ICloneWithContext:

public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}

In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.

alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}

If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.

public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;

Specified by:

clone in interface ICloneWithContext

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

getNominalRun

public boolean getNominalRun()

Gets a value indicating whether this segment is being run normally and as such its results should be included as the final results, or if this segment is being run as part of some other operation (commonly this is set to false to indicate if the segment is being run in a TargetedSegmentListOperator). By default this is true. Override this property when one SegmentConfiguration manages another SegmentConfiguration (as in the case of a SegmentList) and have the overridden setter set the property on all wrapped configuration.

setNominalRun

public void setNominalRun(boolean value)

Sets a value indicating whether this segment is being run normally and as such its results should be included as the final results, or if this segment is being run as part of some other operation (commonly this is set to false to indicate if the segment is being run in a TargetedSegmentListOperator). By default this is true. Override this property when one SegmentConfiguration manages another SegmentConfiguration (as in the case of a SegmentList) and have the overridden setter set the property on all wrapped configuration.

getIsNonNominalRunDifferent

public boolean getIsNonNominalRunDifferent()

Gets a value indicating whether the associated SegmentPropagator will behave differently if it is being run nominally or not. You should overload this property to return true if the specific segment type might behave differently in an unofficial propagation. By default this returns false indicating that there is no difference.

Returns:

true if the SegmentPropagator will behave differently based on the NominalRun (get / set) settings; otherwise false.

getDefaultInitialState

public ITimeBasedState getDefaultInitialState()

Gets the initial state of the segment. Note that this property may not be edited by a SegmentPropagatorVariable.

setDefaultInitialState

public void setDefaultInitialState(ITimeBasedState value)

Sets the initial state of the segment. Note that this property may not be edited by a SegmentPropagatorVariable.