TSignalRead Members

The following tables list the members exposed by TSignalRead.

	Name	Description
	OnAfterUpdateEvent	The event is triggered after the call to the Update method.
	OnBeforeUpdateEvent	The event is triggered just before the call to the Update method.
	OnDisplayUpdateEvent	The event is triggered after the OnAfterUpdate event. Use this event to update any associated charts or graphs or result tables.
	OnGetInputEvent	If the Input property is not assigned, the component will call OnGetInput.
	OnNotifyUpdateEvent	The event is called after a call to InternalUpdate, OnAfterUpdate and OnDisplayUpdate from within the Update method.
	OnParameterUpdateEvent	The event is triggered when ParamUpdate method is called. The ParamUpdate method is usually called by component editors when a value was changed by the user and the editor was "Live".
	OnProcessAllEvent	Event triggered when Process command is selected from the drop-down menu in the component editor.
	OnRecordPositionChangeEvent	Triggered after RecordPosition changes.

Public Methods

	Name	Description
	AllowStreaming	This is AllowStreaming, a member of class TSignal.
	Append	Appends Sample to the end of the signal.
	Assign	This is Assign, a member of class TAnalysis.
	CloseFile	Close file.
	Copy	Copies signal Data and sampling frequency information.
	Crest	Compute the CREST parameter.
	Destroy	This is Destroy, a member of class TSignalRead.
	DetectChannelCount	This is DetectChannelCount, a member of class TSignalRead.
	EditorClass	This is EditorClass, a member of class TSignalRead.
	FileIsOpen	Returns true, if the file is open.
	FileSize	Returns the size of the file in bytes.
	FirstFrame	Sets the record position to the start of the current record and reads the data.
	FormatDescription	Returns the description of the file format.
	FormatTagDescription	Returns the name of the file format.
	InputsDirty	If all Inputs[i] are dirty the function returns true.
	InternalPull	When called, the method will pass Update requests recursively to all connected objects.
	Invalidate	Notifies all connected components that this component has fresh data.
	IsEndOfFile	Returns true, if the current frame is the last frame.
	LastFrame	Sets the record position to the start of the last frame of the current record and reads the data.
	LoadHeaderFile	Reads the header file for raw file formats.
	MarksToStrings	Convert marks to strings.
	MinMax	Find minimum and maximum amplitude and store the result in the MinAmplt and MaxAmplt properties.
	NextFrame	Advances the record position forward in the current record and reads the data.
	OpenFile	Open file.
	ParamUpdate	The method can be assigned to some other component even handler, as a notification that a parameter has changed and that Self should consider a recalculation.
	Peak	Find the maximum deviation of the signal from its mean value.
	PipeReset	Recursively processes all connected components backward and calls Reset method.
	PrevFrame	Moves the record position backward in the current record and reads the data.
	Pull	Request recalculation of the entire chain of all connected components.
	PullUntilEnd	Calls Pull until pipeEnd is returned.
	RawFileFormat	Checks if the file format is raw.
	Reset	This is Reset, a member of class TAnalysis.
	SamplesLeft	Returnes the number of samples left to the end of the file per channel.
	SaveHeaderFile	Saves a header file describing file contents.
	Size	Assign the size of the signal from Src.
	this	Default property to access values of a real signal.
	TSignal	This is the overview for the TSignal constructor overload.
	TSignalRead	This is the overview for the TSignalRead constructor overload.
	Update	Request recalculation of the data and place the result in Self.
	UpdateNotify	Call this method only, if SuspendNotifyUpdate is True.
	ValuesToStrings	Convert values to strings.

