MagneticFieldVector Class 
Namespace: AGI.Foundation.Celestial
The MagneticFieldVector type exposes the following members.
Name  Description  

MagneticFieldVector 
Initializes a new instance. The InitialMagneticFieldCoefficients, MagneticFieldCoefficientRates,
DefinedInFrame, TargetPoint, and ReferenceDistance will need to be set.
 
MagneticFieldVector(MagneticFieldVector, CopyContext)  Initializes a new instance as a copy of an existing instance.  
MagneticFieldVector(TimeIntervalCollectionSphericalHarmonicCoefficients, TimeIntervalCollectionSphericalHarmonicCoefficients, Point, Double) 
Initializes a new instance. The DefinedInFrame will default to the
PrincipalFrame of Earth as obtained from the current
CentralBodiesFacet.

Name  Description  

DefinedInFrame 
Gets or sets the reference frame for the magnetic field.
 
InitialMagneticFieldCoefficients 
Gets or sets the collection that represents the static sphericalharmonic magnetic field
coefficients that are valid at the beginning of specific time intervals. These are in tesla.
 
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
sphericalharmonic magnetic field coefficients during specific time intervals.
These are in tesla/year.
 
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.
 
TargetPoint 
Gets or sets the point where the magnetic field vector is calculated.

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 derivedclass 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 derivedclass instances.
Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
 
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 derivedclass instances.
Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Overrides VectorCheckForSameDefinition(Vector).)  
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 VectorComputeCurrentDefinitionHashCode.)  
CreateCompositeIgrfCofAndWmmVector 
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.
 
CreateCompositeIgrfTxtAndWmmVector 
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.
 
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.
(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 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.
(Overrides VectorGetEvaluator(EvaluatorGroup).)  
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.)  
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.) 
Name  Description  

EarthReferenceDistance 
The reference distance used by the Earthcentered WorldMagneticModelVector and
InternationalGeomagneticReferenceFieldVector classes. Its value is 6371200 meters.
