ScalarOccultationRegulatedDualCone Class

Creates a new Scalar with a VectorType of CorrectForLightTimeDelayAndAberration. IlluminatingBody and TargetPoint must be set before an Evaluator is created, and generally at least one body should be added to OccludingBodies.

Initializes a new instance of a ScalarOccultationRegulatedDualCone from a normal ScalarOccultationDualCone.

Creates a new Scalar from the given illuminating body, target point, and occluding bodies.

Creates a new Scalar from the given illuminating body, target point, and occluding bodies.

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.

Gets or sets the body to use for the illuminating body (commonly the sun).

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 a list of bodies which obscure the illuminating body.

Gets or sets a parameter which represents the propagation phase. In general, users should never need to explicitly set this property. It should only be set when multiple NumericalPropagator objects are running in the same EvaluatorGroup, such as when elements of a state require additional instances of a NumericalPropagator inside their implementation in order to produce their values. In such cases, it may be necessary to distinguish between the phase of the exterior propagator and the phase of the interior propagator. In these cases, it is up to the user to ensure that both the state and all of its elements are configured with the same parameter. Otherwise, the state will throw an exception when creating its propagator.

Gets or sets the Point representing the location at which the occultation factor is being calculated.

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.

Adds a fixed scalar to this one.

Adds another scalar 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).

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.

Checks all properties and creates the vectors required to evaluate occultation fractions.

Constructs a scalar which represents a derivative of this scalar.

Divides this scalar (numerator) by a fixed value (denominator).

Divides this scalar (numerator) by another one (denominator).

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 to calculate EclipseType for every CentralBody in OccludingBodies.

Gets a list of evaluators that calculate eclipse types for each eclipsing body according to the dual cone shadow model.

Gets an evaluator that can be used to find the value of this scalar function at a given JulianDate.

Gets an evaluator that calculates occultation according to the dual cone shadow model. The occultation factor ranges from 0.0 (fully lit) to 1.0 (full occultation).

Serves as the default hash function.

This type does not have derivatives or partial derivatives with respect to any object except 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.

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.

Multiplies this scalar with a fixed value.

Multiplies another scalar with this one.

Raises this scalar to the given fixed exponent.

Subtracts a fixed scalar from this one.

Subtracts another scalar 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.