AF SDK Reference

AFInputRangeData Structure

Save PDF

Save PDF

AFInputRangeData Structure

Encapsulates information about required time range for data.

Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

public struct AFInputRangeData : IEquatable<AFInputRangeData>

Public Structure AFInputRangeData
	Implements IEquatable(Of AFInputRangeData)

Dim instance As AFInputRangeData

public value class AFInputRangeData : IEquatable<AFInputRangeData>

[<SealedAttribute>]
type AFInputRangeData =  
    struct
        interface IEquatable<AFInputRangeData>
    end

The AFInputRangeData type exposes the following members.

	Name	Description
	AFInputRangeData(String)	Constructs zero duration AFInputRangeData for a specified time (such as "*", "t", etc.). The constructed AFInputRangeData object's StartTime and EndTime will be equal.
	AFInputRangeData(String, String)	Constructs AFInputRangeData with specified start time and end time.

	Name	Description
	EndTime	Time range end time in the format that can be parsed by AFTime. "*" represents the trigger time.
	IsEndTimeUndetermined	Returns true if EndTime is un-specified.
	IsSingleTime	Returns true if only single time is in the range, meaning that StartTime and EndTime are equal.
	IsStartTimeUndetermined	Returns true if StartTime is un-specified..
	IsTriggerTime	Returns true if the range represents the trigger time only.
	StartTime	Time range start time in the format that can be parsed by AFTime. "*" represents the trigger time.

	Name	Description
	Equals(Object)	Determines whether the specified Object is equal to the current object. (Overrides ValueTypeEquals(Object).)
	Equals(AFInputRangeData)	Indicates whether the current object is equal to another object of the same type.
	GetHashCode	Gets the hash code for this instance of the object which is suitable for use in hashing algorithms and data structures like a hash table. (Overrides ValueTypeGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a String that represents the current object. (Overrides ValueTypeToString.)

	Name	Description
	Equality	The equality operator (==) compares its operands to determine if they are equal.
	Inequality	The inequality operator (!=) compares its operands to determine if they are not equal.

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9