Method: AddWaveformProperties for DirectAccessChannel
- Updated2024-09-12
- 1 minute(s) read
DataPlugin > Methods > Method: AddWaveformProperties for DirectAccessChannel
Method: AddWaveformProperties for DirectAccessChannel
Adds waveform properties to the DirectAccess channel to generate a waveform channel.
Waveform channels contain the x-part and the y-part of a curve in a channel. The y-part contains the (measurement) values. The x-part might be the measured time. The Waveform properties specify the x-part that is a linear specification with a start value and a step width.
Object.AddWaveformProperties(Increment, StartOffset, [XChannelName], [XChannelUnit], [StartTime], [TimePreference], [NumberOfSamples])
| Object | DirectAccessChannel Object with this method | ||||||
| Increment | Double Specifies the step width of the x-part of the waveform channel. | ||||||
| StartOffset | Double Specifies the offset of the x-part of the waveform channel. | ||||||
| [XChannelName] | String Specifies the name of the x-part of the waveform channel. The default channel name is Time. | ||||||
| [XChannelUnit] | String Specifies the unit of the x-part of the waveform channel. | ||||||
| [StartTime] | UsiTimeDisp Specifies the start time of the x-part of the waveform channel. | ||||||
| [TimePreference] | Enumeration with the following selection terms:
| ||||||
| [NumberOfSamples] | LongInteger Specifies the block size of the values of the waveform channel. The default value is 1. |
The following example generates the channel MyChannel with waveform properties in the Measurements channel group.
Dim oBlock: Set oBlock = File.GetBinaryBlock() Dim oChn : Set oChn = oBlock.Channels.Add("MyChannel",eR64) Call oChn.AddWaveformProperties(1, 0, "Time", "s") Dim oMyGrp: Set oMyGrp = Root.ChannelGroups.Add("Measurements") Call oMyGrp.Channels.AddDirectAccessChannel(oChn)