STK Components for .NET 2021 r1

## ScalarOccultationNoShadow Class |

This is a ScalarOccultation for use with SimpleSolarRadiationForce. This type models a lack of any shadow conditions, and is primarily intended for interplanetary missions.

The same effect can be attained by using another ScalarOccultation without any bodies added to the OccludingBodies property, however this type has also been added for convenience.

Inheritance Hierarchy

SystemObject

AGI.Foundation.InfrastructureDefinitionalObject

AGI.Foundation.GeometryScalar

AGI.Foundation.CelestialScalarOccultation

AGI.Foundation.CelestialScalarOccultationNoShadow

AGI.Foundation.InfrastructureDefinitionalObject

AGI.Foundation.GeometryScalar

AGI.Foundation.CelestialScalarOccultation

AGI.Foundation.CelestialScalarOccultationNoShadow

Syntax

The ScalarOccultationNoShadow type exposes the following members.

Constructors

Name | Description | |
---|---|---|

ScalarOccultationNoShadow |
Initializes a new instance of a ScalarOccultation. This subtype of occultation does not require
OccludingBodies, however TargetPoint and IlluminatingBody
must still be set in order to use the instance with a SimpleSolarRadiationForce.
| |

ScalarOccultationNoShadow(CentralBody, Point) |
Initializes a new instance using the provided TargetPoint and
IlluminatingBody, which a SimpleSolarRadiationForce
type will need to calculate the direction and magnitude of the un-occulted
solar radiation.
| |

ScalarOccultationNoShadow(ScalarOccultationNoShadow, CopyContext) | Initializes a new instance as a copy of an existing instance. |

Properties

Name | Description | |
---|---|---|

Dimension |
Gets the dimension of the values produced by the object. For example, Vectors
would have a dimension of three, and Scalars of one. A PartialDerivativesEvaluator
created by this type will have a "RowDimension" equal to this
property, and a "ColumnDimension equal to the summation
of the dimensions of the independent variables that this object is dependent on.
| |

IlluminatingBody |
Gets or sets the body to use for the illuminating body (commonly the sun).
(Inherited from ScalarOccultation.) | |

InertialFrame | Gets or sets an alternate inertial reference frame. This property is by default, and if it remains , then the InertialFrame of the IlluminatingBody will be used. The inertial frame is used to correct the position vectors for light time delay and aberration if the appropriate RadiationVectorType is set. | |

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

OccludingBodies |
Gets a list of bodies which obscure the illuminating body.
(Inherited from ScalarOccultation.) | |

TargetPoint |
Gets or sets the Point representing the location at which
the occultation factor is being calculated.
(Inherited from ScalarOccultation.) | |

VectorType |
Gets or sets whether or not to use true position to calculate the occultation, or apparent position adjusted for aberration.
By default set to CorrectForLightTimeDelayAndAberration.
(Inherited from ScalarOccultation.) |

Methods

Name | Description | |
---|---|---|

Add(Double) |
Adds a fixed scalar to this one.
(Inherited from Scalar.) | |

Add(Scalar) |
Adds another scalar to this one.
(Inherited from Scalar.) | |

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

CheckForSameDefinition(Scalar) |
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 ScalarOccultation.) | |

CheckForSameDefinition(ScalarOccultation) |
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 ScalarOccultationCheckForSameDefinition(ScalarOccultation).) | |

CheckForSameDefinition(ScalarOccultationNoShadow) | ||

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

CreateEvaluatorHelper |
Checks all properties and creates the vectors required to evaluate occultation fractions.
(Inherited from ScalarOccultation.) | |

CreateScalarDerivative |
Constructs a scalar which represents a derivative of this scalar.
(Inherited from Scalar.) | |

Divide(Double) |
Divides this scalar (numerator) by a fixed value (denominator).
(Inherited from Scalar.) | |

Divide(Scalar) |
Divides this scalar (numerator) by another one (denominator).
(Inherited from Scalar.) | |

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

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

GetEclipseTypeEvaluators | (Inherited from ScalarOccultation.) | |

GetEclipseTypeEvaluators(EvaluatorGroup) |
Gets a list of evaluators that return None for each eclipsing body.
(Overrides ScalarOccultationGetEclipseTypeEvaluators(EvaluatorGroup).) | |

GetEvaluator |
Gets an evaluator that can be used to find the value of this scalar function at a given JulianDate.
(Inherited from Scalar.) | |

GetEvaluator(EvaluatorGroup) |
Gets an evaluator that returns an occultation of 0.0 (fully lit).
(Overrides ScalarGetEvaluator(EvaluatorGroup).) | |

GetHashCode | Serves as the default hash function. (Inherited from Object.) | |

GetPartialDerivativesEvaluator |
This type does not have derivatives or partial derivatives with respect to any object with the exception of itself.
Because of that the created PartialDerivativesEvaluator has a
ColumnDimension of zero if this ScalarOccultation
is not in the generalized state, and if it is in the generalized state it returns a 1x1 identity matrix.
| |

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) |
Multiplies this scalar with a fixed value.
(Inherited from Scalar.) | |

Multiply(Scalar) |
Multiplies another scalar with this one.
(Inherited from Scalar.) | |

Power |
Raises this scalar to the given fixed exponent.
(Inherited from Scalar.) | |

Subtract(Double) |
Subtracts a fixed scalar from this one.
(Inherited from Scalar.) | |

Subtract(Scalar) |
Subtracts another scalar from this one.
(Inherited from Scalar.) | |

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

See Also