Click or drag to resize

WorldMagneticModelVector Class

Represents the magnetic field vector at a point due to the Earth's magnetic field, as modeled by a WMM model.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Celestial
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax
public class WorldMagneticModelVector : MagneticFieldVector

The WorldMagneticModelVector type exposes the following members.

Constructors
  NameDescription
Public methodWorldMagneticModelVector
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.
Public methodWorldMagneticModelVector(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.
Protected methodWorldMagneticModelVector(WorldMagneticModelVector, CopyContext)
Initializes a new instance as a copy of an existing instance.
Public methodWorldMagneticModelVector(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.
Top
Properties
  NameDescription
Public propertyDefinedInFrame
Gets or sets the reference frame for the magnetic field.
(Inherited from MagneticFieldVector.)
Public propertyInitialMagneticFieldCoefficients
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.)
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 propertyMagneticFieldCoefficientRates
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.)
Public propertyReferenceDistance
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.)
Public propertyTargetPoint
Gets or sets the point where the magnetic field vector is calculated.
(Inherited from MagneticFieldVector.)
Top
Methods
  NameDescription
Public methodAdd
Add a vector to this one.
(Inherited from Vector.)
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 Vector.)
Protected methodCheckForSameDefinition(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).)
Protected methodCheckForSameDefinition(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.)
Protected methodCheckForSameDefinition(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).
Public methodClone
Clones this object using the specified context.
(Overrides MagneticFieldVectorClone(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 MagneticFieldVectorComputeCurrentDefinitionHashCode.)
Public methodCreateVectorDerivative
Constructs a vector which represents a derivative of this vector.
(Inherited from Vector.)
Public methodCross
Produce the vector cross product between this vector and another one.
(Inherited from Vector.)
Public methodDivide(Double)
Divide this vector by a scale factor.
(Inherited from Vector.)
Public methodDivide(Scalar)
Divide this vector by a scale factor.
(Inherited from Vector.)
Public methodDot
Produce the vector dot product between this vector and another one.
(Inherited from Vector.)
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 MagneticFieldVector.)
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 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.)
Public methodGetEvaluator(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.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetScalarElement(CartesianElement, Axes)
Gets a Scalar representing the X, Y, Z, or Magnitude of this vector.
(Inherited from Vector.)
Public methodGetScalarElement(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.)
Public methodGetService
Gets the service object of the specified type.
(Inherited from Vector.)
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.)
Public methodMultiply(Double)
Multiply this vector by a scale factor.
(Inherited from Vector.)
Public methodMultiply(Scalar)
Multiply this vector by a scale factor.
(Inherited from Vector.)
Public methodStatic memberReadFile(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.

Public methodStatic memberReadFile(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.

Public methodSubtract
Subtract a vector from this one.
(Inherited from Vector.)
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
Remarks
See https://www.ngdc.noaa.gov/geomag/WMM/soft.shtml for more information about the WMM model.
See Also