Click or drag to resize

RadioFrequencyGainPattern Class

Base class for all radio frequency (RF) antenna gain patterns.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Communications.Antennas
Assembly:  AGI.Foundation.Communications (in AGI.Foundation.Communications.dll) Version: 24.1.418.0 (24.1.418.0)
Syntax
public abstract class RadioFrequencyGainPattern : BaseGainPattern

The RadioFrequencyGainPattern type exposes the following members.

Constructors
Properties
  NameDescription
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.)
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(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).
(Overrides BaseGainPatternCheckForSameDefinition(BaseGainPattern).)
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 BaseGainPattern.)
Protected methodCheckForSameDefinition(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).
Public methodClone
Clones this object using the specified context.
(Inherited from DefinitionalObject.)
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 BaseGainPatternComputeCurrentDefinitionHashCode.)
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 DefinitionalObject.)
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 methodGetAntennaGainEvaluator(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.)
Public methodGetAntennaGainEvaluator(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.)
Public methodGetApplyAntennaGainEvaluator
Get an evaluator which can modify a set of input signals based on link geometry and the gain pattern.
(Inherited from BaseGainPattern.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetService
Gets the service object of the specified type.
(Inherited from BaseGainPattern.)
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.)
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.)
Top
See Also
Inheritance Hierarchy
SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.Communications.AntennasBaseGainPattern
      AGI.Foundation.Communications.AntennasRadioFrequencyGainPattern
        AGI.Foundation.Communications.AntennasBesselCircularApertureGainPattern
        AGI.Foundation.Communications.AntennasBesselEnvelopeCircularApertureGainPattern
        AGI.Foundation.Communications.AntennasCosineCircularApertureGainPattern
        AGI.Foundation.Communications.AntennasCosinePedestalCircularApertureGainPattern
        AGI.Foundation.Communications.AntennasCosinePedestalRectangularApertureGainPattern
        AGI.Foundation.Communications.AntennasCosineRectangularApertureGainPattern
        AGI.Foundation.Communications.AntennasCosineSquaredCircularApertureGainPattern
        AGI.Foundation.Communications.AntennasCosineSquaredPedestalCircularApertureGainPattern
        AGI.Foundation.Communications.AntennasCosineSquaredPedestalRectangularApertureGainPattern
        AGI.Foundation.Communications.AntennasCosineSquaredRectangularApertureGainPattern
        AGI.Foundation.Communications.AntennasCustomGainPattern
        AGI.Foundation.Communications.AntennasDipoleGainPattern
        AGI.Foundation.Communications.AntennasFrequencyDependentElectricFieldGainPattern
        AGI.Foundation.Communications.AntennasFrpaGainPattern
        AGI.Foundation.Communications.AntennasGaussianGainPattern
        AGI.Foundation.Communications.AntennasGpsSatelliteAntennaPattern
        AGI.Foundation.Communications.AntennasHelicalGainPattern
        AGI.Foundation.Communications.AntennasHemisphericalGainPattern
        AGI.Foundation.Communications.AntennasIsotropicGainPattern
        AGI.Foundation.Communications.AntennasItuRBO1213Version1CoPolarGainPattern
        AGI.Foundation.Communications.AntennasItuRBO1213Version1CrossPolarGainPattern
        AGI.Foundation.Communications.AntennasItuRF1245Version1GainPattern
        AGI.Foundation.Communications.AntennasItuRF1245Version3GainPattern
        AGI.Foundation.Communications.AntennasItuRS1528R12GainPattern
        AGI.Foundation.Communications.AntennasItuRS1528R13GainPattern
        AGI.Foundation.Communications.AntennasItuRS465Version5GainPattern
        AGI.Foundation.Communications.AntennasItuRS465Version6GainPattern
        AGI.Foundation.Communications.AntennasItuRS580Version6GainPattern
        AGI.Foundation.Communications.AntennasItuRS672Version4GainPattern
        AGI.Foundation.Communications.AntennasItuRS731Version1GainPattern
        AGI.Foundation.Communications.AntennasParabolicGainPattern
        AGI.Foundation.Communications.AntennasPencilBeamGainPattern
        AGI.Foundation.Communications.AntennasPhasedArrayGainPattern
        AGI.Foundation.Communications.AntennasRectangularBeamGainPattern
        AGI.Foundation.Communications.AntennasSincExponentCircularApertureGainPattern
        AGI.Foundation.Communications.AntennasSincExponentRectangularApertureGainPattern
        AGI.Foundation.Communications.AntennasSquareHornGainPattern
        AGI.Foundation.Communications.AntennasUniformCircularApertureGainPattern
        AGI.Foundation.Communications.AntennasUniformRectangularApertureGainPattern