ScalarRouteTotalSpeed Class |
A scalar representing the total speed with respect to the ellipsoid surface upon which the route is defined. This includes both the horizontal and vertical components of velocity.
This represents the "flat" total speed without taking into account the effects of the curvature of the non-euclidean Ellipsoid surface of the central body. The effect of the curvature tends to be small for values near the surface, creating discrepancies of less than a millimeter per second in the velocity. If the route is defined with respect to ragged terrain, the effect of that terrain with respect to the underlying surface is much more significant than the curvature of the underlying surface. The derivative of this scalar will differ slightly from the value of the instantaneous fixed-frame velocity.
Note that it may be counter intuitive that the Value reported by this scalar represents the "speed" while the FirstDerivative represents the acceleration (derivative of speed).
Inheritance HierarchySystemObject
AGI.Foundation.InfrastructureDefinitionalObject
AGI.Foundation.GeometryScalar
AGI.Foundation.GeometryScalarRouteTotalSpeed
AGI.Foundation.InfrastructureDefinitionalObject
AGI.Foundation.GeometryScalar
AGI.Foundation.GeometryScalarRouteTotalSpeed
Namespace: AGI.Foundation.Geometry
Assembly: AGI.Foundation.RouteDesign (in AGI.Foundation.RouteDesign.dll) Version: 24.3.420.0 (24.3.420.0)
SyntaxThe ScalarRouteTotalSpeed type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ScalarRouteTotalSpeed |
Create a new instance. The Route must be set before calling GetEvaluator(EvaluatorGroup).
By default, the HeightReferenceSurface is set to use the surface of the
EarthCentralBody from the CentralBodiesFacet |
| ScalarRouteTotalSpeed(PropagatedRoute, TerrainProvider) |
Create a new instance based on the given route and reference surface.
|
 | ScalarRouteTotalSpeed(ScalarRouteTotalSpeed, CopyContext) | Initializes a new instance as a copy of an existing instance. |
Properties| Name | Description | |
|---|---|---|
 | HeightReferenceSurface |
Gets or sets the reference surface above which this scalar is defined. This
will determine the height and then the vertical speed used to compute the total speed.
|
| 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.) |
| Route |
Gets or sets the route from which to obtain the total speed for this scalar.
|
Methods| Name | Description | |
|---|---|---|
| Add(Double) |
Adds a fixed scalar to this one.
(Inherited from Scalar.) |
| Add(Scalar) |
Adds another scalar to this one.
(Inherited from Scalar.) |
| 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 Scalar.) |
| CheckForSameDefinition(Scalar) |
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 ScalarCheckForSameDefinition(Scalar).) |
| CheckForSameDefinition(ScalarRouteTotalSpeed) |
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.
(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 ScalarComputeCurrentDefinitionHashCode.) |
| CreateScalarDerivative |
Constructs a scalar which represents a derivative of this scalar.
(Inherited from Scalar.) |
| Divide(Double) |
Divides this scalar (numerator) by a fixed value (denominator).
(Inherited from Scalar.) |
| Divide(Scalar) |
Divides this scalar (numerator) by another one (denominator).
(Inherited from Scalar.) |
| 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 DefinitionalObjectEnumerateDependencies(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.) |
| GetDefinitionHashCode |
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.) |
| GetEvaluator |
Gets an evaluator that can be used to find the value of this scalar function at a given JulianDate.
(Inherited from Scalar.) |
| GetEvaluator(EvaluatorGroup) |
Gets an evaluator that can be used to find the Motion<double>
of this scalar at a given JulianDate.
Adds the evaluator to the EvaluatorGroup.
(Overrides ScalarGetEvaluator(EvaluatorGroup).) |
| 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.) |
| Multiply(Double) |
Multiplies this scalar with a fixed value.
(Inherited from Scalar.) |
| Multiply(Scalar) |
Multiplies another scalar with this one.
(Inherited from Scalar.) |
| Power |
Raises this scalar to the given fixed exponent.
(Inherited from Scalar.) |
| Subtract(Double) |
Subtracts a fixed scalar from this one.
(Inherited from Scalar.) |
| Subtract(Scalar) |
Subtracts another scalar from this one.
(Inherited from Scalar.) |
| 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.) |
Remarks
See the Profiles topic
for more detail on how this scalar is defined.
See Also