Wave:API - Revision history

Froehlich: link to API docs

2022-11-07T17:42:42Z

link to API docs

@@ Line 1: / Line 1: @@
 {{wave_nav}}
-The Wave API provides a few methods for reading time series from files, manipulating and displaying them.
+The BlueM.Wave API provides methods for reading time series from files, manipulating and displaying them.
 [[Category:BlueM.Wave]]

Froehlich: update examples to Wave v1.140.0

2022-10-03T18:47:00Z

update examples to Wave v1.140.0

← Older revision		Revision as of 11:47, 3 October 2022
Line 19:		Line 19:
	'More complex example showcasing some more advanced techniques		'More complex example showcasing some more advanced techniques
	Dim Wave1 As New BlueM.Wave.Wave()		Dim Wave1 As New BlueM.Wave.Wave()
	Dim myFile As BlueM.Wave.FileFormatBase		Dim myFile As BlueM.Wave.FileFormats.FileFormatBase
	Dim ts As BlueM.Wave.TimeSeries		Dim ts As BlueM.Wave.TimeSeries

	'read a file		'read a file
	myFile = BlueM.Wave.FileFactory.getFileInstance("path\to\file")		myFile = BlueM.Wave.FileFormats.FileFactory.getFileInstance("path\to\file")
	'check the available time series		'check the available time series
	For Each sInfo As BlueM.Wave.FileFormatBase.SeriesInfo In myFile.SeriesList		For Each sInfo As BlueM.Wave.FileFormats.FileFormatBase.SeriesInfo In myFile.SeriesList
	Console.WriteLine(sInfo.Name)		Console.WriteLine(sInfo.Name)
	Next		Next
Line 82:		Line 82:
	'import time series from a CSV file with custom import settings		'import time series from a CSV file with custom import settings
	Dim file As String = "path\to\file.csv"		Dim file As String = "path\to\file.csv"
	Dim csv As New BlueM.Wave.CSV(file)		Dim csv As New BlueM.Wave.FileFormats.CSV(file)

	'set import settings		'set import settings
Line 97:		Line 97:

	Console.WriteLine(String.Format("File contains {0} time series:", csv.FileTimeSeries.Count))		Console.WriteLine(String.Format("File contains {0} time series:", csv.FileTimeSeries.Count))
	For Each sInfo As BlueM.Wave.FileFormatBase.SeriesInfo In csv.SeriesList		For Each sInfo As BlueM.Wave.FileFormats.FileFormatBase.SeriesInfo In csv.SeriesList
	Console.WriteLine(sInfo.Name)		Console.WriteLine(sInfo.Name)
	Next		Next

Froehlich: added example4

2021-09-09T09:04:56Z

added example4

@@ Line 75: / Line 75: @@
 'Display the series in Wave
 Wave1.Import_Series(ts)
 Wave1.Show()
 </source>

Froehlich: /* Example2 */

2020-06-11T12:44:27Z

Example2

← Older revision		Revision as of 05:44, 11 June 2020
Line 23:		Line 23:

	'read a file		'read a file
	myFile = BlueM.Wave.FileFactory.getFileInstance(~~Me.FileName~~)		myFile = BlueM.Wave.FileFactory.getFileInstance("path\to\file")
	'check the available time series		'check the available time series
	For Each c As BlueM.Wave.FileFormatBase.SeriesInfo In myFile.SeriesList		For Each sInfo As BlueM.Wave.FileFormatBase.SeriesInfo In myFile.SeriesList
	Console.WriteLine(c.Name)		Console.WriteLine(sInfo.Name)
	Next		Next
	'select all series for import		'select all series for import

Froehlich: updated for v1.8.0 (r621)

2020-06-11T12:42:12Z

updated for v1.8.0 (r621)

