Table of Contents

Class FEWS_PI

Namespace
BlueM.Wave.Fileformats
Assembly
Wave.dll

Class for the Delft-FEWS published interface timeseries format Format description: https://publicwiki.deltares.nl/spaces/FEWSDOC/pages/8683960/Delft-Fews+Published+Interface+timeseries+Format+PI+Import XML schema: https://fews.wldelft.nl/schemas/version1.0/pi-schemas/pi_timeseries.xsd

public class FEWS_PI : TimeSeriesFile
Inheritance
FEWS_PI
Inherited Members

Constructors

FEWS_PI(string, bool)

Instantiates a new FEWS_PI object

public FEWS_PI(string file, bool ReadAllNow = false)

Parameters

file string

path to the file

ReadAllNow bool

Properties

MetadataKeys

Returns a list of Delft-FEWS PI-specific metadata keys

public static List<string> MetadataKeys { get; }

Property Value

List<string>

UseImportDialog

Specifies whether to use the file import dialog

public override bool UseImportDialog { get; }

Property Value

bool

Methods

readFile()

reads the file

public override void readFile()

readSeriesInfo()

Reads the metadata from the file

public override void readSeriesInfo()

setDefaultMetadata(TimeSeries)

Sets default metadata values for a time series corresponding to the Delft-FEWS PI timeseries format

public static void setDefaultMetadata(TimeSeries ts)

Parameters

ts TimeSeries

verifyFormat(string)

Checks whether a file conforms with the Delft-FEWS PI-format

public static bool verifyFormat(string file)

Parameters

file string

path to file

Returns

bool

Boolean

writeFile(ref List<TimeSeries>, string)

Write one or multiple series to an XML file in Delft-FEWS PI timeseries format

public static void writeFile(ref List<TimeSeries> tsList, string file)

Parameters

tsList List<TimeSeries>

time series to write to file

file string

path to the xml file