WorldMagneticModelVector Class |
Represents the magnetic field vector at a point due to
the Earth's magnetic field, as modeled by a WMM model.
Inheritance HierarchySystemObject
AGI.Foundation.InfrastructureDefinitionalObject
AGI.Foundation.GeometryVector
AGI.Foundation.CelestialMagneticFieldVector
AGI.Foundation.CelestialWorldMagneticModelVector
AGI.Foundation.InfrastructureDefinitionalObject
AGI.Foundation.GeometryVector
AGI.Foundation.CelestialMagneticFieldVector
AGI.Foundation.CelestialWorldMagneticModelVector
Namespace: AGI.Foundation.Celestial
Assembly: AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.3.420.0 (24.3.420.0)
SyntaxThe WorldMagneticModelVector type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | WorldMagneticModelVector |
Initializes a new instance. The DefinedInFrame is set to the
PrincipalFrame of Earth as obtained from the current CentralBodiesFacet.
The ReferenceDistance is set to EarthReferenceDistance.
Typically, this constructor is not used directly. Rather, ReadFile(String) is
used to create the IGRF magnetic field vector.
|
| WorldMagneticModelVector(TimeIntervalCollectionSphericalHarmonicCoefficients, TimeIntervalCollectionSphericalHarmonicCoefficients) |
Initializes a new instance. Typically, this constructor is not used directly.
Rather, ReadFile(String) is used to create the IGRF magnetic field vector.
|
 | WorldMagneticModelVector(WorldMagneticModelVector, CopyContext) | Initializes a new instance as a copy of an existing instance. |
| WorldMagneticModelVector(TimeIntervalCollectionSphericalHarmonicCoefficients, TimeIntervalCollectionSphericalHarmonicCoefficients, Point) |
Initializes a new instance. Typically, this constructor is not used directly.
Rather, ReadFile(String) is used to create the IGRF magnetic field vector.
|
Properties| Name | Description | |
|---|---|---|
 | DefinedInFrame |
Gets or sets the reference frame for the magnetic field.
(Inherited from MagneticFieldVector.) |
| InitialMagneticFieldCoefficients |
Gets or sets the collection that represents the static spherical-harmonic magnetic field
coefficients that are valid at the beginning of specific time intervals. These are in tesla.
(Inherited from MagneticFieldVector.) |
| 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.) |
| MagneticFieldCoefficientRates |
Gets or sets the collection that represents the rates of change of the
spherical-harmonic magnetic field coefficients during specific time intervals.
These are in tesla/year.
(Inherited from MagneticFieldVector.) |
| ReferenceDistance |
Gets or sets the reference distance for the magnetic field model. This value
is typically the average or equatorial radius of the CentralBody in meters. For the
IGRF and WMM models, this value is EarthReferenceDistance.
(Inherited from MagneticFieldVector.) |
| TargetPoint |
Gets or sets the point where the magnetic field vector is calculated.
(Inherited from MagneticFieldVector.) |
Methods| Name | Description | |
|---|---|---|
| Add |
Add a vector to this one.
(Inherited from Vector.) |
| 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 Vector.) |
| CheckForSameDefinition(MagneticFieldVector) |
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 MagneticFieldVectorCheckForSameDefinition(MagneticFieldVector).) |
| CheckForSameDefinition(Vector) |
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 MagneticFieldVector.) |
| CheckForSameDefinition(WorldMagneticModelVector) |
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 MagneticFieldVectorClone(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 MagneticFieldVectorComputeCurrentDefinitionHashCode.) |
| CreateVectorDerivative |
Constructs a vector which represents a derivative of this vector.
(Inherited from Vector.) |
| Cross |
Produce the vector cross product between this vector and another one.
(Inherited from Vector.) |
| Divide(Double) |
Divide this vector by a scale factor.
(Inherited from Vector.) |
| Divide(Scalar) |
Divide this vector by a scale factor.
(Inherited from Vector.) |
| Dot |
Produce the vector dot product between this vector and another one.
(Inherited from Vector.) |
| 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 MagneticFieldVector.) |
| 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 Motion<Cartesian>
of this vector at a given date with respect to the axes in which it is defined.
See GetEvaluator(EvaluatorGroup) for details.
(Inherited from Vector.) |
| GetEvaluator(EvaluatorGroup) |
Gets an evaluator that can be used to find the
Motion<Cartesian>
of this vector in its parent Axes
at a given JulianDate.
Consider using the methods of GeometryTransformer
instead of calling this method directly.
(Inherited from MagneticFieldVector.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetScalarElement(CartesianElement, Axes) |
Gets a Scalar representing the X, Y, Z, or Magnitude of this vector.
(Inherited from Vector.) |
| GetScalarElement(CartesianElement, Axes, Int32) |
Gets a Scalar representing the X, Y, Z, or Magnitude of this vector,
or any derivative of those elements.
(Inherited from Vector.) |
| GetService |
Gets the service object of the specified type.
(Inherited from Vector.) |
| 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) |
Multiply this vector by a scale factor.
(Inherited from Vector.) |
| Multiply(Scalar) |
Multiply this vector by a scale factor.
(Inherited from Vector.) |
 | ReadFile(String) | Reads a WMM file and creates a magnetic field vector from it. Note that the final block of the InitialMagneticFieldCoefficients and MagneticFieldCoefficientRates will extend indefinitely into the future. Also, note that the units of the magnetic field vector are in tesla, the TargetPoint will still need to be set, and the magnetic field vector will be resolved in the Axes of the PrincipalFrame of Earth as obtained from the current CentralBodiesFacet unless the DefinedInFrame is set. The ReferenceDistance is set to EarthReferenceDistance, which is the official reference distance for the WMM models. |
| ReadFile(TextReader) | Reads a WMM file and creates a magnetic field vector from it. Note that the final block of the InitialMagneticFieldCoefficients and MagneticFieldCoefficientRates will extend indefinitely into the future. Also, note that the units of the magnetic field vector are in tesla, the TargetPoint will still need to be set, and the magnetic field vector will be resolved in the Axes of the PrincipalFrame of Earth as obtained from the current CentralBodiesFacet unless the DefinedInFrame is set. The ReferenceDistance is set to EarthReferenceDistance, which is the official reference distance for the WMM models. |
| Subtract |
Subtract a vector from this one.
(Inherited from Vector.) |
| 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 https://www.ngdc.noaa.gov/geomag/WMM/soft.shtml
for more information about the WMM model.
See Also