Class SLScope.TSLChannelData

Revision as of 23:53, 25 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation) ← Older edit		Latest revision as of 00:30, 26 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation)
(One intermediate revision by one user not shown)
Line 24:		Line 24:
	=== C# (.NET): ===		=== C# (.NET): ===
	<code>		<code>
−	'''public ref class''' TSLChannelData	+	'''public ref class''' ChannelData
	</code>		</code>
	== Summary ==		== Summary ==

---

Latest revision as of 00:30, 26 June 2013

This is a Beta Read Only version of this page. Please review and send recommendations to mitov@mitov.com. We will enable the editing as soon as we are happy with the overall Wiki site.

Package: SignalLabScopePkg

Unit: SLScope

Contents 1 Syntax 1.1 Delphi: 1.2 C++ Builder: 1.3 Visual C++ (MFC): 1.4 C# (.NET): 2 Summary 3 Description 4 Properties 4.1 Public 5 Methods 5.1 Public

Syntax

Delphi:

type TSLChannelData = class

C++ Builder:

class TSLChannelData

Visual C++ (MFC):

class CTSLChannelData

C# (.NET):

public ref class ChannelData

Summary

Channel data class.

Description

This class is used by the channels to provide access to the channel data. Do not make instances of this class.

Properties

Public

• SampleRate - The sample rate for the channel.

Methods

Public

