Frame Class

Implementation of a basic IFrame.

Inheritance Hierarchy

SystemObject
GSF.TimeSeriesFrame

Namespace: GSF.TimeSeries
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.230-beta

Syntax

C++

JavaScript

Copy

public class Frame : IFrame, IEquatable<IFrame>, 
	IComparable<IFrame>, IComparable

Public Class Frame
	Implements IFrame, IEquatable(Of IFrame), 
	IComparable(Of IFrame), IComparable

public ref class Frame : IFrame, IEquatable<IFrame^>, 
	IComparable<IFrame^>, IComparable

type Frame = 
    class
        interface IFrame
        interface IEquatable<IFrame>
        interface IComparable<IFrame>
        interface IComparable
    end

GSF.TimeSeries.Frame = function();

Type.createClass(
	'GSF.TimeSeries.Frame',
	null,
	GSF.TimeSeries.IFrame,
	IEquatable`1,
	IComparable`1,
	IComparable);

View Source

The Frame type exposes the following members.

Constructors

	Name	Description
	Frame(Ticks, IDictionaryMeasurementKey, IMeasurement)	Constructs a new Frame given the specified parameters.
	Frame(Ticks, Int32)	Constructs a new Frame given the specified parameters.

Top

Properties

	Name	Description
	CreatedTimestamp	Gets timestamp, in ticks, of when this Frame was created.
	LastSortedMeasurement	Gets or sets reference to last measurement that was sorted into this Frame.
	Lifespan	Gets the life-span of this Frame since its creation.
	Measurements	Keyed measurements in this Frame.
	Published	Gets or sets published state of this Frame (pre-processing).
	SortedMeasurements	Gets or sets total number of measurements that have been sorted into this Frame.
	Timestamp	Gets or sets exact timestamp, in Ticks, of the data represented in this Frame.

Top

Methods

	Name	Description
	Clone	Create a copy of this Frame and its measurements.
	CompareTo(IFrame)	Compares the Frame with an IFrame.
	CompareTo(Object)	Compares the Frame with the specified Object.
	Equals(IFrame)	Determines whether the specified IFrame is equal to the current Frame.
	Equals(Object)	Determines whether the specified Object is equal to the current Frame. (Overrides ObjectEquals(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)
	GetHashCode	Serves as a hash function for the current Frame. (Overrides ObjectGetHashCode)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Operators

	Name	Description
	Equality(Frame, Frame)	Compares two Frame timestamps for equality.
	GreaterThan(Frame, Frame)	Returns true if left Frame timestamp is greater than right Frame timestamp.
	GreaterThanOrEqual(Frame, Frame)	Returns true if left Frame timestamp is greater than or equal to right Frame timestamp.
	Inequality(Frame, Frame)	Compares two Frame timestamps for inequality.
	LessThan(Frame, Frame)	Returns true if left Frame timestamp is less than right Frame timestamp.
	LessThanOrEqual(Frame, Frame)	Returns true if left Frame timestamp is less than or equal to right Frame timestamp.

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Remarks

A frame represents a collection of measurements at a given time.

Reference

GSF.TimeSeries Namespace