MagneticCoilTorque Class

Initializes the magnetic coil torque model. The MagneticFieldVector, NumberOfLoops, Current, DirectedArea, and BodyAxes will have to be set before an evaluator is created.

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

Initializes the magnetic coil torque model.

Initializes the magnetic coil torque model.

Gets or sets the body axes of the spacecraft. These should be the IntegrationAxes of the PropagationEulerianAxes associated with the spacecraft.

Gets or sets the electric current passing through the coil.

Gets or sets the area of the coil multiplied by the unit vector that is normal to the plane of the coil such that a positive current traveling through the coil obeys the right hand rule.

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 a vector describing the magnetic field that the coil is subjected to. This is usually a MagneticFieldVector.

Gets or sets the number of current loops in the magnetic torquer coil.

Gets the Vector representation of this torque.

Build lists of torques based on this model in order to create an overall resultant torque.

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.

Creates a new magnetic coil torque that uses an InternationalGeomagneticReferenceFieldVector to describe the magnetic field and a Point to describe the position of the spacecraft.

Creates a new magnetic coil torque that uses an InternationalGeomagneticReferenceFieldVector to describe the magnetic field and a Point to describe the position of the spacecraft.

Creates a new magnetic coil torque that uses a WorldMagneticModelVector to describe the magnetic field and a Point to describe the position of the spacecraft.

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.

Serves as the default hash function.

Gets an instance of an evaluator that can compute the torque.

Gets an instance of an evaluator that can compute the torque.

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.

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.