• procedure SetYData(ABuffer : PWord; ASize : Cardinal) - Sets new unsigned short(Word) Y data buffers to the channel data.
• procedure SetYData(ABuffer : PSmallInt; ASize : Cardinal) - Sets new short(SmallInt) Y data buffers to the channel data.
• procedure SetYData(ABuffer : PCardinal; ASize : Cardinal) - Sets new Unsigned Integer(Cardinal) Y data buffers to the channel data.
• procedure SetYData(ABuffer : PInteger; ASize : Cardinal) - Sets new Integer Y data buffers to the channel data.
• procedure SetYData(ABuffer : PInt64; ASize : Cardinal) - Sets new 64 bit Integer Y data buffers to the channel data.
• procedure SetYData(ABuffer : PUInt64; ASize : Cardinal) - Sets new 64 bit Unsigned Integer Y data buffers to the channel data.
• procedure SetYData(ABuffer : PSingle; ASize : Cardinal) - Sets new Single(float) Y data buffers to the channel data.
• procedure SetYData(ABuffer : PReal; ASize : Cardinal) - Sets new Real(double) Y data buffers to the channel data.
• procedure SetYData(ABuffer : ISLRealBuffer) - Sets new Real(double) Y data buffers to the channel data.
• procedure SetYData(ABuffer : ISLIntegerBuffer) - Sets new Integer Y data buffers to the channel data.
• procedure SetXYData(XBuffer : PWord; YBuffer : PWord; ASize : Cardinal) - Sets new unsigned short(Word) X and Y data buffers to the channel data.
• procedure SetXYData(XBuffer : PSmallInt; YBuffer : PSmallInt; ASize : Cardinal) - Sets new short(SmallInt) X and Y data buffers to the channel data.
• procedure SetXYData(XBuffer : PCardinal; YBuffer : PCardinal; ASize : Cardinal) - Sets new Unsigned Integer(Cardinal) X and Y data buffers to the channel data.
• procedure SetXYData(XBuffer : PInteger; YBuffer : PInteger; ASize : Cardinal) - Sets new Integer X and Y data buffers to the channel data.
• procedure SetXYData(XBuffer : PInt64; YBuffer : PInt64; ASize : Cardinal) - Sets new 64 bit Integer X and Y data buffers to the channel data.
• procedure SetXYData(XBuffer : PUInt64; YBuffer : PUInt64; ASize : Cardinal) - Sets new 64 bit Unsigned Integer X and Y data buffers to the channel data.
• procedure SetXYData(XBuffer : PSingle; YBuffer : PSingle; ASize : Cardinal) - Sets new Single(float) X and Y data buffers to the channel data.
• procedure SetXYData(XBuffer : PReal; YBuffer : PReal; ASize : Cardinal) - Sets new Real(double) X and Y data buffers to the channel data.
• procedure SetXYData(XBuffer : ISLRealBuffer; YBuffer : ISLRealBuffer) - Sets new Real(double) X and Y data buffers to the channel data.
• procedure SetXYData(XBuffer : ISLIntegerBuffer; YBuffer : ISLIntegerBuffer) - Sets new Integer X and Y data buffers to the channel data.
• procedure AddYData(ABuffer : PWord; ASize : Cardinal) - Adds new unsigned short(Word) Y data buffer to the channel data.
• procedure AddYData(ABuffer : PWord; ASize : Cardinal; ASeparate : Boolean) - Adds new unsigned short(Word) Y data buffer to the channel data, with optional data gap.
• procedure AddYData(ABuffer : PSmallInt; ASize : Cardinal) - Adds new short(SmallInt) Y data buffer to the channel data.
• procedure AddYData(ABuffer : PSmallInt; ASize : Cardinal; ASeparate : Boolean) - Adds new short(SmallInt) Y data buffer to the channel data, with optional data gap.
• procedure AddYData(ABuffer : PCardinal; ASize : Cardinal) - Adds new Unsigned Integer(Cardinal) Y data buffer to the channel data.
• procedure AddYData(ABuffer : PCardinal; ASize : Cardinal; ASeparate : Boolean) - Adds new Unsigned Integer(Cardinal) Y data buffer to the channel data, with optional data gap.
• procedure AddYData(ABuffer : PInteger; ASize : Cardinal) - Adds new Integer Y data buffer to the channel data.
• procedure AddYData(ABuffer : PInteger; ASize : Cardinal; ASeparate : Boolean) - Adds new Integer Y data buffer to the channel data, with optional data gap.
• procedure AddYData(ABuffer : PInt64; ASize : Cardinal) - Adds new 64 bit Integer Y data buffer to the channel data.
• procedure AddYData(ABuffer : PInt64; ASize : Cardinal; ASeparate : Boolean) - Adds new 64 bit Integer Y data buffer to the channel data, with optional data gap.
• procedure AddYData(ABuffer : PUInt64; ASize : Cardinal) - Adds new 64 bit Unsigned Integer Y data buffer to the channel data.
• procedure AddYData(ABuffer : PUInt64; ASize : Cardinal; ASeparate : Boolean) - Adds new 64 bit Unsigned Integer Y data buffer to the channel data, with optional data gap.
• procedure AddYData(ABuffer : PSingle; ASize : Cardinal) - Adds new Single(float) Y data buffer to the channel data.
• procedure AddYData(ABuffer : PSingle; ASize : Cardinal; ASeparate : Boolean) - Adds new Single(float) Y data buffer to the channel data, with optional data gap.
• procedure AddYData(ABuffer : PReal; ASize : Cardinal) - Adds new Real(double) Y data buffer to the channel data.
• procedure AddYData(ABuffer : PReal; ASize : Cardinal; ASeparate : Boolean) - Adds new Real(double) Y data buffer to the channel data, with optional data gap.
• procedure AddYData(ABuffer : ISLRealBuffer) - Adds new Real(double) Y data buffer to the channel data.
• procedure AddYData(ABuffer : ISLRealBuffer; ASeparate : Boolean) - Adds new Real(double) Y data buffer to the channel data, with optional data gap.
• procedure AddYData(ABuffer : ISLIntegerBuffer) - Adds new Integer Y data buffer to the channel data.
• procedure AddYData(ABuffer : ISLIntegerBuffer; ASeparate : Boolean) - Adds new Integer Y data buffer to the channel data, with optional data gap.
• procedure AddXYData(XBuffer : PWord; YBuffer : PWord; ASize : Cardinal) - Adds new unsigned short(Word) X and Y data buffers to the channel data.
• procedure AddXYData(XBuffer : PWord; YBuffer : PWord; ASize : Cardinal; ASeparate : Boolean) - Adds new unsigned short(Word) X and Y data buffers to the channel data, with optional data gap.
• procedure AddXYData(XBuffer : PSmallInt; YBuffer : PSmallInt; ASize : Cardinal) - Adds new short(SmallInt) X and Y data buffers to the channel data.
• procedure AddXYData(XBuffer : PSmallInt; YBuffer : PSmallInt; ASize : Cardinal; ASeparate : Boolean) - Adds new short(SmallInt) X and Y data buffers to the channel data, with optional data gap.
• procedure AddXYData(XBuffer : PCardinal; YBuffer : PCardinal; ASize : Cardinal) - Adds new Unsigned Integer(Cardinal) X and Y data buffers to the channel data.
• procedure AddXYData(XBuffer : PCardinal; YBuffer : PCardinal; ASize : Cardinal; ASeparate : Boolean) - Adds new Unsigned Integer(Cardinal) X and Y data buffers to the channel data, with optional data gap.
• procedure AddXYData(XBuffer : PInteger; YBuffer : PInteger; ASize : Cardinal) - Adds new Integer X and Y data buffers to the channel data.
• procedure AddXYData(XBuffer : PInteger; YBuffer : PInteger; ASize : Cardinal; ASeparate : Boolean) - Adds new Integer X and Y data buffers to the channel data, with optional data gap.
• procedure AddXYData(XBuffer : PInt64; YBuffer : PInt64; ASize : Cardinal) - Adds new 64 bit Integer X and Y data buffers to the channel data.
• procedure AddXYData(XBuffer : PUInt64; YBuffer : PUInt64; ASize : Cardinal) - Adds new 64 bit Unsigned Integer X and Y data buffers to the channel data.
• procedure AddXYData(XBuffer : PInt64; YBuffer : PInt64; ASize : Cardinal; ASeparate : Boolean) - Adds new 64 bit Integer X and Y data buffers to the channel data, with optional data gap.
• procedure AddXYData(XBuffer : PUInt64; YBuffer : PUInt64; ASize : Cardinal; ASeparate : Boolean) - Adds new 64 bit Unsigned Integer X and Y data buffers to the channel data, with optional data gap.
• procedure AddXYData(XBuffer : PSingle; YBuffer : PSingle; ASize : Cardinal) - Adds new Single(float) X and Y data buffers to the channel data.
• procedure AddXYData(XBuffer : PSingle; YBuffer : PSingle; ASize : Cardinal; ASeparate : Boolean) - Adds new Single(float) X and Y data buffers to the channel data, with optional data gap.
• procedure AddXYData(XBuffer : PReal; YBuffer : PReal; ASize : Cardinal) - Adds new Real(double) X and Y data buffers to the channel data.
• procedure AddXYData(XBuffer : PReal; YBuffer : PReal; ASize : Cardinal; ASeparate : Boolean) - Adds new Real(double) X and Y data buffers to the channel data, with optional data gap.
• procedure AddXYData(XBuffer : ISLRealBuffer; YBuffer : ISLRealBuffer) - Adds new Real(double) X and Y data buffers to the channel data.
• procedure AddXYData(XBuffer : ISLRealBuffer; YBuffer : ISLRealBuffer; ASeparate : Boolean) - Adds new Real(double) X and Y data buffers to the channel data, with optional data gap.
• procedure AddXYData(XBuffer : ISLIntegerBuffer; YBuffer : ISLIntegerBuffer) - Adds new Integer X and Y data buffers to the channel data.
• procedure AddXYData(XBuffer : ISLIntegerBuffer; YBuffer : ISLIntegerBuffer; ASeparate : Boolean) - Adds new Integer X and Y data buffers to the channel data, with optional data gap.
• procedure Clear() - Clears the data in the channel.
• procedure AddYPoint(AValue : Real) - Adds a data point with Y value to the data buffer for the channel.
• procedure AddYPoint(AValue : Real; ASeparate : Boolean) - Adds a data point with Y value to the data buffer for the channel, optionally adding gap in the data.
• procedure AddXYPoint(XValue : Real; YValue : Real) - Adds a data point with X and Y values.
• procedure AddXYPoint(XValue : Real; YValue : Real; ASeparate : Boolean) - Adds a data point with X and Y values, optionally adding gap in the data.
• function GetSize() : Integer - Returns the data buffer size from the last buffer sent to the scope.
• procedure GetXData(ABuffer : PReal) - Retrieves the X data from the last buffer sent to the scope.
• procedure GetYData(ABuffer : PReal) - Retrieves the Y data from the last buffer sent to the scope.
• procedure GetXYData(XBuffer : PReal; YBuffer : PReal) - Retrieves the X and Y data from the last buffer sent to the scope.
• function GetDrawSize() : Integer - Returns the size of the data buffer currently shown on the scope.
• procedure GetDrawXData(ABuffer : PReal) - Returns the X data of the buffer currently shown on the scope.
• procedure GetDrawYData(ABuffer : PReal) - Returns the Y data of the buffer currently shown on the scope.
• procedure GetDrawXYData(XBuffer : PReal; YBuffer : PReal) - Returns the X and Y data of the buffer currently shown on the scope.
• function GetDataSnapshot() : ISLChannelDataSnapshot - Returns a snapshot of the latest channel data.
• function GetDrawDataSnapshot() : ISLChannelDataSnapshot - Returns a snapshot of the currently displayed channel data.