David Alm: Automated Syncronization with Documentation

2013-06-26T00:29:24Z

Automated Syncronization with Documentation

← Older revision		Revision as of 00:29, 26 June 2013
Line 5:		Line 5:
	</span></b>		</span></b>

−	'''Package:''' [[Package ~~SignalLabBasicPkg~~\|~~SignalLabBasicPkg~~]]	+	'''Package:''' [[Package Mitov.BasicLab\|Mitov.BasicLab]]

	'''Unit:''' [[Unit SLSimpleDataBuffer\|SLSimpleDataBuffer]]		'''Unit:''' [[Unit SLSimpleDataBuffer\|SLSimpleDataBuffer]]
Line 26:		Line 26:
	=== C# (.NET): ===		=== C# (.NET): ===
	<code>		<code>
−	'''public ref class''' ~~TSLRealBuffer~~ : [[Class SLSimpleDataBuffer.TSLLinearMemoryBuffer\|Mitov.SignalLab.LinearMemoryBuffer]]	+	'''public ref class''' RealBuffer : [[Class SLSimpleDataBuffer.TSLLinearMemoryBuffer\|Mitov.SignalLab.LinearMemoryBuffer]]
	</code>		</code>
	== Summary ==		== Summary ==
Line 109:		Line 109:

	=== Public ===		=== Public ===
−	*[[Method ~~procedure~~ SLSimpleDataBuffer.TSLLinearMemoryBuffer.Resize(Cardinal;Boolean)\|~~procedure~~ Resize(Size : Cardinal; PreserveData : Boolean)]] - Resizes the buffer.	+	*[[Method function SLSimpleDataBuffer.TSLLinearMemoryBuffer.Resize(Cardinal;Boolean) : Boolean\|function Resize(Size : Cardinal; PreserveData : Boolean) : Boolean]] - Resizes the buffer.

	== From [[Class SLSimpleDataBuffer.TSLMemoryBuffer\|TSLMemoryBuffer]] ==		== From [[Class SLSimpleDataBuffer.TSLMemoryBuffer\|TSLMemoryBuffer]] ==

David Alm: Automated Syncronization with Documentation

2012-10-18T16:52:34Z

Automated Syncronization with Documentation

New page

<b><span style="color:red">
This is a Beta Read Only version of this page.
Please review and send recommendations to [mailto:mitov@mitov.com mitov@mitov.com].
We will enable the editing as soon as we are happy with the overall Wiki site.
</span></b>

'''Package:''' [[Package SignalLabBasicPkg|SignalLabBasicPkg]]

'''Unit:''' [[Unit SLSimpleDataBuffer|SLSimpleDataBuffer]]

'''Inherits:''' [[Class SLSimpleDataBuffer.TSLLinearMemoryBuffer|TSLLinearMemoryBuffer]]

== Syntax ==
=== Delphi: ===
<code>
'''type''' TSLRealBuffer = '''class'''( [[Class SLSimpleDataBuffer.TSLLinearMemoryBuffer|TSLLinearMemoryBuffer, ISLRealBuffer, ISLData]] )
</code>
=== C++ Builder: ===
<code>
'''class''' TSLRealBuffer : '''public''' [[Class SLSimpleDataBuffer.TSLLinearMemoryBuffer|TSLLinearMemoryBuffer]]
</code>
=== Visual C++ (MFC): ===
<code>
'''class''' CTSLRealBuffer : '''public''' [[Class SLSimpleDataBuffer.TSLLinearMemoryBuffer|CTSLLinearMemoryBuffer]]
</code>
=== C# (.NET): ===
<code>
'''public ref class''' TSLRealBuffer : [[Class SLSimpleDataBuffer.TSLLinearMemoryBuffer|Mitov.SignalLab.LinearMemoryBuffer]]
</code>
== Summary ==
Delphi Real data buffer.

== Description ==
This is Real(double) Data wrapper buffer. Use this buffer to
access and manipulate the Real(double) data from inside your
Delphi code. .NET, C++ Builder and Visual C++ users should
use the much more convenient and powerful TSLCRealBuffer
class.
Note
Delphi only.

== Properties ==

