ScalarAntennaGainInLinkDirection Class 
Namespace: AGI.Foundation.Geometry
The ScalarAntennaGainInLinkDirection type exposes the following members.
Name  Description  

ScalarAntennaGainInLinkDirection  Initializes a new instance.  
ScalarAntennaGainInLinkDirection(ScalarAntennaGainInLinkDirection, CopyContext)  Initializes a new instance as a copy of an existing instance.  
ScalarAntennaGainInLinkDirection(IServiceProvider, LinkRole, SignalPropagationGraph, IntendedSignalStrategy) 
Initialize a new instance based on the given parameters.

Name  Description  

CommunicationLink 
Gets or sets the object which provides the services needed to compute this scalar.
(Inherited from CommunicationLinkScalar.)  
IntendedSignalStrategy 
Gets or sets the strategy used to identify the signal to be used when computing this scalar.
(Inherited from CommunicationLinkScalar.)  
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.)  
LinkEnd 
Gets or sets the enumeration indicating at which end of the link to evaluate the antenna gain.
(Overrides CommunicationLinkScalarLinkEnd.)  
PropagationGraph 
Gets or sets the graph of communication links used to propagate signals.
(Inherited from CommunicationLinkScalar.)  
UseLogarithmicSampling 
Gets or sets a value indicating whether this scalar's values will be converted to a logarithmic scale
when performing sampling for access calculations. Most communication scalars span an extremely large
range of values, especially for wireless communications over large distances. In order to avoid
comparing values above one with values very near zero, the logarithmic scale gives a better means of
analyzing the behavior of the function without running into numerical issue with floating point numbers.
This value is set by its derived classes and in most cases is set to false by default.
(Inherited from CommunicationLinkScalar.) 
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(CommunicationLinkScalar) 
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 CommunicationLinkScalarCheckForSameDefinition(CommunicationLinkScalar).)  
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 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 derivedclass instances.
Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from CommunicationLinkScalar.)  
CheckForSameDefinition(ScalarAntennaGainInLinkDirection) 
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).
 
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 CommunicationLinkScalarComputeCurrentDefinitionHashCode.)  
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 CommunicationLinkScalar.)  
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 value of this scalar function at a given JulianDate.
(Inherited from Scalar.)  
GetEvaluator(EvaluatorGroup) 
Get an evaluator to compute the antenna gain.
(Overrides ScalarGetEvaluator(EvaluatorGroup).)  
GetHashCode  Serves as the default hash function. (Inherited from Object.)  
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.)  
ValidateProperties 
Checks to see if any of the properties are null and, if so, throws an exception.
(Inherited from CommunicationLinkScalar.) 
When applied to the Transmitter, this scalar requires the ITransmittedSignalService to be available on the link and the ISignalTransmissionService to be available on the Transmitter to compute the gain.
When applied to the Receiver, this scalar requires the IPropagatedSignalService to be available on the link and the ISignalReceivedByAntennaService to be available on the Receiver to compute the gain.