TraceBufferClient Class

TraceBufferClient that allows to interact with the TraceBufferServer on a SP-ICE-3 card.

Inheritance Hierarchy

SystemObject
RAYLASE.SPICE3.TraceBufferTraceBufferClient

Namespace: RAYLASE.SPICE3.TraceBuffer
Assembly: RAYLASE.SPICE3.TraceBufferLib (in RAYLASE.SPICE3.TraceBufferLib.dll) Version: 3.6.0

Syntax

public class TraceBufferClient : IDisposable

The TraceBufferClient type exposes the following members.

Properties

	Name	Description
	Connected	Indicates if the connection to the card is open.
	ReadTimeout	Maximum time in ms to wait for a TraceEvent when calling Read(TraceEvent, Int32, Int32). Use Infinite to wait forever. If timeout is set to 0, Read(TraceEvent, Int32, Int32) will directly return without an error if nothing is available. Otherwise a TimeoutExceptionis thrown if an timeout occurs.

Methods

	Name	Description
	Acquire	Reads all currently available events. Skips all events that occur before the start label. Remember that for this to work the desired events have to be enabled before TraceBufferConfig. At least Label has to be enabled. Events will only be received if Start was called before.
	Clear	Clears currently available TraceEvent locally and on the card.
	Connect	Connect to the TraceBuffer-server on the SP-ICE-3 card
	Disconnect	Disconnects from the TraceBuffer server.
	Dispose	Releases the Instance of this class.
	GetConfig	Gets the configuration from the card.
	Read	Reads a block of TraceEvent.
	SetConfig	Sets the configuration on the card.
	Start	Starts streaming from the card.
	Stop	Stops streaming from the card.
	TickToMicroSecond	Convert card ticks to μs
	ToEventGroup	Groups all events by their Timestamp. All events with the same Timestamp are stored in another dictionary with their EventType as key.
	ToGroup	Groups all events by their Timestamp. All events with the same Timestamp are stored in a list.
	ToSignedPosition(Int64)	Convert unsigned 20 bit position value received from the TraceBuffer to an signed position
	ToSignedPosition(ListTraceEvent, Boolean)	Converts the Value of all position events to a signed position.
	TryRead	Reads a block of TraceEvent.

Remarks

This allows to receive TraceEvent from a SP-ICE-3 card and to configure the TraceEvents that should occur.