agi.foundation.platforms

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

Class Platform

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.infrastructure.ExtensibleObject

agi.foundation.platforms.Platform

All Implemented Interfaces:

IKinematicStateService, ILocationPointService, IOrientationAxesService, ISetOrientationAxesService, ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, INameService, IParentService, IServiceProvider

Direct Known Subclasses:

ComplexAnalogTransmitter, ComplexDigitalTransmitter, ComplexReceiver, GpsCommunicationsFrontEnd, OpticalReceiver, OpticalTransmitter, SimpleAnalogTransmitter, SimpleDigitalTransmitter, SimpleReceiver

public class Platform
extends ExtensibleObject
implements IKinematicStateService, ILocationPointService, IOrientationAxesService, ISetOrientationAxesService, IParentService, INameService

A generic platform with a location and orientation relative to a parent platform. Examples of platforms include satellites, facilities, and aircraft.

Constructor Summary

Constructors

Modifier	Constructor and Description
	Platform() Initializes a new instance.
protected	Platform(Platform existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	Platform(String name) Initializes a new instance with a specified name.
	Platform(String name, Point locationPoint, Axes orientationAxes) Initializes a new instance with a specified name, time-varying position, and time-varying orientation.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(ExtensibleObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(Platform other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
Object	clone(CopyContext context) Clones this object using the specified context.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
protected void	freezeAggregatedObjects() Called by DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object.
PlatformCollection	getChildren() Gets the collection containing the children of this Platform.
Point	getLocationPoint() Gets the time-varying location of this platform.
String	getName() Gets the name of the platform.
Axes	getOrientationAxes() Gets the time-varying orientation of this platform.
Platform	getParent() Gets the parent platform of this platform.
ReferenceFrame	getReferenceFrame() Gets the reference frame of this platform formed by the combination of the platform's location and orientation.
Object	getService(Class<?> serviceType) Gets the service object of the specified type.
void	setLocationPoint(Point value) Sets the time-varying location of this platform.
void	setName(String value) Sets the name of the platform.
void	setOrientationAxes(Axes value) Sets the time-varying orientation of this platform.

Methods inherited from class agi.foundation.infrastructure.ExtensibleObject

checkForSameDefinition, getExtensions

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

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

Constructor Detail

Platform

public Platform()

Initializes a new instance.

Platform

public Platform(String name)

Initializes a new instance with a specified name.

Parameters:

name - The name of the platform.

Platform

public Platform(String name,
                Point locationPoint,
                Axes orientationAxes)

Initializes a new instance with a specified name, time-varying position, and time-varying orientation.

Parameters:

name - The name of the platform.

locationPoint - A Point describing the position of the platform over time.

orientationAxes - An Axes describing the orientation of the platform over time.

Platform

protected Platform(@Nonnull
                   Platform 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 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

Overrides:

clone in class ExtensibleObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected final boolean checkForSameDefinition(ExtensibleObject other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Overrides:

checkForSameDefinition in class ExtensibleObject

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected boolean checkForSameDefinition(Platform other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the Platform.checkForSameDefinition(agi.foundation.infrastructure.ExtensibleObject) method.

Overrides:

computeCurrentDefinitionHashCode in class ExtensibleObject

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class ExtensibleObject

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

freezeAggregatedObjects

protected void freezeAggregatedObjects()

Called by DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.

Overrides:

freezeAggregatedObjects in class ExtensibleObject

getName

public final String getName()

Gets the name of the platform.

Specified by:

getName in interface INameService

setName

public final void setName(String value)

Sets the name of the platform.

getParent

public final Platform getParent()

Gets the parent platform of this platform.

Specified by:

getParent in interface IParentService

getChildren

@Nonnull
public final PlatformCollection getChildren()

Gets the collection containing the children of this Platform.

getLocationPoint

public final Point getLocationPoint()

Gets the time-varying location of this platform.

Specified by:

getLocationPoint in interface ILocationPointService

setLocationPoint

public final void setLocationPoint(Point value)

Sets the time-varying location of this platform.

getOrientationAxes

public final Axes getOrientationAxes()

Gets the time-varying orientation of this platform.

Specified by:

getOrientationAxes in interface IOrientationAxesService

setOrientationAxes

public final void setOrientationAxes(Axes value)

Sets the time-varying orientation of this platform.

Specified by:

setOrientationAxes in interface ISetOrientationAxesService

getReferenceFrame

@Nonnull
public final ReferenceFrame getReferenceFrame()

Gets the reference frame of this platform formed by the combination of the platform's location and orientation.

Specified by:

getReferenceFrame in interface IKinematicStateService

getService

public Object getService(Class<?> serviceType)

Gets the service object of the specified type.

Specified by:

getService in interface IServiceProvider

Overrides:

getService in class ExtensibleObject

Parameters:

serviceType - An object that specifies the type of service object to get.

Returns:

The found service, or null if the service does not exist.

Throws:

ArgumentNullException - Thrown when serviceType is null.