BesselEnvelopeCircularApertureGainPattern Class

A Bessel envelope circular aperture antenna gain pattern.

Inheritance Hierarchy

SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.Communications.AntennasBaseGainPattern
      AGI.Foundation.Communications.AntennasRadioFrequencyGainPattern
        AGI.Foundation.Communications.AntennasBesselEnvelopeCircularApertureGainPattern

Namespace: AGI.Foundation.Communications.Antennas
Assembly: AGI.Foundation.Communications (in AGI.Foundation.Communications.dll) Version: 24.2.419.0 (24.2.419.0)

Syntax

C++

Copy

public class BesselEnvelopeCircularApertureGainPattern : RadioFrequencyGainPattern, 
	IAntennaDiameterService, IAntennaEfficiencyService

Public Class BesselEnvelopeCircularApertureGainPattern
	Inherits RadioFrequencyGainPattern
	Implements IAntennaDiameterService, IAntennaEfficiencyService

public ref class BesselEnvelopeCircularApertureGainPattern : public RadioFrequencyGainPattern, 
	IAntennaDiameterService, IAntennaEfficiencyService

type BesselEnvelopeCircularApertureGainPattern =  
    class
        inherit RadioFrequencyGainPattern
        interface IAntennaDiameterService
        interface IAntennaEfficiencyService
    end

The BesselEnvelopeCircularApertureGainPattern type exposes the following members.

Constructors

	Name	Description
	BesselEnvelopeCircularApertureGainPattern	Initializes a new instance.
	BesselEnvelopeCircularApertureGainPattern(BesselEnvelopeCircularApertureGainPattern, CopyContext)	Initializes a new instance as a copy of an existing instance.
	BesselEnvelopeCircularApertureGainPattern(Double, Int32, Double, Double, Double)	Create a new instance based on the given pedestal level, bessel exponent, diameter, efficiency, and back lobe gain.

Top

Properties

	Name	Description
	BackLobeGain	Gets or sets the antenna back lobe gain, applied when the angle is greater than 90 degrees from the boresight.
	Diameter	Gets or sets the antenna diameter.
	Efficiency	Gets or sets the antenna efficiency, as a ratio between zero and one.
	Exponent	Gets or sets the bessel function exponent.
	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.)
	MainLobeGain	Gets or sets the main lobe gain value.
	MainLobeGainOverride	Gets or sets a value indicating whether the main lobe gain value should be used instead of the value computed by the model. If set to true, the value returned from the MainLobeGain property will be used as the main lobe gain. If set to false, the model will compute the main lobe gain value.
	PedestalLevel	Gets or sets the pedestal level. The pedestal level must be greater than 0.0 and less than or equal to 1.0.

Top

Methods

	Name	Description
	CheckForSameDefinition(BaseGainPattern)	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 RadioFrequencyGainPattern.)
	CheckForSameDefinition(BesselEnvelopeCircularApertureGainPattern)	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).
	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 BaseGainPattern.)
	CheckForSameDefinition(RadioFrequencyGainPattern)	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 RadioFrequencyGainPatternCheckForSameDefinition(RadioFrequencyGainPattern).)
	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 RadioFrequencyGainPatternComputeCurrentDefinitionHashCode.)
	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 DefinitionalObject.)
	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.)
	GetAntennaGainEvaluator(Vector, Axes, Signal)	Get an evaluator for the gain that would be applied to the given sample signal based on the given geometry. (Inherited from BaseGainPattern.)
	GetAntennaGainEvaluator(EvaluatorGroup, Vector, Axes, Signal)	Get an evaluator for the gain that would be applied to the given sample signal based on the given geometry. (Inherited from BaseGainPattern.)
	GetApplyAntennaGainEvaluator	Get an evaluator which can modify a set of signals based on link geometry and this gain pattern. (Overrides BaseGainPatternGetApplyAntennaGainEvaluator(EvaluatorGroup, Vector, Axes, ISignalSource, SignalPropagationGraph).)
	GetDefinitionHashCode	Gets a hash code representing the definition of this object. (Inherited from DefinitionalObject.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetService	Gets the service object of the specified type. (Inherited from BaseGainPattern.)
	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.)
	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.)

Top

Reference

AGI.Foundation.Communications.Antennas Namespace