Class LiveScopeFileDataCapture

Namespace

LiveScope.Net

Assembly

LiveScope.Net.dll

Playback data from a LiveScope file

public class LiveScopeFileDataCapture : IDataCapture, IPeriodicEmissionCapture, IBackgroundDataCapture

Inheritance

object

LiveScopeFileDataCapture

Implements

IDataCapture

IPeriodicEmissionCapture

IBackgroundDataCapture

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

LiveScopeFileDataCapture(Stream, double, int)

Capture new LiveScope data capture from the specified stream

public LiveScopeFileDataCapture(Stream Stream, double VisibleTime, int UpdatePeriodMs = 10)

Parameters

Stream Stream

Data stream

VisibleTime double

Maximum number of seconds visible (determines buffer size)

UpdatePeriodMs int

(Optional) How often data is emitted (milliseconds)

LiveScopeFileDataCapture(string)

Capture LiveScope data from the specified file and statically display all the data

public LiveScopeFileDataCapture(string FilePath)

Parameters

FilePath string

File path

LiveScopeFileDataCapture(string, double, int)

Capture LiveScope data from the specified file and replay the data as if it was live data

public LiveScopeFileDataCapture(string FilePath, double VisibleTime, int UpdatePeriodMs = 10)

Parameters

FilePath string

File path

VisibleTime double

Maximum number of seconds visible (determines buffer size)

UpdatePeriodMs int

(Optional) How often data is emitted (milliseconds)

Properties

BufferSize

Buffer size (maximum number of double values stored within the buffer)

public int BufferSize { get; }

Property Value

int

DataSource

Source of data

public DataSources DataSource { get; }

Property Value

DataSources

EmissionPeriod

How often new samples are emitted, in milliseconds

public int EmissionPeriod { get; }

Property Value

int

ID

Data capture identifier

public Guid ID { get; }

Property Value

Guid

IsCapturing

Background capture thread is currently active

public bool IsCapturing { get; set; }

Property Value

bool

SampleInterval

Sample interval (seconds)

public double SampleInterval { get; }

Property Value

double

Remarks

Amount of time between each sample value (in seconds)

SampleOrder

Sample ordering

public SampleOrderTypes SampleOrder { get; }

Property Value

SampleOrderTypes

SweepMode

Sweep mode, determining when acquisition is halted

public SweepModes SweepMode { get; }

Property Value

SweepModes

Methods

SetOnDataAvailable(SamplesDelegate)

Assign callback method for when data is available to render

public void SetOnDataAvailable(SamplesDelegate callback)

Parameters

callback SamplesDelegate

Callback

StartCapture()

Start capturing

public void StartCapture()

StopCapture()

Stop capturing

public void StopCapture()