ScalarConstraint Class |
Namespace: AGI.Foundation.Access.Constraints
The ScalarConstraint type exposes the following members.
Name | Description | |
---|---|---|
ScalarConstraint |
Initializes a new instance with default values.
| |
ScalarConstraint(Scalar, Double) |
Initializes a new instance with the specified scalar and minimum value.
| |
ScalarConstraint(ScalarConstraint, CopyContext) | Initializes a new instance as a copy of an existing instance. | |
ScalarConstraint(IServiceProvider, Scalar, Double) |
Initializes a new instance with the specified constrained object, scalar, and minimum value.
| |
ScalarConstraint(Scalar, Double, Double) |
Initializes a new instance with the specified scalar, minimum value, and maximum value.
| |
ScalarConstraint(IServiceProvider, Scalar, Double, Double) |
Initializes a new instance with the specified constrained object, scalar,
minimum value, and maximum value.
|
Name | Description | |
---|---|---|
Applicability |
Gets or sets the Access situation in which this constraint applies.
(Inherited from AccessConstraint.) | |
ConstrainedObject |
Gets or sets the object to which this constraint applies. This constraint does not use this property
directly. However, when this constraint is part of a larger AccessQuery, this property
identifies the participant that is observing the scalar, so event times will be moved to this participant
before evaluating the scalar.
| |
DebuggingLogger |
Gets or sets a logger to which debugging information will be written.
(Inherited from AccessQuery.) | |
EvaluationOrder |
Gets or sets a number indicating the evaluation order of this constraint relative
to other constraints. All constraints involved in an
AccessComputation or that share a common parent (e.g. AccessQueryAnd or
AccessQueryOr) in an AccessQuery are sorted by this value before being evaluated in
ascending order, so constraints with a lower evaluation order are evaluated earlier than constraints with
a higher evaluation order.
(Inherited from AccessConstraint.) | |
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.) | |
IsMaximumEnabled |
Gets or sets a value indicating whether a maximum threshold is used in calculating constraint satisfaction.
(Inherited from MinimumMaximumAccessConstraint.) | |
IsMinimumEnabled |
Gets or sets a value indicating whether a minimum threshold is used in calculating constraint satisfaction.
(Inherited from MinimumMaximumAccessConstraint.) | |
MaximumTolerance |
Gets or sets the tolerance associated with the MaximumValue to be used when computing threshold crossings.
(Inherited from MinimumMaximumAccessConstraint.) | |
MaximumValue |
Gets or sets the maximum function value that is allowed for this constraint to be satisfied.
By default this is PositiveInfinity.
(Inherited from MinimumMaximumAccessConstraint.) | |
MinimumTolerance |
Gets or sets the tolerance associated with the MinimumValue to be used when computing threshold crossings.
(Inherited from MinimumMaximumAccessConstraint.) | |
MinimumValue |
Gets or sets the minimum function value that is required for this constraint to be satisfied.
By default, this is NegativeInfinity.
(Inherited from MinimumMaximumAccessConstraint.) | |
Sampling |
Gets an instance describing how this constraint is to be sampled.
(Inherited from AccessConstraint.) | |
Scalar |
Gets or sets the scalar function to compare to
MinimumValue and
MaximumValue.
|
Name | Description | |
---|---|---|
BuildQueryEvaluator |
Builds a query evaluator from this constraint.
(Overrides AccessConstraintBuildQueryEvaluator(ConstraintQueryBuilder, EvaluatorGroup).) | |
CheckForSameDefinition(AccessConstraint) |
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 MinimumMaximumAccessConstraint.) | |
CheckForSameDefinition(AccessQuery) |
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 AccessConstraint.) | |
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 AccessQuery.) | |
CheckForSameDefinition(MinimumMaximumAccessConstraint) |
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 MinimumMaximumAccessConstraintCheckForSameDefinition(MinimumMaximumAccessConstraint).) | |
CheckForSameDefinition(ScalarConstraint) |
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 MinimumMaximumAccessConstraintComputeCurrentDefinitionHashCode.) | |
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 AccessConstraintEnumerateDependencies(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.
(Inherited from AccessConstraint.) | |
GetDefinitionHashCode |
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.) | |
GetEvaluationOrder |
Returns EvaluationOrder, indicating the suggested evaluation order of
this constraint when it is used as part of an AccessQuery. Queries that hold sub-queries
(such as an AccessQueryAnd) generally evaluate their sub-queries in
ascending order of this value, so constraints with a lower evaluation order are evaluated earlier than
constraints with a higher evaluation order.
(Inherited from AccessConstraint.) | |
GetEvaluator |
Gets an evaluator that can be used to evaluate this query for a given time or for intervals of time.
(Inherited from AccessQuery.) | |
GetEvaluator(IServiceProvider) |
Gets an evaluator that can be used to evaluate this query for a given time or for intervals of time.
(Inherited from AccessQuery.) | |
GetEvaluator(IServiceProvider, EvaluatorGroup) |
Gets an evaluator that can be used to evaluate this query for a given time or for intervals of time.
(Inherited from AccessConstraint.) | |
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.) | |
ToDisjunctiveNormalForm |
Transforms this query to disjunctive normal form (DNF).
(Inherited from AccessConstraint.) | |
ToString | Returns a string that represents the current object. (Overrides ObjectToString.) |