Click or drag to resize

ConstantWindModel Class

Represents a constant wind speed and direction.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Celestial
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.3.420.0 (24.3.420.0)
Syntax
public class ConstantWindModel : WindModel

The ConstantWindModel type exposes the following members.

Constructors
  NameDescription
Public methodConstantWindModel
Initializes a new instance with a default central body of Earth and no wind.
Protected methodConstantWindModel(ConstantWindModel, CopyContext)
Initializes a new instance as a copy of an existing instance.
Public methodConstantWindModel(Double, Double, Double)
Initializes a new instance with a default central body of Earth and the specified parameters.
Public methodConstantWindModel(Double, Double, Double, CentralBody)
Initializes a new instance with the specified parameters.
Top
Properties
  NameDescription
Public propertyCentralBody
Gets or sets the central body that the wind model is associated with.
(Inherited from WindModel.)
Public propertyHorizontalWindSpeed
Gets or sets the horizontal speed of the wind in meters/second.
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 propertyRelativeVelocityVector
Gets a VectorDependentOnServiceProvider that calculates the velocity of a specified point relative to the moving atmosphere according to this wind model.
(Inherited from WindModel.)
Public propertyVerticalWindSpeed
Gets or sets the vertical speed of the wind in meters/second.
Public propertyWindDirection
Gets or sets the direction the wind is coming from in radians, measured clockwise from North toward East.
Public propertyWindVector
Gets a VectorDependentOnServiceProvider that calculates the wind at a specified point.
(Inherited from WindModel.)
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(ConstantWindModel)
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 WindModel.)
Protected methodCheckForSameDefinition(WindModel)
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 WindModelCheckForSameDefinition(WindModel).)
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 WindModelComputeCurrentDefinitionHashCode.)
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.
(Inherited from WindModel.)
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(IServiceProvider)
Gets an instance of an evaluator that can compute the wind.
(Inherited from WindModel.)
Public methodGetEvaluator(EvaluatorGroup, IServiceProvider)
Creates an instance of an evaluator that can compute the wind.
(Overrides WindModelGetEvaluator(EvaluatorGroup, IServiceProvider).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
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.)
Protected methodValidateProperties
Validates that required properties and parameters are configured correctly in order to get an evaluator for this instance. Derived classes should call this method when implementing GetEvaluator(EvaluatorGroup, IServiceProvider), as well as validate their own properties.
(Inherited from WindModel.)
Top
See Also