OpticalGainPattern Methods | STK Components for .NET 2022 r2 STK Components for .NET 2022 r2 STK Components for .NET 2022 r2 Library Reference AGI.Foundation.Communications.Antennas OpticalGainPattern Class OpticalGainPattern Methods CheckForSameDefinition Method ComputeCurrentDefinitionHashCode Method ValidateProperties Method OpticalGainPattern Methods The OpticalGainPattern type exposes the following members. 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). (Overrides BaseGainPatternCheckForSameDefinition(BaseGainPattern).) 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(OpticalGainPattern) 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). Clone Clones this object using the specified context. (Inherited from DefinitionalObject.) 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 BaseGainPatternComputeCurrentDefinitionHashCode.) 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 input signals based on link geometry and the gain pattern. (Inherited from BaseGainPattern.) 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.) ValidateProperties Validates that required properties and parameters are configured correctly in order to get an evaluator for this instance. Derived classes should call this method when implementing GetApplyAntennaGainEvaluator(EvaluatorGroup, Vector, Axes, ISignalSource, SignalPropagationGraph), as well as validate their own properties. Top See Also Reference OpticalGainPattern Class AGI.Foundation.Communications.Antennas Namespace Copyright © 2007-2022 Analytical Graphics, Inc. Send comments on this topic to support@agi.com