Method: AddWaveformProperties for ImplicitChannel
- Updated2024-09-12
- 2 minute(s) read
DataPlugin > Methods > Method: AddWaveformProperties for ImplicitChannel
Method: AddWaveformProperties for ImplicitChannel
Adds waveform properties to the implicit 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 | ImplicitChannel 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 reads in the generation instruction of an implicit channel and generates this channel within the channel group MyChnGroup. The example then adds waveform properties to this channel.
Dim ChannelName: ChannelName = File.GetNextStringValue(eString) Dim StartValue : StartValue = File.GetNextStringValue(eString) Dim Increment : Increment = File.GetNextStringValue(eString) Dim ChannelSize: ChannelSize = File.GetNextStringValue(eString) Dim ChannelGroup : Set ChannelGroup = Root.ChannelGroupsAdd("MyChnGroup") Dim MyChn : Set MyChn = ChannelGroup.Channels.AddImplicitChannel(ChannelName, StartValue, Increment, ChannelSize, eI32) Call MyChn.AddWaveformProperties(1, 0, "Time", "s")