Interface ILib.IAcquire.IDigital

Namespace

Csra.Interfaces

Assembly

Csra.dll

The interface for the Digital branch.

public interface ILib.IAcquire.IDigital

Methods

MeasureFrequency(Pins)

Measures and returns the frequency configured by Setup.Digital.FrequencyCounter.

PinSite<double> MeasureFrequency(Pins pins)

Parameters

pins Pins

List of pin or pin group names.

Returns

PinSite<double>

The measured frequency for each pin in Hz.

PatternResults()

Site<bool> PatternResults()

Returns

Site<bool>

Read(Pins, int, int)

Reads captured pin data from HRAM and returns raw results as IPinListData

PinSite<Samples<int>> Read(Pins pins, int startIndex = 0, int cycle = 0)

Parameters

pins Pins

Pin names, must contain digital pins

startIndex int

Optional. Index to start capture

cycle int

Optional. Cycle of data to capture for pins in 2x or 4x modes

Returns

PinSite<Samples<int>>

Raw captured pin data

Exceptions

ArgumentException

ReadWords(Pins, int, int, int, tlBitOrder)

Reads pin data from specified cycles in HRAM for the specified pin, groups the data into words of a specified size, and populates these words into an array of SiteLong objects

PinSite<Samples<int>> ReadWords(Pins pins, int startIndex, int length, int wordSize, tlBitOrder bitOrder)

Parameters

pins Pins

Pin names, digital pins required

startIndex int

Index to start data processing

length int

Number of bits to process

wordSize int

Number of bits in each word

bitOrder tlBitOrder

Order of bits, either msbForst or lsbFirst

Returns

PinSite<Samples<int>>

Word values in array of ISiteLong

Exceptions

ArgumentException

TryReadCapture(IDigitalCapture)

Try reads capture memory data.

bool TryReadCapture(IDigitalCapture digitalCapture)

Parameters

digitalCapture IDigitalCapture

Tol digital capture object.

Returns

bool

True if the capture memory data was successfully read; otherwise, false.