Class Sample

Defines a sequence sample mapped to one of the tracks

Inheritance

System.Object

Sample

Implements

System.ComponentModel.INotifyPropertyChanged

System.IComparable<Sample>

System.IEquatable<Sample>

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Phoenix.Input

Assembly: Phoenix.Plugin.Input.dll

Syntax

public class Sample : INotifyPropertyChanged, IComparable<Sample>, IEquatable<Sample>

Constructors

View Source

Sample(Double, Object)

Initializes a new instance of the Sample class

Declaration

public Sample(double time, object value)

Parameters

Type	Name	Description
System.Double	time	Time offset from start of sequence
System.Object	value	Sample value - boolean, double or string

View Source

Sample(Int32, Object)

Initializes a new instance of the Sample class

Declaration

public Sample(int tick, object value)

Parameters

Type	Name	Description
System.Int32	tick	Tick offset from start of sequence
System.Object	value	Sample value - boolean, double or string

Properties

View Source

Tick

Gets or sets number of ticks (1/30 of a second interval) from sequence start

Declaration

public int Tick { get; set; }

Property Value

Type	Description
System.Int32

View Source

Time

Gets or sets the time offset from sequence start in seconds This re-calculates the tick

Declaration

public double Time { get; set; }

Property Value

Type	Description
System.Double

View Source

Track

Gets or sets the track the sample belongs to

Declaration

public Track Track { get; set; }

Property Value

Type	Description
Track

View Source

Value

Gets or sets the sample value - boolean, double or string

Declaration

public object Value { get; set; }

Property Value

Type	Description
System.Object

Methods

View Source

CompareTo(Sample)

Compare functions for sorting items in a set

Declaration

public int CompareTo(Sample other)

Parameters

Type	Name	Description
Sample	other	Sample to compare to (only time)

Returns

Type	Description
System.Int32	1 if this sample is newer, -1 if older, 0 if both are equal

View Source

Duplicate()

Duplicates the sample to perform deep copy

Declaration

public Sample Duplicate()

Returns

Type	Description
Sample	Duplicated sample

View Source

Equals(Sample)

Declaration

public bool Equals(Sample other)

Parameters

Type	Name	Description
Sample	other

Returns

Type	Description
System.Boolean

View Source

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

System.Object.Equals(System.Object)

View Source

GetHashCode()

Gets the hash code

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	Hash code

Overrides

System.Object.GetHashCode()

Events

View Source

PropertyChanged

Property changed event required for INotifyPropertyChanged support

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type	Description
System.ComponentModel.PropertyChangedEventHandler

Operators

View Source

Equality(Sample, Sample)

Compares one sample to another

Declaration

public static bool operator ==(Sample first, Sample second)

Parameters

Type	Name	Description
Sample	first	First sample for comparison
Sample	second	Second sample for comparison

Returns

Type	Description
System.Boolean	Whether the two are equal

View Source

GreaterThan(Sample, Sample)

Compares one sample to another

Declaration

public static bool operator>(Sample first, Sample second)

Parameters

Type	Name	Description
Sample	first	First sample for comparison
Sample	second	Second sample for comparison

Returns

Type	Description
System.Boolean	Whether first sample is greater than second

View Source

GreaterThanOrEqual(Sample, Sample)

Compares one sample to another

Declaration

public static bool operator >=(Sample left, Sample right)

Parameters

Type	Name	Description
Sample	left	First sample for comparison
Sample	right	Second sample for comparison

Returns

Type	Description
System.Boolean	Whether the left is greater than or equal the right

View Source

Inequality(Sample, Sample)

Compares one sample to another

Declaration

public static bool operator !=(Sample first, Sample second)

Parameters

Type	Name	Description
Sample	first	First sample for comparison
Sample	second	Second sample for comparison

Returns

Type	Description
System.Boolean	Whether the two are not equal

View Source

LessThan(Sample, Sample)

Compares one sample to another

Declaration

public static bool operator <(Sample first, Sample second)

Parameters

Type	Name	Description
Sample	first	First sample for comparison
Sample	second	Second sample for comparison

Returns

Type	Description
System.Boolean	Whether first sample is lesser than second

View Source

LessThanOrEqual(Sample, Sample)

Compares one sample to another

Declaration

public static bool operator <=(Sample left, Sample right)

Parameters

Type	Name	Description
Sample	left	First sample for comparison
Sample	right	Second sample for comparison

Returns

Type	Description
System.Boolean	Whether the left is less than or equal the right

Implements

System.ComponentModel.INotifyPropertyChanged

System.IComparable<T>

System.IEquatable<T>