← Older revision		Revision as of 05:42, 11 June 2020
Line 20:		Line 20:
	Dim Wave1 As New BlueM.Wave.Wave()		Dim Wave1 As New BlueM.Wave.Wave()
	Dim myFile As BlueM.Wave.FileFormatBase		Dim myFile As BlueM.Wave.FileFormatBase
	Dim ts as BlueM.Wave.TimeSeries		Dim ts As BlueM.Wave.TimeSeries

	'read a file		'read a file
	myFile = BlueM.Wave.FileFactory.getFileInstance(~~"path\to\file"~~)		myFile = BlueM.Wave.FileFactory.getFileInstance(Me.FileName)
	'check the available time series		'check the available time series
	For Each c As BlueM.Wave.FileFormatBase.~~ColumnInfo~~ In myFile.~~Columns~~		For Each c As BlueM.Wave.FileFormatBase.SeriesInfo In myFile.SeriesList
	Console.WriteLine(c.Name)		Console.WriteLine(c.Name)
	Next		Next
	'select all ~~columns (~~series) for import		'select all series for import
	myFile.~~selectAllColumns~~()		myFile.selectAllSeries()
	'read the selected time series from the file		'read the selected time series from the file
	myFile.~~read_File~~()		myFile.readFile()

	'loop over all series and print some information about them		'loop over all series read from the file and print some information about them
	For Each ts in myFile.~~TimeSeries~~		For Each ts In myFile.FileTimeSeries.Values
	Console.WriteLine("Series title: " & ts.Title)		Console.WriteLine("Series title: " & ts.Title)
	Console.WriteLine("Extent: " & ts.StartDate & " - " & ts.EndDate)		Console.WriteLine("Extent: " & ts.StartDate & " - " & ts.EndDate)
	Console.WriteLine("Max value: " & ts.Maximum)		Console.WriteLine("Max value: " & ts.Maximum)
	Console.WriteLine("Min value: " & ts.Minimum)		Console.WriteLine("Min value: " & ts.Minimum)
	Next		Next

	'get one particular time series		'get one particular time series
	ts = myFile.getTimeSeries("~~SeriesTitle~~")		ts = myFile.getTimeSeries("S1 _1AB")

	'cut the time series		'cut the time series
	ts.Cut(New DateTime(~~2000~~, 01, 01), New DateTime(~~2010~~, 1, 1))		ts.Cut(New DateTime(1959, 1, 1), New DateTime(1960, 1, 1))

	'loop over the nodes of the time series		'loop over the nodes of the time series
Line 51:		Line 51:
	Dim v As Double		Dim v As Double
	For Each node As KeyValuePair(Of DateTime, Double) In ts.Nodes		For Each node As KeyValuePair(Of DateTime, Double) In ts.Nodes
	d = node.Key		d = node.Key
	v = node.Value		v = node.Value
	Next		Next

Line 66:		Line 66:
	'create a new time series		'create a new time series
	Dim ts As New BlueM.Wave.TimeSeries("my series")		Dim ts As New BlueM.Wave.TimeSeries("my series")
			ts.Unit = "m3/s"
			ts.Interpretation = Wave.TimeSeries.InterpretationEnum.BlockRight
	'add some nodes to the time series		'add some nodes to the time series
	ts.AddNode(New DateTime(2000, 1, 1), 10.)		ts.AddNode(New DateTime(2000, 1, 1), 10)
	ts.AddNode(New DateTime(2000, 1, 2), 20.)		ts.AddNode(New DateTime(2000, 1, 2), 20)
	ts.AddNode(New DateTime(2000, 1, 3), 30.)		ts.AddNode(New DateTime(2000, 1, 3), 30)
	ts.AddNode(New DateTime(2000, 1, 4), 15.)		ts.AddNode(New DateTime(2000, 1, 4), 15)
	'~~display~~ the series in Wave		'Display the series in Wave
	Wave1.Import_Series(ts)		Wave1.Import_Series(ts)
	Wave1.Show()		Wave1.Show()

Froehlich: /* Example2 */ updated function name

2019-01-15T10:36:47Z

Example2: updated function name

