Click or drag to resize

PointScattererFrequencyBand Class

Represents a frequency band with scattering properties defined by the assigned ScatteringCoefficient instance.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.CommunicationsPointScattererFrequencyBand

Namespace:  AGI.Foundation.Communications
Assembly:  AGI.Foundation.Communications (in AGI.Foundation.Communications.dll) Version: 19.1.398.0 (19.1.398.0)
Syntax
public class PointScattererFrequencyBand : DefinitionalObject

The PointScattererFrequencyBand type exposes the following members.

Constructors
  NameDescription
Public methodPointScattererFrequencyBand(Double, ScatteringCoefficient)
Initializes a new instance.
Protected methodPointScattererFrequencyBand(PointScattererFrequencyBand, CopyContext)
Initializes a new instance as a copy of an existing instance.
Top
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.)
Public propertyLowerFrequency
Gets the lower frequency for the band of interest.
Public propertyScatteringCoefficient
Gets or sets the ScatteringCoefficient for the band of interest.
Public propertySignalData
Gets the collection of additional signal data.
Top
Methods
  NameDescription
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).
(Overrides DefinitionalObjectCheckForSameDefinition(DefinitionalObject).)
Protected methodCheckForSameDefinition(PointScattererFrequencyBand)
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 DefinitionalObjectComputeCurrentDefinitionHashCode.)
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.
(Overrides DefinitionalObjectEnumerateDependencies(DependencyEnumerator).)
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 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.)
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
Remarks
The PointScattererFrequencyBand is configured with a lower frequency, but not an upper frequency. Instances of this class are added to the PointScattererFrequencyBandCollection, which itself has a minimum frequency and maximum frequency. The entire spectrum between the minimum frequency and maximum frequency of the PointScattererFrequencyBandCollection must be covered by an instance of PointScattererFrequencyBand. Therefore, the upper frequency for a band is defined by the lower frequency of the next PointScattererFrequencyBand in the collection. The last band in the collections upper frequency is then, by definition, equal to the maximum frequency of the PointScattererFrequencyBandCollection. Additional signal data can be added to the band's SignalDataCollection. This additional signal data will be added to the reflected signal during evaluation.
See Also