A Class which acquires and manages scope trace information More...

Public Member Functions
void	ClearReference ()
	clears the currently assigned reference trace. More...

float[]	GetAverage ()
	Returns the current trace average. More...

TLink	GetAverageLink ()
	Returns the embedded TINE Link representing the trace average More...

int	GetPreTriggerPosition ()
	Returns the pre-trigger postion of the trace More...

String[]	GetProperties (String devName, String devProperty)
	Returns a list of associated trace properties More...

float[]	GetReference ()
	Returns the current reference trace. More...

TLink	GetReferenceLink ()
	Returns the embedded TINE Link representing the reference trace More...

double	GetReferenceTimestamp ()
	Returns the reference timestamp More...

float	GetScaleX ()
	Returns the X Axis scale factor More...

TLink	GetSequenceLink ()
	Returns the embedded TINE Link representing the trace sequence More...

float[]	GetTrace ()
	Returns the current trace More...

int	GetTraceLength ()
	Returns the length of the trace More...

TLink	GetTraceLink ()
	Returns the embedded TINE Link representing the trace More...

float	GetTracePlotMaximum ()
	Returns the Y Axis maximum setting More...

float	GetTracePlotMinimum ()
	Returns the Y Axis minimum setting More...

float[][]	GetTraceSequence ()
	Returns a jagged double array containing the trace sequence. More...

int	GetTraceStatus ()
	Returns the current trace link status More...

String	GetTraceStatusString ()
	Returns the current trace link status as a string More...

double	GetTraceTimestamp ()
	Returns the current trace timestamp More...

float[]	GetXAxis ()
	Returns the X-Axis appropriate to the trace More...

String	GetXAxisUnits ()
	Returns the X Axis units More...

float	GetXOffset ()
	Returns the X Axis offset More...

String	GetYAxisUnits ()
	Returns the Y Axis units More...

int	MonitorTrace (TTraceHandler myTraceHandler, Boolean scheduled, int pollingRate)
	Begins monitoring the assigned trace parameters More...

void	SetReferenceTimestamp (double referenceTimestamp)
	assigns the given timestamp to the reference trace More...

void	SetReferenceTrace (float[] reference)
	Specifies a reference trace More...

void	SetReferenceTrace (float[] reference, double referenceTimestamp)
	Specifies a reference trace More...

void	StopMonitor ()
	Stops all monitoring More...

	TTrace (String context, String server)
	Contructs a Trace object but does not begin monitoring More...

	TTrace (String context, String server, String device)
	Contructs a Trace object but does not begin monitoring More...

	TTrace (String context, String server, String device, String property)
	Contructs a Trace object but does not begin monitoring More...

Detailed Description

A Class which acquires and manages scope trace information

Constructor & Destructor Documentation

◆ TTrace() [1/3]

tine.TTrace.TTrace	(	String	context,
		String	server,
		String	device,
		String	property
	)

inline

Contructs a Trace object but does not begin monitoring

Parameters

context	The context scope server
server	The scope server name
device	The device instance of the scope trace
property	The scope trace property

References tine.TTrace.GetProperties().

◆ TTrace() [2/3]

tine.TTrace.TTrace	(	String	context,
		String	server,
		String	device
	)

inline

Contructs a Trace object but does not begin monitoring

The default property "Trace" is assumed.

Parameters

context	The context scope server
server	The scope server name
device	The device instance of the scope trace

◆ TTrace() [3/3]

tine.TTrace.TTrace	(	String	context,
		String	server
	)

inline

Contructs a Trace object but does not begin monitoring

The default property "Trace" is assumed. The primary device location is assumed.

Parameters

context	The context scope server
server	The scope server name

Member Function Documentation

◆ ClearReference()

void tine.TTrace.ClearReference ( )

inline

clears the currently assigned reference trace.

◆ GetAverage()

float [] tine.TTrace.GetAverage ( )

inline

Returns the current trace average.

Returns: the current trace average.

◆ GetAverageLink()

TLink tine.TTrace.GetAverageLink ( )

inline

Returns the embedded TINE Link representing the trace average

Returns: the embedded TINE Link representing the trace average

◆ GetPreTriggerPosition()

int tine.TTrace.GetPreTriggerPosition ( )

inline

Returns the pre-trigger postion of the trace

Returns: the pre-trigger postion of the trace

References tine.TraceHS.preTrigger.

◆ GetProperties()

String [] tine.TTrace.GetProperties	(	String	devName,
		String	devProperty
	)

inline

Returns a list of associated trace properties

Parameters

devName	is the fully specified device name of the trace server
devProperty	is the trace property

Returns: a list of associated trace properties

References tine.TQuery.GetSystemProperties().

Referenced by tine.TTrace.TTrace().

◆ GetReference()

float [] tine.TTrace.GetReference ( )

inline

Returns the current reference trace.

Returns: the current reference trace.

◆ GetReferenceLink()

TLink tine.TTrace.GetReferenceLink ( )

inline

Returns the embedded TINE Link representing the reference trace

Returns: the embedded TINE Link representing the reference trace

◆ GetReferenceTimestamp()

double tine.TTrace.GetReferenceTimestamp ( )

inline

Returns the reference timestamp

Returns: the reference timestamp

References tine.TLink.GetCompletionDataTimeStamp(), and tine.TLink.GetStatus().

◆ GetScaleX()

float tine.TTrace.GetScaleX ( )

inline

