LinkDirectionsProvider Class

A DirectionsProvider which provides directions using a list of links which are held as instances of IServiceProvider. The link instances must provide the ILinkService service. The evaluator provided by this class uses GetTransmitterDisplacementRelativeToReceiver or GetReceiverDisplacementRelativeToTransmitter, based on the setting of the TimeObserver value, in order to obtain the vector which is then used to provide the output directions. The TimeObserver for all the links must be consistently set to Transmitter or Receiver. Otherwise, an InvalidOperationException will be thrown from calls to the GetDirectionsEvaluator(EvaluatorGroup, ISignalSource, Vector, Axes) method.

Inheritance Hierarchy

SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.Communications.AntennasDirectionsProvider
      AGI.Foundation.Communications.AntennasLinkDirectionsProvider

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 LinkDirectionsProvider : DirectionsProvider

Public Class LinkDirectionsProvider
	Inherits DirectionsProvider

public ref class LinkDirectionsProvider : public DirectionsProvider

type LinkDirectionsProvider =  
    class
        inherit DirectionsProvider
    end

The LinkDirectionsProvider type exposes the following members.

Constructors

	Name	Description
	LinkDirectionsProvider	Initializes a new instance.
	LinkDirectionsProvider(IEnumerableIServiceProvider, IServiceProvider)	Initializes a new instance.
	LinkDirectionsProvider(LinkDirectionsProvider, CopyContext)	Initializes a new instance as a copy of an existing instance.

Top

Properties

	Name	Description
	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.)
	Links	Gets the list of links from which the directions are determined.
	TimeObserver	Gets or sets the time observer instance used to validate the time observer for each link in Links.

Top

Methods

	Name	Description
	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 DirectionsProvider.)
	CheckForSameDefinition(DirectionsProvider)	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 DirectionsProviderCheckForSameDefinition(DirectionsProvider).)
	CheckForSameDefinition(LinkDirectionsProvider)	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. (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 DirectionsProviderComputeCurrentDefinitionHashCode.)
	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. (Overrides DefinitionalObjectEnumerateDependencies(DependencyEnumerator).)
	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. (Overrides DefinitionalObjectFreezeAggregatedObjects.)
	GetDefinitionHashCode	Gets a hash code representing the definition of this object. (Inherited from DefinitionalObject.)
	GetDirectionsEvaluator	Gets an evaluator for evaluating directions based on an input signal, link direction vector, and antenna axes. (Overrides DirectionsProviderGetDirectionsEvaluator(EvaluatorGroup, ISignalSource, Vector, Axes).)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	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

Remarks

Each link instance in the list can be constrained individually using access constraints. The FromObjectAllowNoConstraints(IServiceProvider) static method is called passing the link as the IServiceProvider parameter in order to build the AccessQuery for the link. During evaluation time, each link's access query is evaluated and only if access exists, will the link's direction be added to the output list of WeightedDirection instances.

Reference

AGI.Foundation.Communications.Antennas Namespace