TransformationalStateElementAdapterDefinition Class

The base type for adapters that do some kind of geometric transformation to an element in the state. For example, when the ReferenceFrame changes.

Inheritance Hierarchy

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

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

Syntax

C++

Copy

public abstract class TransformationalStateElementAdapterDefinition : StateElementAdapterDefinition

Public MustInherit Class TransformationalStateElementAdapterDefinition
	Inherits StateElementAdapterDefinition

public ref class TransformationalStateElementAdapterDefinition abstract : public StateElementAdapterDefinition

[<AbstractClassAttribute>]
type TransformationalStateElementAdapterDefinition =  
    class
        inherit StateElementAdapterDefinition
    end

The TransformationalStateElementAdapterDefinition type exposes the following members.

Constructors

	Name	Description
	TransformationalStateElementAdapterDefinition	Initializes a new instance. The ElementIdentification must be set before GetAdapter(StateElementAdapterDefinition, EvaluatorGroup) is called, as well as any additional properties derived types require.
	TransformationalStateElementAdapterDefinition(TransformationalStateElementAdapterDefinition, CopyContext)	Initializes a new instance as a copy of an existing 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.
	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)

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(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). (Overrides StateElementAdapterDefinitionCheckForSameDefinition(StateElementAdapterDefinition).)
	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).
	Clone	Clones this object using the specified context. (Inherited from DefinitionalObject.)
	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 StateElementAdapterDefinitionComputeCurrentDefinitionHashCode.)
	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. (Overrides StateElementAdapterDefinitionEnumerateDependencies(DependencyEnumerator).)
	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. (Inherited from StateElementAdapterDefinition.)
	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

When creating your own adapters, you must understand the difference between an element definition and a defined in object. The element definition is an object that, among other things, can provide the defined in object which is generally a ReferenceFrame or Axes. The defined in object is the object that the motion would be represented in. For example, when using the NumericalPropagator, a PropagationPointElement would be the element definition, and its IntegrationFrame would be the defined in object.

Some objects (element definitions that are Scalars) do not have a defined in which is acceptable.

Reference

AGI.Foundation.Coordinates Namespace