=== Public ===
*[[Property SLSimpleDataBuffer.TSLRealBuffer.Max|Max]]
*[[Property SLSimpleDataBuffer.TSLRealBuffer.Min|Min]]
*[[Property SLSimpleDataBuffer.TSLRealBuffer.Items|Items]]
*[[Property SLSimpleDataBuffer.TSLRealBuffer.pBuffer|pBuffer]]

== Methods ==

=== Public ===
*[[Method function SLSimpleDataBuffer.TSLRealBuffer.MakeCopy() : TInterfacedObject|function MakeCopy() : TInterfacedObject]] - Creates a copy from the buffer.
*[[Method function SLSimpleDataBuffer.TSLRealBuffer.IsEqual(ISLDataBuffer) : Boolean|function IsEqual(Other : ISLDataBuffer) : Boolean]]
*[[Method function SLSimpleDataBuffer.TSLRealBuffer.GetSize() : Cardinal|function GetSize() : Cardinal]]
*[[Method function SLSimpleDataBuffer.TSLRealBuffer.GetItem(Integer) : Real|function GetItem(Index : Integer) : Real]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.SetItem(Integer;Real)|procedure SetItem(Index : Integer; Value : Real)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.VectorJaehne(Real)|procedure VectorJaehne(AMagnitude : Real)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.Add(ISLRealBuffer)|procedure Add(Right : ISLRealBuffer)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.Subtract(ISLRealBuffer)|procedure Subtract(Right : ISLRealBuffer)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.Multiply(ISLRealBuffer)|procedure Multiply(Right : ISLRealBuffer)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.Divide(ISLRealBuffer)|procedure Divide(Right : ISLRealBuffer)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.SetValue(Real)|procedure SetValue(AValue : Real)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.AddValue(Real)|procedure AddValue(AValue : Real)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.SubtractValue(Real)|procedure SubtractValue(AValue : Real)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.MultiplyValue(Real)|procedure MultiplyValue(AValue : Real)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.DivideValue(Real)|procedure DivideValue(AValue : Real)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.Zero()|procedure Zero()]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.ToInt(PInteger;Boolean)|procedure ToInt(OutBuffer : PInteger; ARound : Boolean)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.ToShort(PSmallInt;Boolean)|procedure ToShort(OutBuffer : PSmallInt; ARound : Boolean)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.ToSingle(PSingle)|procedure ToSingle(OutBuffer : PSingle)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.FromInt(PInteger)|procedure FromInt(InBuffer : PInteger)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.FromShort(PSmallInt)|procedure FromShort(InBuffer : PSmallInt)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.FromSingle(PSingle)|procedure FromSingle(InBuffer : PSingle)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.NormalizeFrom(ISLRealBuffer;Real;Real)|procedure NormalizeFrom(Src : ISLRealBuffer; Offset : Real; Factor : Real)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.Normalize(Real;Real)|procedure Normalize(Offset : Real; Factor : Real)]]
*[[Method function SLSimpleDataBuffer.TSLRealBuffer.Dot(ISLRealBuffer) : Real|function Dot(Right : ISLRealBuffer) : Real]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.Threshold(Real;TSLThresholdType)|procedure Threshold(AThreshold : Real; AType : TSLThresholdType)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.ThresholdFrom(ISLRealBuffer;Real;TSLThresholdType)|procedure ThresholdFrom(Src : ISLRealBuffer; AThreshold : Real; AType : TSLThresholdType)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.Sqr()|procedure Sqr()]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.SqrFrom(ISLRealBuffer)|procedure SqrFrom(Src : ISLRealBuffer)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.Sqrt()|procedure Sqrt()]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.SqrtFrom(ISLRealBuffer)|procedure SqrtFrom(Src : ISLRealBuffer)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.AutoCorr(ISLRealBuffer;TSLAutoCorrType)|procedure AutoCorr(Src : ISLRealBuffer; AType : TSLAutoCorrType)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.CrossCorr(ISLRealBuffer;ISLRealBuffer;Integer)|procedure CrossCorr(Src1 : ISLRealBuffer; Src2 : ISLRealBuffer; LoLag : Integer)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.Abs()|procedure Abs()]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.AbsFrom(ISLRealBuffer)|procedure AbsFrom(Src : ISLRealBuffer)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.Exp()|procedure Exp()]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.ExpFrom(ISLRealBuffer)|procedure ExpFrom(Src : ISLRealBuffer)]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.Ln()|procedure Ln()]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.LnFrom(ISLRealBuffer)|procedure LnFrom(Src : ISLRealBuffer)]]
*[[Method function SLSimpleDataBuffer.TSLRealBuffer.Mean() : Real|function Mean() : Real]]
*[[Method function SLSimpleDataBuffer.TSLRealBuffer.StdDev() : Real|function StdDev() : Real]]
*[[Method procedure SLSimpleDataBuffer.TSLRealBuffer.Convolve(ISLRealBuffer;ISLRealBuffer)|procedure Convolve(Src : ISLRealBuffer; H : ISLRealBuffer)]]
*[[Method function SLSimpleDataBuffer.TSLRealBuffer.Norm(ISLRealBuffer;TSLNormType) : Real|function Norm(Src : ISLRealBuffer; AType : TSLNormType) : Real]]
*[[Method function SLSimpleDataBuffer.TSLRealBuffer.GetMinValue() : Real|function GetMinValue() : Real]]
*[[Method function SLSimpleDataBuffer.TSLRealBuffer.GetMaxValue() : Real|function GetMaxValue() : Real]]
*[[Method function SLSimpleDataBuffer.TSLRealBuffer.GetMinIndex(Integer) : Real|function GetMinIndex(var AIndex : Integer) : Real]]
*[[Method function SLSimpleDataBuffer.TSLRealBuffer.GetMaxIndex(Integer) : Real|function GetMaxIndex(var AIndex : Integer) : Real]]
*[[Method function SLSimpleDataBuffer.TSLRealBuffer.GetMin(Integer;Integer) : Real|function GetMin(IndexBegin : Integer; IndexEnd : Integer) : Real]]
*[[Method function SLSimpleDataBuffer.TSLRealBuffer.GetMax(Integer;Integer) : Real|function GetMax(IndexBegin : Integer; IndexEnd : Integer) : Real]]
*[[Method function SLSimpleDataBuffer.TSLRealBuffer.GetMinRestricted(Integer;Integer) : Real|function GetMinRestricted(IndexBegin : Integer; IndexEnd : Integer) : Real]]
*[[Method function SLSimpleDataBuffer.TSLRealBuffer.GetMaxRestricted(Integer;Integer) : Real|function GetMaxRestricted(IndexBegin : Integer; IndexEnd : Integer) : Real]]
*[[Method function SLSimpleDataBuffer.TSLRealBuffer.IsEqualToValue(Real) : Boolean|function IsEqualToValue(AValue : Real) : Boolean]]

