MagneticFieldVector Class

Initializes a new instance. The InitialMagneticFieldCoefficients, MagneticFieldCoefficientRates, DefinedInFrame, TargetPoint, and ReferenceDistance will need to be set.

Initializes a new instance as a copy of an existing instance.

Initializes a new instance. The DefinedInFrame will default to the PrincipalFrame of Earth as obtained from the current CentralBodiesFacet.

Gets or sets the reference frame for the magnetic field.

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.

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.

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.

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.

Gets or sets the point where the magnetic field vector is calculated.

Add a vector to this one.

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).

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).

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).

Clones this object using the specified context.

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.

Create a composite magnetic field vector that follows the recommended strategy of using IGRF coefficients for the past and WMM for future magnetic field predictions.

Create a composite magnetic field vector that follows the recommended strategy of using IGRF coefficients for the past and WMM for future magnetic field predictions.

Constructs a vector which represents a derivative of this vector.

Produce the vector cross product between this vector and another one.

Divide this vector by a scale factor.

Divide this vector by a scale factor.

Produce the vector dot product between this vector and another one.

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.

Determines whether the specified object is equal to the current object.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.

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.

Gets a hash code representing the definition of this object.

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.

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.

Serves as the default hash function.

Gets a Scalar representing the X, Y, Z, or Magnitude of this vector.

Gets a Scalar representing the X, Y, Z, or Magnitude of this vector, or any derivative of those elements.

Gets the service object of the specified type.

Gets the Type of the current instance.

Determines if this object has the same definition as another object.

Creates a shallow copy of the current Object.

Multiply this vector by a scale factor.

Multiply this vector by a scale factor.

Subtract a vector from this one.

Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.

Returns a string that represents the current object.

The reference distance used by the Earth-centered WorldMagneticModelVector and InternationalGeomagneticReferenceFieldVector classes. Its value is 6371200 meters.