Click or drag to resize

AccessQueryStartAndMaintain Class

An AccessQuery that can define separate constraints for starting and maintaining access. This query will be considered satisfied after the StartQuery is satisfied, and for as long as the MaintainQuery is satisfied.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Access
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.1.418.0 (24.1.418.0)
Syntax
public class AccessQueryStartAndMaintain : AccessQuery

The AccessQueryStartAndMaintain type exposes the following members.

Constructors
  NameDescription
Public methodAccessQueryStartAndMaintain
Initializes a new instance.
Public methodAccessQueryStartAndMaintain(AccessQuery, AccessQuery)
Initializes a new instance representing the start and maintain queries.
Public methodAccessQueryStartAndMaintain(AccessQuery, AccessQuery, Boolean)
Initializes a new instance representing the start and maintain queries.
Public methodAccessQueryStartAndMaintain(AccessQuery, AccessQuery, Boolean, JulianDate)
Initializes a new instance representing the start and maintain queries.
Public methodAccessQueryStartAndMaintain(AccessQuery, AccessQuery, Boolean, JulianDate, Boolean)
Initializes a new instance representing the start and maintain queries.
Top
Properties
  NameDescription
Public propertyAllowAccessBeforeStart
Gets or sets a value indicating whether the query is considered satisfied when the MaintainQuery is satisfied at the start of the evaluated interval.
Public propertyDebuggingLogger
Gets or sets a logger to which debugging information will be written.
(Inherited from AccessQuery.)
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 propertyMaintainQuery
Gets or sets the AccessQuery that represents the condition for maintaining access. Whenever this query is satisfied while the StartQuery is also satisfied, the AccessQueryStartAndMaintain will be satisfied for as long as this query is satisfied, even after the StartQuery is no longer satisfied.
Public propertyStartQuery
Gets or sets the AccessQuery that represents the condition for establishing access. Whenever this query is satisfied, the AccessQueryStartAndMaintain is considered satisfied.
Public propertyStartQueryEvaluationStartDate
Gets or sets the JulianDate that will be used as the start date for evaluation. When Evaluate(JulianDate) is called, the evaluator will start at this date to determine if the StartQuery is satisfied.
Public propertyUseStartDateForIntervalEvaluation
Gets or sets a value indicating whether calls to Evaluate(TimeIntervalCollection, ITrackCalculationProgress) will also start at StartQueryEvaluationStartDate. This setting either truncates the evaluation interval if the StartQueryEvaluationStartDate is after the interval start or expands the interval if the StartQueryEvaluationStartDate is before the interval start.
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(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).
(Overrides AccessQueryCheckForSameDefinition(AccessQuery).)
Protected methodCheckForSameDefinition(AccessQueryStartAndMaintain)
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).
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).
(Inherited from AccessQuery.)
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 AccessQueryComputeCurrentDefinitionHashCode.)
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 methodGetEvaluationOrder
Gets the suggested evaluation order of this query by adding up the evaluation orders of this query's sub-queries, as returned by their GetEvaluationOrder methods.
(Overrides AccessQueryGetEvaluationOrder.)
Public methodGetEvaluator
Gets an evaluator that can be used to evaluate this query for a given time or for intervals of time.
(Inherited from AccessQuery.)
Public methodGetEvaluator(IServiceProvider)
Gets an evaluator that can be used to evaluate this query for a given time or for intervals of time.
(Inherited from AccessQuery.)
Public methodGetEvaluator(IServiceProvider, EvaluatorGroup)
Gets an evaluator that can be used to evaluate this query for a given time or for intervals of time.
(Overrides AccessQueryGetEvaluator(IServiceProvider, EvaluatorGroup).)
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 methodToDisjunctiveNormalForm
Transforms this query to disjunctive normal form (DNF).
(Overrides AccessQueryToDisjunctiveNormalForm.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also