Class SLGenericRealGen.TSLGenericRealGen

Revision as of 19:26, 29 November 2011 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation)		Latest revision as of 00:30, 26 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation)
(8 intermediate revisions by one user not shown)
Line 28:		Line 28:
	=== C# (.NET): ===		=== C# (.NET): ===
	<code>		<code>
−	'''public ref class''' TSLGenericRealGen : [[Class SLCommonGen.TSLCommonRealGen|Mitov.SignalLab.CommonRealGen]]	+	'''public ref class''' GenericRealGen : [[Class SLCommonGen.TSLCommonRealGen|Mitov.SignalLab.CommonRealGen]]
	</code>		</code>
	== Summary ==		== Summary ==
Line 39:		Line 39:
	Implement the user defined generator inside the [[Event SLGenericRealGen.TSLGenericRealGen.OnGenerate|OnGenerate]]		Implement the user defined generator inside the [[Event SLGenericRealGen.TSLGenericRealGen.OnGenerate|OnGenerate]]
	event handler.		event handler.
		+
		+
		+
		+	<b>Diagram:</b>
		+
		+	[[Image:SLGenericRealGen_Preview.png]]
	== Events ==		== Events ==
Line 46:		Line 52:
	== Pins ==		== Pins ==
−	*[[Pin SLCommonGen.TSLCommonRealGen.OutputPin|OutputPin]] - The Real(double) output pin of the generator.	+	*[[Pin SLCommonGen.TSLCommonRealGen.OutputPin|OutputPin]]
	== From [[Class SLCommonGen.TSLCommonBufferGen|TSLCommonBufferGen]] ==		== From [[Class SLCommonGen.TSLCommonBufferGen|TSLCommonBufferGen]] ==
Line 53:		Line 59:
	=== Published ===		=== Published ===
−	*[[Property SLCommonGen.TSLCommonBufferGen.BufferSize|BufferSize]] - Specifies the desired buffer size for the generator.	+	*[[Property SLCommonGen.TSLCommonBufferGen.BufferSize|BufferSize]]
	== Events ==		== Events ==
−	*[[Event SLCommonGen.TSLCommonBufferGen.OnStart|OnStart]] - Occurs when the data pumping starts.	+	*[[Event SLCommonGen.TSLCommonBufferGen.OnStart|OnStart]]
	== From [[Class SLCommonGen.TSLCommonGen|TSLCommonGen]] ==		== From [[Class SLCommonGen.TSLCommonGen|TSLCommonGen]] ==
Line 63:		Line 69:
	=== Published ===		=== Published ===
−	*[[Property SLCommonGen.TSLCommonGen.SampleRate|SampleRate]] - Specifies the sample rate for the generator.	+	*[[Property SLCommonGen.TSLCommonGen.SampleRate|SampleRate]]
	== From [[Class SLCommonGen.TSLBasicCommonGen|TSLBasicCommonGen]] ==		== From [[Class SLCommonGen.TSLBasicCommonGen|TSLBasicCommonGen]] ==
Line 70:		Line 76:
	=== Published ===		=== Published ===
−	*[[Property SLCommonGen.TSLBasicCommonGen.Enabled|Enabled]] - Enables/Disables the generator.	+	*[[Property SLCommonGen.TSLBasicCommonGen.Enabled|Enabled]]
−	*[[Property SLCommonGen.TSLBasicCommonGen.PumpPriority|PumpPriority]] - Specifies the priority of the component as a pump.	+	*[[Property SLCommonGen.TSLBasicCommonGen.PumpPriority|PumpPriority]]
−	*[[Property SLCommonGen.TSLBasicCommonGen.ClockSource|ClockSource]] - Specifies the clock source - internal or external.	+	*[[Property SLCommonGen.TSLBasicCommonGen.ClockSource|ClockSource]]
	== Methods ==		== Methods ==
	=== Public ===		=== Public ===
−	*[[Method procedure SLCommonGen.TSLBasicCommonGen.Pump()|procedure Pump()]] - Generates one buffer if enabled and [[Property SLCommonGen.TSLBasicCommonGen.ClockSource|ClockSource]] is [[Enum item LPComponent.TSLClockSource.csExternal|csExternal]].	+	*[[Method procedure SLCommonGen.TSLBasicCommonGen.Pump()|procedure Pump()]]
−	*[[Method procedure SLCommonGen.TSLBasicCommonGen.Start()|procedure Start()]] - Starts the generator.	+	*[[Method procedure SLCommonGen.TSLBasicCommonGen.Start()|procedure Start()]]
−	*[[Method procedure SLCommonGen.TSLBasicCommonGen.Stop()|procedure Stop()]] - Stops the generator.	+	*[[Method procedure SLCommonGen.TSLBasicCommonGen.Stop()|procedure Stop()]]
	== Pins ==		== Pins ==
−	*[[Pin SLCommonGen.TSLBasicCommonGen.EnablePin|EnablePin]] - The enable pin of the generator.	+	*[[Pin SLCommonGen.TSLBasicCommonGen.ClockPin|ClockPin]]
−	*[[Pin SLCommonGen.TSLBasicCommonGen.ClockPin|ClockPin]] - The Clock Input Pin of the component.	+
	== Events ==		== Events ==
−	*[[Event SLCommonGen.TSLBasicCommonGen.OnStop|OnStop]] - Occurs when the data pumping stops.	+	*[[Event SLCommonGen.TSLBasicCommonGen.OnStop|OnStop]]
	[[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: SLGenericRealGen

Inherits: TSLCommonRealGen

Contents 1 Syntax 1.1 Delphi: 1.2 C++ Builder: 1.3 Visual C++ (MFC): 1.4 C# (.NET): 2 Summary 3 Description 4 Events 5 From TSLCommonRealGen 6 Pins 7 From TSLCommonBufferGen 8 Properties 8.1 Published 9 Events 10 From TSLCommonGen 11 Properties 11.1 Published 12 From TSLBasicCommonGen 13 Properties 13.1 Published 14 Methods 14.1 Public 15 Pins 16 Events

Syntax

Delphi:

type TSLGenericRealGen = class( TSLCommonRealGen )

C++ Builder:

class TSLGenericRealGen : public TSLCommonRealGen

Visual C++ (MFC):

class CTSLGenericRealGen : public CTSLCommonRealGen

C# (.NET):

public ref class GenericRealGen : Mitov.SignalLab.CommonRealGen

Summary

User defined generator for Real data.

Description

Allows implementation of custom user defined Real(double) data signal generators.

Implement the user defined generator inside the OnGenerate event handler.

Diagram:

Events

• OnGenerate - Occurs when a new buffer of data is generated.

From TSLCommonRealGen

Pins

• OutputPin

From TSLCommonBufferGen

Properties

Published

• BufferSize

Events

• OnStart

From TSLCommonGen

Properties

Published

• SampleRate

From TSLBasicCommonGen

Properties

Published

• Enabled
• PumpPriority
• ClockSource

Methods

Public

• procedure Pump()
• procedure Start()
• procedure Stop()

Pins

• ClockPin

Events

• OnStop