Click or drag to resize

ScalarEnergyPerBitToNoiseDensityTModulation Class

A scalar which represents the energy per bit to noise density ratio Eb/No from a receiver, as computed from the SignalProcessor identified by the ISignalOutputService and which must be available on the CommunicationObject.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.GeometryScalar
      AGI.Foundation.GeometryCommunicationObjectScalar
        AGI.Foundation.GeometryScalarEnergyPerBitToNoiseDensityTModulation

Namespace:  AGI.Foundation.Geometry
Assembly:  AGI.Foundation.Communications (in AGI.Foundation.Communications.dll) Version: 24.1.418.0 (24.1.418.0)
Syntax
public class ScalarEnergyPerBitToNoiseDensity<TModulation> : CommunicationObjectScalar
where TModulation : DigitalModulation

Type Parameters

TModulation
The type of modulation to look for when decoding the signal to compute Eb/No. If the Signal obtained from the IntendedSignalStrategy does not contain this type of data, the resulting Eb/No will be zero.

The ScalarEnergyPerBitToNoiseDensityTModulation type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyCommunicationObject
Gets or sets the object which provides the services needed to compute this scalar.
(Inherited from CommunicationObjectScalar.)
Public propertyIntendedSignalStrategy
Gets or sets the strategy used to identify the signal to be used when computing this scalar.
(Inherited from CommunicationObjectScalar.)
Public propertyIsFrozen
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.)
Public propertyPropagationGraph
Gets or sets the graph of communication links used to propagate signals.
(Inherited from CommunicationObjectScalar.)
Public propertyUseLogarithmicSampling
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. The notable exception is the ScalarBitErrorRateTModulation, which has a range of value from zero to one and therefore does not use a logarithmic scale.
(Inherited from CommunicationObjectScalar.)
Top
Methods
  NameDescription
Public methodAdd(Double)
Adds a fixed scalar to this one.
(Inherited from Scalar.)
Public methodAdd(Scalar)
Adds another scalar to this one.
(Inherited from Scalar.)
Protected methodCheckForSameDefinition(CommunicationObjectScalar)
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 CommunicationObjectScalarCheckForSameDefinition(CommunicationObjectScalar).)
Protected methodCheckForSameDefinition(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.)
Protected methodCheckForSameDefinition(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 CommunicationObjectScalar.)
Protected methodCheckForSameDefinition(ScalarEnergyPerBitToNoiseDensityTModulation)
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).
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Protected methodComputeCurrentDefinitionHashCode
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 CommunicationObjectScalarComputeCurrentDefinitionHashCode.)
Public methodCreateScalarDerivative
Constructs a scalar which represents a derivative of this scalar.
(Inherited from Scalar.)
Public methodDivide(Double)
Divides this scalar (numerator) by a fixed value (denominator).
(Inherited from Scalar.)
Public methodDivide(Scalar)
Divides this scalar (numerator) by another one (denominator).
(Inherited from Scalar.)
Public methodEnumerateDependencies
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 CommunicationObjectScalar.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
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.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetEvaluator
Gets an evaluator that can be used to find the value of this scalar function at a given JulianDate.
(Inherited from Scalar.)
Public methodGetEvaluator(EvaluatorGroup)
Get an evaluator to compute energy per bit to noise density Eb/No.
(Overrides ScalarGetEvaluator(EvaluatorGroup).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMultiply(Double)
Multiplies this scalar with a fixed value.
(Inherited from Scalar.)
Public methodMultiply(Scalar)
Multiplies another scalar with this one.
(Inherited from Scalar.)
Public methodPower
Raises this scalar to the given fixed exponent.
(Inherited from Scalar.)
Public methodSubtract(Double)
Subtracts a fixed scalar from this one.
(Inherited from Scalar.)
Public methodSubtract(Scalar)
Subtracts another scalar from this one.
(Inherited from Scalar.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodValidateProperties
Checks to see if any of the properties are null and, if so, throws an exception.
(Inherited from CommunicationObjectScalar.)
Top
Remarks
Note that if the signal specified by the IntendedSignalStrategy does not have a SignalDataRate associated with it, the energy per bit will be zero representing a signal which could not be successfully demodulated to data.
See Also