ReferenceFrameAdapter Class

The StateElementAdapter definition for the simple case when the element's definitional object and its defined in object are just a ReferenceFrame. Generally this will be used for various Point types.

Inheritance Hierarchy

SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.CoordinatesStateElementAdapterDefinition
      AGI.Foundation.CoordinatesTransformationalStateElementAdapterDefinition
        AGI.Foundation.CoordinatesReferenceFrameAdapter

Namespace: AGI.Foundation.Coordinates
Assembly: AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.3.420.0 (24.3.420.0)

Syntax

C++

Copy

public class ReferenceFrameAdapter : TransformationalStateElementAdapterDefinition

Public Class ReferenceFrameAdapter
	Inherits TransformationalStateElementAdapterDefinition

public ref class ReferenceFrameAdapter : public TransformationalStateElementAdapterDefinition

type ReferenceFrameAdapter =  
    class
        inherit TransformationalStateElementAdapterDefinition
    end

The ReferenceFrameAdapter type exposes the following members.

Constructors

	Name	Description
	ReferenceFrameAdapter	Initializes a new instance. The ElementIdentification and CurrentReferenceFrame must be set before GetAdapter(StateElementAdapterDefinition, EvaluatorGroup) is called.
	ReferenceFrameAdapter(ReferenceFrameAdapter, CopyContext)	Initializes a new instance as a copy of an existing instance.
	ReferenceFrameAdapter(String, ReferenceFrame)	Initializes a new instance.

Top

Properties

	Name	Description
	CurrentDefinedIn	Gets or sets the current defined in object. This is just for ease of use when developing your own adapters. (Inherited from TransformationalStateElementAdapterDefinition.)
	CurrentReferenceFrame	Gets or sets the ReferenceFrame that the element in the state will be in once the state is adapted.
	ElementIdentification	Gets or sets the identification of the element in the state that will be adapted. (Inherited from StateElementAdapterDefinition.)
	IsFrozen	Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so. (Inherited from DefinitionalObject.)
	PreviousDefinedIn	Gets or sets the previous defined in object. This is just for ease of use when developing your own adapters. It is best to configure whatever is calling GetAdapter(StateElementAdapterDefinition, EvaluatorGroup) to pass in an old adapter. If there is no old defined in to work with, then use the CurrentDefinedIn for both the current and previous. If this is set, then it should take priority over the adapter passed into GetAdapter(StateElementAdapterDefinition, EvaluatorGroup) (Inherited from TransformationalStateElementAdapterDefinition.)
	PreviousReferenceFrame	Gets or sets the ReferenceFrame that the element in the previous state is defined in. It is best to configure whatever is calling GetAdapter(StateElementAdapterDefinition, EvaluatorGroup) to pass in an old adapter. If there is no old defined in to work with, then the CurrentReferenceFrame will be used for both the current and previous. This only needs to be set if it there is no previous adapter to use when the computation options (evaluators, propagators...) are created. If this is set, then it should take priority over the adapter passed into GetAdapter(StateElementAdapterDefinition, EvaluatorGroup)

Top

Methods

	Name	Description
	CheckForSameDefinition(DefinitionalObject)	Checks to determine if another instance has the same definition as this instance and returns 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 for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object). (Inherited from StateElementAdapterDefinition.)
	CheckForSameDefinition(ReferenceFrameAdapter)	Checks to determine if another instance has the same definition as this instance and returns 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 for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
	CheckForSameDefinition(StateElementAdapterDefinition)	Checks to determine if another instance has the same definition as this instance and returns 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 for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object). (Inherited from TransformationalStateElementAdapterDefinition.)
	CheckForSameDefinition(TransformationalStateElementAdapterDefinition)	Checks to determine if another instance has the same definition as this instance and returns 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 for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object). (Overrides TransformationalStateElementAdapterDefinitionCheckForSameDefinition(TransformationalStateElementAdapterDefinition).)
	Clone	Clones this object using the specified context. (Overrides DefinitionalObjectClone(CopyContext).)
	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 CheckForSameDefinition(DefinitionalObject) method. (Overrides TransformationalStateElementAdapterDefinitionComputeCurrentDefinitionHashCode.)
	EnumerateDependencies	Enumerates the dependencies of this object by calling EnumerateT(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. (Inherited from TransformationalStateElementAdapterDefinition.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	Freeze	Freezes this object. Further attempts to modify it will result in an ObjectFrozenException. (Inherited from DefinitionalObject.)
	FreezeAggregatedObjects	Called by 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. (Inherited from DefinitionalObject.)
	GetAdapter	Creates the adapter defined by this instance. Since adapters are meant to transition from one context to another, the previous adapter is passed in to finish the configuration. If it is not needed for your particular adapter it can be ignored. (Overrides StateElementAdapterDefinitionGetAdapter(StateElementAdapterDefinition, EvaluatorGroup).)
	GetDefinitionHashCode	Gets a hash code representing the definition of this object. (Inherited from DefinitionalObject.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsSameDefinition	Determines if this object has the same definition as another object. (Inherited from DefinitionalObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ThrowIfFrozen	Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object. (Inherited from DefinitionalObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

This type will create an adapter that will extract a MotionT of the specified element from the first ITimeBasedState, perform a ReferenceFrame transformation on it, and save that transformed MotionT to the second state.

If you have some custom point element getting propagated, create a StateElementAdapterDefinition that handles your unique element definition. But have your GetAdapter method construct an instance of this factory and return this types adapter.

The actual adapter will detect if the previous and current frames are the same, and no transformation will be done in that case (to prevent round trip errors).

Reference

AGI.Foundation.Coordinates Namespace