== From [[Class SLSimpleDataBuffer.TSLLinearMemoryBuffer|TSLLinearMemoryBuffer]] ==

== Methods ==

=== Public ===
*[[Method procedure SLSimpleDataBuffer.TSLLinearMemoryBuffer.Resize(Cardinal;Boolean)|procedure Resize(Size : Cardinal; PreserveData : Boolean)]] - Resizes the buffer.

== From [[Class SLSimpleDataBuffer.TSLMemoryBuffer|TSLMemoryBuffer]] ==

== Properties ==

=== Public ===
*[[Property SLSimpleDataBuffer.TSLMemoryBuffer.MemoryBuffer|MemoryBuffer]]

== Methods ==

=== Public ===
*[[Method function SLSimpleDataBuffer.TSLMemoryBuffer.MakeCopy() : TInterfacedObject|function MakeCopy() : TInterfacedObject]]
*[[Method function SLSimpleDataBuffer.TSLMemoryBuffer.ByteRead() : PByte|function ByteRead() : PByte]]
*[[Method function SLSimpleDataBuffer.TSLMemoryBuffer.ByteWrite() : PByte|function ByteWrite() : PByte]]
*[[Method function SLSimpleDataBuffer.TSLMemoryBuffer.ByteModify() : PByte|function ByteModify() : PByte]]
*[[Method function SLSimpleDataBuffer.TSLMemoryBuffer.GetByteSize() : Cardinal|function GetByteSize() : Cardinal]] - Call this method to get the buffer size in bytes.
*[[Method function SLSimpleDataBuffer.TSLMemoryBuffer.GetCharSize() : Cardinal|function GetCharSize() : Cardinal]] - Call this method to get the buffer size in characters.
*[[Method function SLSimpleDataBuffer.TSLMemoryBuffer.GetSize() : Cardinal|function GetSize() : Cardinal]] - Call this method to get the buffer size in bytes.

