type TSignalWrite = class(TFileStorage);
Writes a signal to a file.
Use TSignalWrite to write wav, binary and text files and provide streaming capabilities.
The data to be written is connected to the Input property. If you would like to save data in the Data property, connect the component to itself.
Properties
| Name | Type | Description |
|---|---|---|
| Active | Boolean | Set active to false to suppress the propagation of the Pull request and the subsequent call to the Update method. |
| AppendFile | Boolean | If True, the SaveFile method will set the file cursor at the end of the file. |
| AuthorInfo | string | Holds the string added to the header of the saved wav file. |
| AutoFileFormat | Boolean | If True, the file format will be automatically determined from the file name extension. |
| BandWidth | Double | Return the bandwidth of the signal. |
| BandwidthH | Double | Returns the upper bandwidth edge of the signal. |
| BandwidthL | Double | Returns the lower bandwidth edge of the signal. |
| BlockAssign | Boolean | Block streaming of specific properties when storing only a "template". |
| ChannelCount | Integer | Get or set the number of channels multiplexed in the data property. |
| Complex | Boolean | Set this property to true, to request computation using complex numbers. |
| Continuous | Boolean | If True, the component will pass on the udpate request to the connected component. |
| Data | TVec | Stores the result of the processing. |
| Dt | Double | Time between two consecutive samples. |
| EditorActive | Boolean | Returns True, if the component editor is displayed. |
| FileFormat | TFileFormat | Defines the format of the file, if AutoFileFormat property is False. |
| FileName | string | Defines the file name to be read from or written to. |
| FloatPrecision | TMtxFloatPrecision | Set this property to request computation in 32bit/64bit precision with real/complex numbers. |
| FloatPrecisionLock | Boolean | Set this property to true to lock changes to FloatPrecision property. |
| HzRes | Double | Frequency resolution obtained, if an FFT algorithm would be run on the data. |
| ImFormat | string | Number format definition for text file formats. |
| Input | TSignal | Source data to be written to the file. |
| IsDouble | Boolean | Set this property to false, to request computation in 32bit floating point precision, 64bit, if true. |
| Item | Double | Default property to access values of a real signal. |
| ItemNumber | Integer | Number to label the object when it is an item in the List. |
| Length | Integer | Get or set the length of the signal in samples. |
| Marks | TMarkList | Stores the time stamps and amplitude of selected samples. |
| MaxAmplt | Double | Stores the maximum amplitude of the signal found by the MinMax method. |
| MaxX | Double | Use the MaxX property to store the time stamp (in seconds) of the right most sample. |
| MinAmplt | Double | Stores the minimum amplitude of the signal found by the MinMax method. |
| MinX | Double | Use the MinX property to store the time stamp of the left-most sample. |
| OnAfterUpdate | TNotifyEvent | The event is triggered after the call to the Update method. |
| OnBeforeUpdate | TNotifyEvent | The event is triggered just before the call to the Update method. |
| OnDisplayUpdate | TNotifyEvent | The event is triggered after the OnAfterUpdate event. Use this event to update any associated charts or graphs or result tables. |
| OnGetInput | TNotifyEvent | If the Input property is not assigned, the component will call OnGetInput. |
| OnNotifyUpdate | TNotifyEvent | The event is called after a call to InternalUpdate, OnAfterUpdate and OnDisplayUpdate from within the Update method. |
| OnParameterUpdate | TNotifyEvent | 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". |
| PipeState | TPipeState | Returns the state of the pipe after the last update. |
| Precision | TPrecision | Defines the precision with which the Data will be saved. |
| RecordLength | Int64 | Read only. Returns the length in samples of the Data written so far in the current record per channel. |
| RecordNumber | Integer | Move the file position cursor to the beginging of the record number RecordNumber. |
| RecordTime | Double | Read only. Returns the length in seconds of the Data written so far in the current record per channel. |
| Reference | TReferenceList | Stores a list of components that have to be notified, when this component is destroyed. |
| ReFormat | string | Number format definition for text file formats. |
| Rounding | TRounding | Define the rounding mode when saving to integer types. |
| SamplingFrequency | Double | Defines the sampling frequency of the signal. |
| SamplingTime | Double | The length of the signal in seconds. |
| SuspendNotifyUpdate | Boolean | Set this property to True, to prevent calling OnNotifyUpdate from the Update Method. |
| TotalRecordLength | Int64 | Returns the sample count written for all channels. |
| UsesInputs | Boolean | Set it to True to indicate, that valid signals will be connected to the Input or Inputs properties. |
Methods
| Name | Description |
|---|---|
| AllowStreaming | Returns the negatated value of BlockAssign. |
| Append | Appends Sample to the end of the signal. |
| AppendRecord | Appends a new record to the file with Filename. |
| Assign | Assign values of all published properties from Source. |
| AssignTemplate | Assign values of "template-like" published properties from Source. |
| BytesWritten | Returns the amount of data written so far in bytes. |
| CloseFile | Close the file with FileName. |
| CloseRecord | Call the CloseRecord once the record has been written. |
| Copy | Copies signal Data and sampling frequency information. |
| Crest | Compute the CREST parameter. |
| EditorClass | To be overriden in descendanr classses. |
| FileIsOpen | Returns true, if the file is open. |
| InitRecord | Initialize a new record. |
| 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. |
| LoadFromStream | Load the component from Src stream. |
| LoadTemplateFromFile | Load a template from file. |
| LoadTemplateFromStream | Load a template from stream. |
| MarksToStrings | Convert marks to strings. |
| MinMax | Find minimum and maximum amplitude and store the result in the MinAmplt and MaxAmplt properties. |
| 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. |
| Pull | Request recalculation of the entire chain of all connected components. |
| PullUntilEnd | Calls Pull until pipeEnd is returned. |
| Reset | Reset is called after loading the data from stream or file. |
| SaveBlock | Save Data to the current record and advance the file position. |
| SaveDataToFile | Saves the data connected to the input property to the file with FileName. |
| SaveFile | Prepare the file with FileName for writing. |
| SaveHeaderFile | Saves a header file describing file contents. |
| SaveRecord | Save Data as a single record to the file. |
| SaveTemplateToFile | Save template to file. |
| SaveTemplateToStream | Save template to stream. |
| SaveToStream | Save the component to Dst stream. |
| Size | Assign the size of the signal from Src. |
| 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. |