nl.lxtreme.ols.api.devices
Interface DeviceMetadata

All Superinterfaces:
Iterable<Object>

public interface DeviceMetadata
extends Iterable<Object>

Provides some (optional) metadata of a device, as might be used by devices made by Dangerous Prototypes.

This interface provides direct access to the individual metadata values. In addition, it can be iterated to access all "known" metadata values.


Field Summary
static int KEY_ANCILLARY_VERSION
           
static int KEY_DEVICE_NAME
           
static int KEY_DYNAMIC_MEMORY_DEPTH
           
static int KEY_FPGA_VERSION
           
static int KEY_MAX_SAMPLE_RATE
           
static int KEY_PROBE_COUNT_LONG
           
static int KEY_PROBE_COUNT_SHORT
           
static int KEY_PROTOCOL_VERSION_LONG
           
static int KEY_PROTOCOL_VERSION_SHORT
           
static int KEY_SAMPLE_MEMORY_DEPTH
           
 
Method Summary
 String getAncillaryVersion()
          Returns the ancillary (e.g.
 Integer getDynamicMemoryDepth()
          Returns the maximum depth of the dynamic memory part.
 String getFpgaVersion()
          Returns the FPGA version.
 Integer getMaxSampleRate()
          Returns the maximum sample rate.
 String getName()
          Returns the device name.
 Integer getProbeCount()
          Returns the maximum number of probes supported by the device.
 Integer getProtocolVersion()
          Returns the device protocol version.
 Integer getSampleMemoryDepth()
          Returns the maximum sample memory.
 
Methods inherited from interface java.lang.Iterable
iterator
 

Field Detail

KEY_DEVICE_NAME

static final int KEY_DEVICE_NAME
See Also:
Constant Field Values

KEY_FPGA_VERSION

static final int KEY_FPGA_VERSION
See Also:
Constant Field Values

KEY_ANCILLARY_VERSION

static final int KEY_ANCILLARY_VERSION
See Also:
Constant Field Values

KEY_PROBE_COUNT_LONG

static final int KEY_PROBE_COUNT_LONG
See Also:
Constant Field Values

KEY_SAMPLE_MEMORY_DEPTH

static final int KEY_SAMPLE_MEMORY_DEPTH
See Also:
Constant Field Values

KEY_DYNAMIC_MEMORY_DEPTH

static final int KEY_DYNAMIC_MEMORY_DEPTH
See Also:
Constant Field Values

KEY_MAX_SAMPLE_RATE

static final int KEY_MAX_SAMPLE_RATE
See Also:
Constant Field Values

KEY_PROTOCOL_VERSION_LONG

static final int KEY_PROTOCOL_VERSION_LONG
See Also:
Constant Field Values

KEY_PROBE_COUNT_SHORT

static final int KEY_PROBE_COUNT_SHORT
See Also:
Constant Field Values

KEY_PROTOCOL_VERSION_SHORT

static final int KEY_PROTOCOL_VERSION_SHORT
See Also:
Constant Field Values
Method Detail

getAncillaryVersion

String getAncillaryVersion()
Returns the ancillary (e.g. PIC controller) version.

Returns:
a version string, like "1.23", can be null in case no such version was available/known.

getDynamicMemoryDepth

Integer getDynamicMemoryDepth()
Returns the maximum depth of the dynamic memory part.

Returns:
a memory depth, in bytes, can be null in case this depth is unknown.

getFpgaVersion

String getFpgaVersion()
Returns the FPGA version.

Returns:
a version string, like "1.12", can be null in case no such version was available/known.

getMaxSampleRate

Integer getMaxSampleRate()
Returns the maximum sample rate.

Returns:
a sample rate, in Hz, can be null in case the maximum sample rate is unknown.

getName

String getName()
Returns the device name.

Returns:
a device name, can be null in case no device name is available/known.

getProbeCount

Integer getProbeCount()
Returns the maximum number of probes supported by the device.

Returns:
a probe count, >= 0 && < 256, can be null in case no probe count is available/known.

getProtocolVersion

Integer getProtocolVersion()
Returns the device protocol version.

Returns:
a protocol version, or null in case no protocol version is available/known.

getSampleMemoryDepth

Integer getSampleMemoryDepth()
Returns the maximum sample memory.

Returns:
the sample memory depth, in bytes, can be null in case no sample memory depth is available/known.


Copyright © 2012 L'Xtreme IT consultancy. All Rights Reserved.