← Older revision		Revision as of 03:36, 15 January 2019
Line 23:		Line 23:

	'read a file		'read a file
	myFile = BlueM.Wave.FileFactory.~~getDateiInstanz~~("path\to\file")		myFile = BlueM.Wave.FileFactory.getFileInstance("path\to\file")
	'check the available time series		'check the available time series
	For Each c As BlueM.Wave.FileFormatBase.ColumnInfo In myFile.Columns		For Each c As BlueM.Wave.FileFormatBase.ColumnInfo In myFile.Columns

Froehlich at 14:50, 3 December 2017

2017-12-03T14:50:06Z

← Older revision		Revision as of 07:50, 3 December 2017
Line 3:		Line 3:
	The Wave API provides a few methods for reading time series from files, manipulating and displaying them.		The Wave API provides a few methods for reading time series from files, manipulating and displaying them.

	To access the API, include a reference to Wave.exe in your .NET project.		To access the API, include a reference to Wave.exe (or to the Wave project if you have the source code) in your .NET project.

	Below are some examples.		Below are some examples.

Froehlich: Created page with "{{wave_nav}} The Wave API provides a few methods for reading time series from files, manipulating and displaying them. To access the API, include a reference to Wave.exe in..."

2017-12-03T14:43:42Z

Created page with "{{wave_nav}} The Wave API provides a few methods for reading time series from files, manipulating and displaying them. To access the API, include a reference to Wave.exe in..."

New page

{{wave_nav}}

The Wave API provides a few methods for reading time series from files, manipulating and displaying them.

To access the API, include a reference to Wave.exe in your .NET project.

Below are some examples.

==Example1==
<source lang="vbnet">
'Load a time series file and display it in Wave
Dim Wave1 As New BlueM.Wave.Wave()
Wave1.Import_File("path\to\file") 'depending on the file format, this may display an import dialog
Wave1.Show()
</source>

==Example2==
<source lang="vbnet">
'More complex example showcasing some more advanced techniques
Dim Wave1 As New BlueM.Wave.Wave()
Dim myFile As BlueM.Wave.FileFormatBase
Dim ts as BlueM.Wave.TimeSeries

'read a file
myFile = BlueM.Wave.FileFactory.getDateiInstanz("path\to\file")
'check the available time series
For Each c As BlueM.Wave.FileFormatBase.ColumnInfo In myFile.Columns
Console.WriteLine(c.Name)
Next
'select all columns (series) for import
myFile.selectAllColumns()
'read the selected time series from the file
myFile.read_File()

'loop over all series and print some information about them
For Each ts in myFile.TimeSeries
Console.WriteLine("Series title: " & ts.Title)
Console.WriteLine("Extent: " & ts.StartDate & " - " & ts.EndDate)
Console.WriteLine("Max value: " & ts.Maximum)
Console.WriteLine("Min value: " & ts.Minimum)
Next

'get one particular time series
ts = myFile.getTimeSeries("SeriesTitle")

'cut the time series
ts.Cut(New DateTime(2000, 01, 01), New DateTime(2010, 1, 1))

'loop over the nodes of the time series
Dim d As DateTime
Dim v As Double
For Each node As KeyValuePair(Of DateTime, Double) In ts.Nodes
d = node.Key
v = node.Value
Next

'Display the series in Wave
Wave1.Import_Series(ts)
Wave1.Show()
</source>

==Example3==
<source lang="vbnet">
'Create your own time series and display it in Wave
Dim Wave1 As New BlueM.Wave.Wave()
'create a new time series
Dim ts As New BlueM.Wave.TimeSeries("my series")
'add some nodes to the time series
ts.AddNode(New DateTime(2000, 1, 1), 10.)
ts.AddNode(New DateTime(2000, 1, 2), 20.)
ts.AddNode(New DateTime(2000, 1, 3), 30.)
ts.AddNode(New DateTime(2000, 1, 4), 15.)
'display the series in Wave
Wave1.Import_Series(ts)
Wave1.Show()
</source>

[[Category:BlueM.Wave]]