Returns the X Axis scale factor

Returns: the X Axis scale factor

References tine.TraceHS.ScaleX.

◆ GetSequenceLink()

TLink tine.TTrace.GetSequenceLink ( )

inline

Returns the embedded TINE Link representing the trace sequence

Returns: the embedded TINE Link representing the trace sequence

◆ GetTrace()

float [] tine.TTrace.GetTrace ( )

inline

Returns the current trace

Returns: the current trace

◆ GetTraceLength()

int tine.TTrace.GetTraceLength ( )

inline

Returns the length of the trace

Returns: the length of the trace

◆ GetTraceLink()

TLink tine.TTrace.GetTraceLink ( )

inline

Returns the embedded TINE Link representing the trace

Returns: the embedded TINE Link representing the trace

◆ GetTracePlotMaximum()

float tine.TTrace.GetTracePlotMaximum ( )

inline

Returns the Y Axis maximum setting

Returns: the Y Axis maximum setting

References tine.TraceHS.PlotMaxY.

◆ GetTracePlotMinimum()

float tine.TTrace.GetTracePlotMinimum ( )

inline

Returns the Y Axis minimum setting

Returns: the Y Axis minimum setting

References tine.TraceHS.PlotMinY.

◆ GetTraceSequence()

float [][] tine.TTrace.GetTraceSequence ( )

inline

Returns a jagged double array containing the trace sequence.

Returns: a jagged double array containing the trace sequence.

References tine.TLink.Execute(), tine.TDataType.GetDataTimeStamp(), and tine.TLink.GetStatusString().

◆ GetTraceStatus()

int tine.TTrace.GetTraceStatus ( )

inline

Returns the current trace link status

Returns: the current trace link status

◆ GetTraceStatusString()

String tine.TTrace.GetTraceStatusString ( )

inline

Returns the current trace link status as a string

Returns: the current trace link status as a string

◆ GetTraceTimestamp()

double tine.TTrace.GetTraceTimestamp ( )

inline

Returns the current trace timestamp

Returns: the current trace timestamp

References tine.TLink.GetCompletionDataTimeStamp().

◆ GetXAxis()

float [] tine.TTrace.GetXAxis ( )

inline

Returns the X-Axis appropriate to the trace

The X axis offset and scale are used to establish the X axis.

Returns: the X-Axis appropriate to the trace

References tine.TraceHS.OffsetX, and tine.TraceHS.ScaleX.

◆ GetXAxisUnits()

String tine.TTrace.GetXAxisUnits ( )

inline

Returns the X Axis units

Returns: the X Axis units

References tine.TraceHS.GetUnitsX().

◆ GetXOffset()

float tine.TTrace.GetXOffset ( )

inline

Returns the X Axis offset

Returns: the X Axis offset

References tine.TraceHS.OffsetX.

◆ GetYAxisUnits()

String tine.TTrace.GetYAxisUnits ( )

inline

Returns the Y Axis units

Returns: the Y Axis units

References tine.TraceHS.GetUnitsY().

◆ MonitorTrace()

int tine.TTrace.MonitorTrace	(	TTraceHandler	myTraceHandler,
		Boolean	scheduled,
		int	pollingRate
	)

inline

Begins monitoring the assigned trace parameters

Parameters

myTraceHandler	is the trace update handler delegate
scheduled	if true, indicates that the updates should occur at the server's trigger rate
pollingRate	specifies the prefered monitoring interval in milliseconds

Returns: 0 if successful.

References tine.TLink.Attach().

◆ SetReferenceTimestamp()

void tine.TTrace.SetReferenceTimestamp ( double referenceTimestamp )

inline

assigns the given timestamp to the reference trace

Parameters

referenceTimestamp is the desired reference timestamp

◆ SetReferenceTrace() [1/2]

void tine.TTrace.SetReferenceTrace ( float[] reference )

inline

Specifies a reference trace

Parameters

reference is the desired reference trace

◆ SetReferenceTrace() [2/2]

void tine.TTrace.SetReferenceTrace	(	float[]	reference,
		double	referenceTimestamp
	)

inline

Specifies a reference trace

Parameters

reference	is the desired reference trace
referenceTimestamp	is the timestamp of the reference trace

◆ StopMonitor()

void tine.TTrace.StopMonitor ( )

inline

Stops all monitoring

References tine.TLink.Close().

The documentation for this class was generated from the following file:

tine.cs

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TTrace() [1/3]

◆ TTrace() [2/3]

◆ TTrace() [3/3]

Member Function Documentation

◆ ClearReference()

◆ GetAverage()

◆ GetAverageLink()

◆ GetPreTriggerPosition()

◆ GetProperties()

◆ GetReference()

◆ GetReferenceLink()

◆ GetReferenceTimestamp()

◆ GetScaleX()

◆ GetSequenceLink()

◆ GetTrace()

◆ GetTraceLength()

◆ GetTraceLink()

◆ GetTracePlotMaximum()

◆ GetTracePlotMinimum()

◆ GetTraceSequence()

◆ GetTraceStatus()

◆ GetTraceStatusString()

◆ GetTraceTimestamp()

◆ GetXAxis()

◆ GetXAxisUnits()

◆ GetXOffset()

◆ GetYAxisUnits()

◆ MonitorTrace()

◆ SetReferenceTimestamp()

◆ SetReferenceTrace() [1/2]

◆ SetReferenceTrace() [2/2]

◆ StopMonitor()