ScalarDelayedByLink Class

A scalar which wraps another scalar while delaying it by a time specified by a LinkDelayEvaluator obtained from a LinkPath. When evaluating this scalar at a given time, the resulting value will represent the value of the wrapped scalar at the delayed time. The time delay is either positive or negative, depending on the LinkRole of this scalar.

Inheritance Hierarchy

SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.GeometryScalar
      AGI.Foundation.GeometryScalarDelayedByLink

Namespace: AGI.Foundation.Geometry
Assembly: AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.3.420.0 (24.3.420.0)

Syntax

C++

Copy

public sealed class ScalarDelayedByLink : Scalar

Public NotInheritable Class ScalarDelayedByLink
	Inherits Scalar

public ref class ScalarDelayedByLink sealed : public Scalar

[<SealedAttribute>]
type ScalarDelayedByLink =  
    class
        inherit Scalar
    end

The ScalarDelayedByLink type exposes the following members.

Constructors

	Name	Description
	ScalarDelayedByLink	Initializes a new instance.
	ScalarDelayedByLink(Scalar, LinkPath, LinkRole)	Initialize a new instance based on the given scalar delayed by the given link.
	ScalarDelayedByLink(Scalar, IServiceProvider, LinkRole)	Initialize a new instance based on the given scalar delayed by the given link.

Top

Properties

	Name	Description
	DirectionOfDelay	Gets or sets an enumeration indicating the direction of the delay to apply to ScalarToDelay. If the direction is receiving, the ScalarToDelay will be evaluated at a time prior to this scalar, representing the offset to the time of transmission. If the role is transmitting, the ScalarToDelay will be evaluated at a time after this scalar, representing the offset to the time of reception. By default, the value is: receiving.
	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.)
	PathForTimeDelay	Gets or sets the path from which to obtain the link delay.
	ScalarToDelay	Gets or sets the scalar which is delayed by the PathForTimeDelay.

Top

Methods

	Name	Description
	Add(Double)	Adds a fixed scalar to this one. (Inherited from Scalar.)
	Add(Scalar)	Adds another scalar to this one. (Inherited from Scalar.)
	Clone	Clones this object using the specified context. (Overrides DefinitionalObjectClone(CopyContext).)
	CreateScalarDerivative	Constructs a scalar which represents a derivative of this scalar. (Inherited from Scalar.)
	Divide(Double)	Divides this scalar (numerator) by a fixed value (denominator). (Inherited from Scalar.)
	Divide(Scalar)	Divides this scalar (numerator) by another one (denominator). (Inherited from Scalar.)
	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.)
	Freeze	Freezes this object. Further attempts to modify it will result in an ObjectFrozenException. (Inherited from DefinitionalObject.)
	GetDefinitionHashCode	Gets a hash code representing the definition of this object. (Inherited from DefinitionalObject.)
	GetEvaluator	Gets an evaluator that can be used to find the value of this scalar function at a given JulianDate. (Inherited from Scalar.)
	GetEvaluator(EvaluatorGroup)	Get an evaluator which evaluates the ScalarToDelay by applying the delay from the PathForTimeDelay which will be positive or negative depending on the DirectionOfDelay. (Overrides ScalarGetEvaluator(EvaluatorGroup).)
	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.)
	Multiply(Double)	Multiplies this scalar with a fixed value. (Inherited from Scalar.)
	Multiply(Scalar)	Multiplies another scalar with this one. (Inherited from Scalar.)
	Power	Raises this scalar to the given fixed exponent. (Inherited from Scalar.)
	Subtract(Double)	Subtracts a fixed scalar from this one. (Inherited from Scalar.)
	Subtract(Scalar)	Subtracts another scalar from this one. (Inherited from Scalar.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

Usually, the ScalarDelayedByLink will act as a Receiver and the time delay will evaluate the wrapped scalar by applying the "offset to time of transmission" to the time at which this scalar is evaluated.

Reference

AGI.Foundation.Geometry Namespace