Public Properties

	Name	Description
	Active	Set active to false to suppress the propagation of the Pull request and the subsequent call to the Update method.
	AutoFileFormat	If True, the file format will be automatically determined from the file name extension.
	Bandwidth	Return the bandwidth of the signal.
	BandwidthH	Returns the upper bandwidth edge of the signal.
	BandwidthL	Returns the lower bandwidth edge of the signal.
	ChannelCount	Get or set the number of channels multiplexed in the data property.
	Complex	Set this property to true, to request computation using complex numbers.
	Continuous	If True, the component will pass on the udpate request to the connected component.
	Data	Stores the result of the processing.
	Dt	Time between two consecutive samples.
	FileFormat	Defines the format of the file, if AutoFileFormat property is False.
	FileName	Defines the file name to be read from or written to.
	FloatPrecision	Set this property to request computation in 32bit/64bit precision with real/complex numbers.
	FloatPrecisionLock	Set this property to true to lock changes to FloatPrecision property.
	ForceLength	Warn about compressed files varying Length read.
	FrameNumber	Set FrameNumber to position the read cursor within the current record.
	FramesPerSecond	Returns the number of frames per second according to Framing and overlapp properties.
	Framing	Defines the method to traverse a multi-record the file.
	HzRes	Frequency resolution obtained, if an FFT algorithm would be run on the data.
	Input	Connector property to obtain a pointer to the TSignal component holding the data to be processed.
	Input	Connector property to obtain a pointer to the TSignal component holding the data to be processed.
	IsDouble	Set this property to false, to request computation in 32bit floating point precision, 64bit, if true.
	ItemNumber	Number to label the object when it is an item in the List.
	LastFrameCheck	Specifies how to handle the end of file.
	Length	Get or set the length of the signal in samples.
	Loop	If true, looping will be enabled.
	Marks	Stores the time stamps and amplitude of selected samples.
	MaxAmplt	Stores the maximum amplitude of the signal found by the MinMax method.
	MaxFrames	Read Only. Determine the maximum number of frames.
	MaxX	Use the MaxX property to store the time stamp (in seconds) of the right most sample.
	MinAmplt	Stores the minimum amplitude of the signal found by the MinMax method.
	MinX	Use the MinX property to store the time stamp of the left-most sample.
	NumberOfRecords	Read only. Returns the number of records contained in the current file.
	OnAfterUpdate	The event is triggered after the call to the Update method.
	OnBeforeUpdate	The event is triggered just before the call to the Update method.
	OnDisplayUpdate	The event is triggered after the OnAfterUpdate event. Use this event to update any associated charts or graphs or result tables.
	OnGetInput	If the Input property is not assigned, the component will call OnGetInput.
	OnNotifyUpdate	The event is called after a call to InternalUpdate, OnAfterUpdate and OnDisplayUpdate from within the Update method.
	OnParameterUpdate	The event is triggered when ParamUpdate method is called. The ParamUpdate method is usually called by component editors when a value was changed by the user and the editor was "Live".
	OnProcessAll	Event triggered when Process command is selected from the drop-down menu in the component editor.
	OnRecordPositionChange	Triggered after RecordPosition changes.
	OverlappingPercent	Define the overlapping in percent of consequtive frames when reading the file.
	OverlappingSamples	Define the overlapping in sampels of consequtive frames when reading the file.
	PipeState	Returns the state of the pipe after the last update.
	PostBufferSamples	Append zeros to then end of file.
	PostBufferTime	Append zeros to end of file.
	Precision	Read the precision of the data being read from the file.
	RecordLength	Read only. Returns the length of the current record in samples for one channel.
	RecordNumber	Set RecordNumber to move the read cursor within the file to the record with RecordNumber number.
	RecordPosition	Set and get position in samples.
	RecordTime	Read only. Returns the length of the current record in seconds for one channel.
	RecordTimePosition	Set RecordTimePosition in seconds to position the read cursor within the current record.
	SamplingFrequency	Defines the sampling frequency of the signal.
	SamplingTime	The length of the signal in seconds.
	ScaleFactor	Defines a scale factor to be applied to just read data.
	SelectionStart	Specifies the lower file range limit.
	SelectionStop	Specifies the upper file range limit.
	SuspendNotifyUpdate	Set this property to True, to prevent calling OnNotifyUpdate from the Update Method.
	UsesInputs	Set it to True to indicate, that valid signals will be connected to the Input or Inputs properties.

Links

TSignalRead Class, Legend, Public Events, Public Methods, Public Properties

Contents | Index | Home

What do you think about this topic? Send feedback!