Class SLGenericFilter.TSLGenericFilter

Revision as of 00:11, 11 October 2012 (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)
(7 intermediate revisions by one user not shown)
Line 28:		Line 28:
	=== C# (.NET): ===		=== C# (.NET): ===
	<code>		<code>
−	'''public ref class''' TSLGenericFilter : [[Class SLBasicGenericFilter.TSLBasicStartGenericFilter|Mitov.SignalLab.BasicStartGenericFilter]]	+	'''public ref class''' GenericFilter : [[Class SLBasicGenericFilter.TSLBasicStartGenericFilter|Mitov.SignalLab.BasicStartGenericFilter]]
	</code>		</code>
	== Summary ==		== Summary ==
Line 39:		Line 39:
	Implement the user defined filter inside the [[Event SLGenericFilter.TSLGenericFilter.OnProcessData|OnProcessData]]		Implement the user defined filter inside the [[Event SLGenericFilter.TSLGenericFilter.OnProcessData|OnProcessData]]
	event handler.		event handler.
		+
		+
		+
		+	<b>Diagram:</b>
		+
		+	[[Image:SLGenericFilter_Preview.png]]
	== Methods ==		== Methods ==
Line 73:		Line 79:
	== Pins ==		== Pins ==
−	*[[Pin SLCommonFilter.TSLCommonBinaryFilter.OutputPin|OutputPin]] - The output pin of the filter.	+	*[[Pin SLCommonFilter.TSLCommonBinaryFilter.OutputPin|OutputPin]]
−	*[[Pin SLCommonFilter.TSLCommonBinaryFilter.InputPin|InputPin]] - The input pin of the component.	+	*[[Pin SLCommonFilter.TSLCommonBinaryFilter.InputPin|InputPin]]
	== From [[Class SLCommonFilter.TSLCommonFilter|TSLCommonFilter]] ==		== From [[Class SLCommonFilter.TSLCommonFilter|TSLCommonFilter]] ==
Line 81:		Line 87:
	=== Public ===		=== Public ===
−	*[[Property SLCommonFilter.TSLCommonFilter.SampleRate|SampleRate]] - The current sample rate.	+	*[[Property SLCommonFilter.TSLCommonFilter.SampleRate|SampleRate]]
	== From [[Class SLCommonFilter.TSLBasicThreadedEnableFilter|TSLBasicThreadedEnableFilter]] ==		== From [[Class SLCommonFilter.TSLBasicThreadedEnableFilter|TSLBasicThreadedEnableFilter]] ==
Line 88:		Line 94:
	=== Published ===		=== Published ===
−	*[[Property SLCommonFilter.TSLBasicThreadedEnableFilter.Enabled|Enabled]] - Enables/Disables the filter.	+	*[[Property SLCommonFilter.TSLBasicThreadedEnableFilter.Enabled|Enabled]]
−		+
−	== Pins ==	+
−	*[[Pin SLCommonFilter.TSLBasicThreadedEnableFilter.EnablePin|EnablePin]] - The enable pin of the component.	+
	== From [[Class SLCommonFilter.TSLBasicThreadedFilter|TSLBasicThreadedFilter]] ==		== From [[Class SLCommonFilter.TSLBasicThreadedFilter|TSLBasicThreadedFilter]] ==
Line 98:		Line 101:
	=== Published ===		=== Published ===
−	*[[Property SLCommonFilter.TSLBasicThreadedFilter.Threading|Threading]] - Specifies the desired threading settings for the filtering.	+	*[[Property SLCommonFilter.TSLBasicThreadedFilter.Threading|Threading]]
	[[Category:Components]][[Category:Classes]]		[[Category:Components]][[Category:Classes]]

---

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: SignalLabBasicPkg

Unit: SLGenericFilter

Inherits: TSLBasicStartGenericFilter

Contents 1 Syntax 1.1 Delphi: 1.2 C++ Builder: 1.3 Visual C++ (MFC): 1.4 C# (.NET): 2 Summary 3 Description 4 Methods 4.1 Public 5 Events 6 From TSLBasicStartGenericFilter 7 Events 8 From TSLBasicGenericFilter 9 Properties 9.1 Published 10 Methods 10.1 Public 11 Events 12 From TSLCommonBinaryFilter 13 Pins 14 From TSLCommonFilter 15 Properties 15.1 Public 16 From TSLBasicThreadedEnableFilter 17 Properties 17.1 Published 18 From TSLBasicThreadedFilter 19 Properties 19.1 Published

Syntax

Delphi:

type TSLGenericFilter = class( TSLBasicStartGenericFilter )

C++ Builder:

class TSLGenericFilter : public TSLBasicStartGenericFilter

Visual C++ (MFC):

class CTSLGenericFilter : public CTSLBasicStartGenericFilter

C# (.NET):

public ref class GenericFilter : Mitov.SignalLab.BasicStartGenericFilter

Summary

User defined filter for Binary data.

Description

Implements a user defined filter over the Binary(block) buffer data.

Implement the user defined filter inside the OnProcessData event handler.

Diagram:

Methods

Public

• procedure SendData(OutBuffer : ISLBlockBuffer) - Sends data buffer trough the output pin.

Events

• OnProcessData - Occurs when a data buffer is received.

From TSLBasicStartGenericFilter

Events

• OnStart - Occurs when the data pumping starts.

From TSLBasicGenericFilter

Properties

Published

• SynchronizeType - Type of thread buffer synchronization.

Methods

Public

• procedure SendStartCommand(ARate : Real) - Sends start command trough the output pin.
• procedure SendStopCommand() - Sends stop command trough the output pin.
• procedure ClearQueue() - Clears the internal synchronization buffer queue.

Events

• OnStop - Occurs when the data pumping stops.

From TSLCommonBinaryFilter

Pins

• OutputPin
• InputPin

From TSLCommonFilter

Properties

Public

• SampleRate

From TSLBasicThreadedEnableFilter

Properties

Published

• Enabled

From TSLBasicThreadedFilter

Properties

Published

• Threading