Provides access to time operations.
Description
The ITimeRelationalOperator provides many operations similar to spatial operations in a 1 dimentional timeline. when possible, it can use both TimeInstant and TimeExtent interfaces as parameters to the functions.
Members
| Name | Description | |
|---|---|---|
 |
Contains | Indicates whether this time value contains the other time value. |
|
Disjoint | Indicates whether the input time value falls fully outside of the time extent. |
|
Equals | Indicates whether the two time values are of the same type and define the same time values. |
|
Touches | Indicates whether the boundaries of the time values intersect. |
|
Within | Indicates whether this time value is contained (is within) the other time value. |
ITimeRelationalOperator.Contains Method
Indicates whether this time value contains the other time value.
Public Function Contains ( _
ByVal otherTimeValue As ITimeValue _
) As Boolean
public bool Contains (
ITimeValue otherTimeValue
);
Description
This function returns true if the passed Time value is contained fully within the current time extent. The start times can be equal, or the end times can be equal and the function will still result in TRUE.
ITimeRelationalOperator.Disjoint Method
Indicates whether the input time value falls fully outside of the time extent.
Public Function Disjoint ( _
ByVal otherTimeValue As ITimeValue _
) As Boolean
public bool Disjoint (
ITimeValue otherTimeValue
);
Description
This is the opposite of the Touches operation. It can be used to find out if there is a non-zero amount of time between the input time and the current time extent.
ITimeRelationalOperator.Equals Method
Indicates whether the two time values are of the same type and define the same time values.
Public Function Equals ( _
ByVal otherTimeValue As ITimeValue _
) As Boolean
public bool Equals (
ITimeValue otherTimeValue
);
ITimeRelationalOperator.Touches Method
Indicates whether the boundaries of the time values intersect.
Public Function Touches ( _
ByVal otherTimeValue As ITimeValue _
) As Boolean
public bool Touches (
ITimeValue otherTimeValue
);
Description
This function results in a TRUE value if there exists a Time instant that is contained by both of the TimeExtents. for example if the time extents are 1:00-2:00 and 2:00-3:00, then there is exactly one moment in time (2:00) that is in both TimeExtents.
ITimeRelationalOperator.Within Method
Indicates whether this time value is contained (is within) the other time value.
Public Function Within ( _
ByVal otherTimeValue As ITimeValue _
) As Boolean
public bool Within (
ITimeValue otherTimeValue
);
Description
This function can be used to find out if the current time is contained fully within the time extent passed in. The start times can be equal or the end times can be equal and the function will still be TRUE.
Classes that implement ITimeRelationalOperator
| Classes | Description |
|---|---|
| TimeExtent | An object that represents a time-referenced time extent. |
| TimeInstant | An object that represents a time-referenced instant in time. |