Class SLScope.TSLScopeChannel

Revision as of 20:29, 10 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation) ← Older edit

Revision as of 00:06, 11 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation) Newer edit →

---

Revision as of 00:06, 11 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

Inherits: TSLDisplayChannel

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 Published 4.2 Public 5 Methods 5.1 Public 6 Pins 7 Events 8 From TSLDisplayChannel 9 Properties 9.1 Published 9.2 Public 10 Methods 10.1 Public 11 From TSLOptionalDisplayCollectionItem 12 Properties 12.1 Published 13 From TSLDisplaySelectableCollectionItem 14 Methods 14.1 Public 15 From TSLDisplayCollectionItem 16 Properties 16.1 Published 17 From TLPNamedCollectionItem 18 Properties 18.1 Published 19 From TLPCollectionItem 20 Methods 20.1 Public

Syntax

Delphi:

type TSLScopeChannel = class( TSLDisplayChannel )

C++ Builder:

class TSLScopeChannel : public TSLDisplayChannel

Visual C++ (MFC):

class CTSLScopeChannel : public CTSLDisplayChannel

C# (.NET):

public ref class TSLScopeChannel : Mitov.PlotLab.DisplayChannel

Summary

Visual Scope data channels class.

Description

Defines the class for visual data display channels such as the channels in Scope components. Do not make instances of this class.

Example of 3 channels in a data view:

Properties

Published

• ShadeMode - Specifies the Shade mode for the channel.
• Synchronize - Specifies if the channel data will be synchronized with the other channels.
• Markers - Collection of Markers associated with the Scope channel.

Public

• DrawMarkers - Collection of currently drawn Markers associated with the Scope channel.
• Data - Allows setting the channel data.

Methods

Public

• procedure InvalidateChannel()
• function GetOwner() : TPersistent

Pins

• InputPin - The Y Input pin of the channel.
• XInputPin - The X Input pin of the channel.

Events

• OnSampleDraw - Occurs when a sample is in about to be painted.
• OnChannelDraw - Occurs when a channel is in about to be painted.

From TSLDisplayChannel

Properties

Published

• XAxisIndex - Specifies the index of the X axis the channel will be associated with.
• YAxisIndex - Specifies the index of the Y axis the channel will be associated with.
• Color - Specifies the color for the plotting of the channel data.
• Width - Specifies the width in pixels for the plotting of the channel data.
• Points - Specifies the look and feel of the channel points.
• ChannelMode - Specifies the channel display mode as line, bars or points.
• MouseCursor - Specifies the image used to represent the mouse pointer when it passes into the region covered by the chanel.
• Style - Specifies the pen style of the channel.

Public

• XAxis - Specifies the X axis the channel will be associated with.
• YAxis - Specifies the Y axis the channel will be associated with.

Methods

Public

• function GetXPointsAtValue(YValue : Real) : TSLScopeRealPoints
• function GetYPointsAtValue(XValue : Real) : TSLScopeRealPoints
• function GetOwnerComponent() : TSLDataDisplay
• procedure Invalidate()
• procedure InvalidateChannel()

From TSLOptionalDisplayCollectionItem

Properties

Published

• Visible - Specifies if the item will be visible.

From TSLDisplaySelectableCollectionItem

Methods

Public

• procedure MouseEnter()
• procedure MouseLeave()
• procedure MouseDown(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer; MouseInside : Boolean; var MouseHandled : Boolean)
• procedure MouseUp(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer; MouseInside : Boolean)

From TSLDisplayCollectionItem

Properties

Published

• Tag - Stores an general purpose integer value as part of an item

From TLPNamedCollectionItem

Properties

Published

• Name

From TLPCollectionItem

Methods

Public

• function QueryInterface(IID : TGUID; Obj : TLPCollectionItem) : HResult