C# Class Saleae.SocketApi.ExportDataStruct

Datei anzeigen Open project: saleae/SaleaeSocketApi Class Usage Examples

Public Properties

Property Type Description
AnalogChannelsToExport int[]
AnalogFormat AnalogOutputFormat
BinaryBitShifting BinaryBitShifting
BinaryOutputMode BinaryOutputMode
BinaryOutputWordSize BinaryOutputWordSize
CsvDelimiterType CsvDelimiterType
CsvDensity CsvDensity
CsvDisplayBase CsvBase
CsvIncludeHeaders CsvHeadersType
CsvOutputMode CsvOutputMode
CsvTimestampType CsvTimestampType
DataExportMixedExportMode DataExportMixedModeExportType
DataExportType DataExportType
DigitalChannelsToExport int[]
EndingTime double
ExportChannelSelection DataExportChannelSelection
FileName String
SamplesRangeType DataExportSampleRangeType
StartingTime double

Property Details

AnalogChannelsToExport public_oe property

List channel indexes of analog channels to export. Only required if you select "SpecificChannels"
public int[] AnalogChannelsToExport
return int[]

AnalogFormat public_oe property

ADC values or floating point voltages. Required for all export types that include analog channels
public AnalogOutputFormat AnalogFormat
return AnalogOutputFormat

BinaryBitShifting public_oe property

Only required for digital only Binary mode
public BinaryBitShifting BinaryBitShifting
return BinaryBitShifting

BinaryOutputMode public_oe property

Only required for digital only Binary mode
public BinaryOutputMode BinaryOutputMode
return BinaryOutputMode

BinaryOutputWordSize public_oe property

Only required for digital only Binary mode
public BinaryOutputWordSize BinaryOutputWordSize
return BinaryOutputWordSize

CsvDelimiterType public_oe property

Required for all CSV exports
public CsvDelimiterType CsvDelimiterType
return CsvDelimiterType

CsvDensity public_oe property

Only required when exporting digital only CSV data. CsvTransition produces a smaller file where only transition timestamps are exported CsvComplete includes every single sample
public CsvDensity CsvDensity
return CsvDensity

CsvDisplayBase public_oe property

Required when exporting analog samples as raw ADC value. Also Required when exporting digital only data in "CsvSingleNumber" format
public CsvBase CsvDisplayBase
return CsvBase

CsvIncludeHeaders public_oe property

Required for all CSV exports.
public CsvHeadersType CsvIncludeHeaders
return CsvHeadersType

CsvOutputMode public_oe property

Required only when exporting digital only CSV. Does not apply when exporting analog and digital or analog only.
public CsvOutputMode CsvOutputMode
return CsvOutputMode

CsvTimestampType public_oe property

Only applies when exporting digital only CSV Does not apply when exporting analog and digital or analog only. (time values used)
public CsvTimestampType CsvTimestampType
return CsvTimestampType

DataExportMixedExportMode public_oe property

This option is only required & applied IF your capture contains digital and analog channels, AND you select "Specific Channels" for the channel selection option. i. e. If you then select digital only, you will get the native, digital only interface for an export mode.
public DataExportMixedModeExportType DataExportMixedExportMode
return DataExportMixedModeExportType

DataExportType public_oe property

Primary export type. Always required
public DataExportType DataExportType
return DataExportType

DigitalChannelsToExport public_oe property

List channel indexes of digital channels to export. Only required if you select "SpecificChannels"
public int[] DigitalChannelsToExport
return int[]

EndingTime public_oe property

End time of export. Only appies if "RangeTimes" is set. Relative to trigger sample, can be negative.
public double EndingTime
return double

ExportChannelSelection public_oe property

This option allows you to export all channels in the capture, or only specific channels. Alaways required
public DataExportChannelSelection ExportChannelSelection
return DataExportChannelSelection

FileName public_oe property

The fully qualified path to the target file. Folder must exist. Path must be absolute. Always required features like ~/ and %appdata% are not supported. You can exand those first before passing the path.
public String FileName
return String

SamplesRangeType public_oe property

Export all time, or just export a specific range of time. Always required Command will NAK if a custom time range extends past captured data.
public DataExportSampleRangeType SamplesRangeType
return DataExportSampleRangeType

StartingTime public_oe property

Start time of export. Only appies if "RangeTimes" is set. Relative to trigger sample, can be negative.
public double StartingTime
return double