== From [[Class SLSimpleDataBuffer.TSLGenericBuffer|TSLGenericBuffer]] ==

== Methods ==

=== Public ===
*[[Method function SLSimpleDataBuffer.TSLGenericBuffer.MakeCopy() : TInterfacedObject|function MakeCopy() : TInterfacedObject]] - Creates a copy from the buffer.
*[[Method procedure SLSimpleDataBuffer.TSLGenericBuffer.SaveToFile(String)|procedure SaveToFile(AFileName : String)]]
*[[Method procedure SLSimpleDataBuffer.TSLGenericBuffer.LoadFromFile(String)|procedure LoadFromFile(AFileName : String)]]
*[[Method function SLSimpleDataBuffer.TSLGenericBuffer.IsEqual(ISLDataBuffer) : Boolean|function IsEqual(Other : ISLDataBuffer) : Boolean]]
*[[Method procedure SLSimpleDataBuffer.TSLGenericBuffer.Unique(Boolean)|procedure Unique(PreserveData : Boolean)]]
*[[Method function SLSimpleDataBuffer.TSLGenericBuffer.MakeUnique(Boolean) : Boolean|function MakeUnique(PreserveData : Boolean) : Boolean]]
*[[Method function SLSimpleDataBuffer.TSLGenericBuffer.GetByteSize() : Cardinal|function GetByteSize() : Cardinal]] - Returns the size of the buffer in bytes.
*[[Method function SLSimpleDataBuffer.TSLGenericBuffer.GetSize() : Cardinal|function GetSize() : Cardinal]] - Returns the size of the buffer in elements.
*[[Method function SLSimpleDataBuffer.TSLGenericBuffer.ByteRead() : PByte|function ByteRead() : PByte]]
*[[Method function SLSimpleDataBuffer.TSLGenericBuffer.ByteWrite() : PByte|function ByteWrite() : PByte]]
*[[Method function SLSimpleDataBuffer.TSLGenericBuffer.ByteModify() : PByte|function ByteModify() : PByte]]
*[[Method procedure SLSimpleDataBuffer.TSLGenericBuffer.RemoveOwnerShip()|procedure RemoveOwnerShip()]]
*[[Method function SLSimpleDataBuffer.TSLGenericBuffer.OwnsData() : Boolean|function OwnsData() : Boolean]]
*[[Method function SLSimpleDataBuffer.TSLGenericBuffer.GetDataBufferIntf() : ISLDataBuffer|function GetDataBufferIntf() : ISLDataBuffer]]

== From [[Class SLSimpleDataBuffer.TSLData|TSLData]] ==

== Methods ==

=== Public ===
*[[Method procedure SLSimpleDataBuffer.TSLData.AssignData(ISLData)|procedure AssignData(AOther : ISLData)]]
*[[Method function SLSimpleDataBuffer.TSLData.GetInstance() : TObject|function GetInstance() : TObject]]
*[[Method function SLSimpleDataBuffer.TSLData.MakeCopy() : TInterfacedObject|function MakeCopy() : TInterfacedObject]]
*[[Method function SLSimpleDataBuffer.TSLData.MakeIntfCopy() : ISLData|function MakeIntfCopy() : ISLData]]
*[[Method function SLSimpleDataBuffer.TSLData.GetDataIntf() : ISLData|function GetDataIntf() : ISLData]]
*[[Method procedure SLSimpleDataBuffer.TSLData.AddCustom(ISLData)|procedure AddCustom(AData : ISLData)]]
*[[Method function SLSimpleDataBuffer.TSLData.GetCustomCount() : Integer|function GetCustomCount() : Integer]]
*[[Method function SLSimpleDataBuffer.TSLData.GetCustom(Integer) : ISLData|function GetCustom(AIndex : Integer) : ISLData]]

[[Category:Classes]]

Class SLSimpleDataBuffer.TSLRealBuffer - Revision history

David Alm: Automated Syncronization with Documentation

David Alm: Automated Syncronization with Documentation