Click or drag to resize

AxesLinearRate Class

An axes whose orientation changes with respect to the axes in which it is defined by rotating at a linearly increasing or decreasing rate about a defined spin axis. An initial rotational offset and rotational velocity at a reference epoch, and a constant rotational acceleration are used to define the motion over time.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Geometry
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax
public class AxesLinearRate : Axes

The AxesLinearRate type exposes the following members.

Constructors
  NameDescription
Public methodAxesLinearRate
Initializes a new instance. The user must set ReferenceAxes. ReferenceEpoch is initialized to zero. SpinAxis is initialized to a UnitCartesian whose coordinates are zero. InitialRotation is initialized to Identity. InitialRotationalVelocity and RotationalAcceleration are both initialized to 0.0.
Protected methodAxesLinearRate(AxesLinearRate, CopyContext)
Initializes a new instance as a copy of an existing instance.
Public methodAxesLinearRate(Axes, JulianDate, UnitQuaternion, UnitCartesian, Double, Double)
Initializes a new instance with the specified parameters.
Top
Properties
  NameDescription
Public propertyInitialRotation
Gets or sets the rotational displacement of this axes with respect to the reference axes at the reference epoch.
Public propertyInitialRotationalVelocity
Gets or sets the magnitude of the rotational velocity with respect to the reference axes at the reference epoch.
Public propertyIsFrozen
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.)
Public propertyReferenceAxes
Gets or sets the axes from which this axes is offset.
Public propertyReferenceEpoch
Gets or sets the reference epoch at which the initial rotational displacement and velocity are defined.
Public propertyRotationalAcceleration
Gets or sets the rotational acceleration or rate of change of the rotational velocity.
Public propertySpinAxis
Gets or sets the spin axis with respect to the reference axes.
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(Axes)
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 AxesCheckForSameDefinition(Axes).)
Protected methodCheckForSameDefinition(AxesLinearRate)
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).
Protected methodCheckForSameDefinition(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 Axes.)
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Protected methodComputeCurrentDefinitionHashCode
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 AxesComputeCurrentDefinitionHashCode.)
Public methodEnumerateDependencies
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 DefinitionalObjectEnumerateDependencies(DependencyEnumerator).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
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.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetEvaluator
Gets an evaluator that can be used to find the transformation from this axes' parent axes to this axes at a given date. Consider using the methods of GeometryTransformer instead of calling this method directly. See GetEvaluator(EvaluatorGroup) for details.
(Inherited from Axes.)
Public methodGetEvaluator(EvaluatorGroup)
Gets an evaluator that can be used to find the transformation from the ReferenceAxes at the specified ReferenceEpoch to a new set of axes which spins about the SpinAxis with rates defined by InitialRotationalVelocity and RotationalAcceleration. The new orientation is represented by a Motion<UnitQuaternion, Cartesian> at a given JulianDate.
(Overrides AxesGetEvaluator(EvaluatorGroup).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetService
Gets the service object of the specified type.
(Inherited from Axes.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetVectorElement(CartesianElement)
Creates a Vector representing the X, Y or Z of this axes. Note that the vector returned will return trivial answers unless observed in some other axes. Use the GeometryTransformer to properly observe the vector instead of getting an evaluator directly.
(Inherited from Axes.)
Public methodGetVectorElement(CartesianElement, Int32)
Creates a Vector representing the X, Y or Z of this axes. Note that the vector returned will return trivial answers unless observed in some other axes. Use the GeometryTransformer to properly observe the vector instead of getting an evaluator directly.
(Inherited from Axes.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also