Interface ISifDataWriter

Namespace: DNV.Sesam.SifApi.Core

Assembly: cs.temp.dll.dll

Syntax

public interface ISifDataWriter

Methods

Close()

Close the writer.

Declaration

void Close()

CreateTab(String, Int64[], Int64)

For indexed data types: Sets the maximum id for a data type in each dimension relevant for the data type. For non-indexed data types: allocates space for a specified number of data arrays.

Declaration

bool CreateTab(string name, long[] maxIds, long maxNumberOfArrays = 0L)

Parameters

Type	Name	Description
System.String	name	The name of the data type.
System.Int64[]	maxIds	The maximum data id for each dimension. This is only used for indexed SIF data types.
System.Int64	maxNumberOfArrays	Assumed number of entries to be added. This is used only for non-indexed SIF data types.

Returns

Type	Description
System.Boolean	true

GetTabDimensions(String)

Get the size of the established pointer table for a datatype

Declaration

long[] GetTabDimensions(string name)

Parameters

Type	Name	Description
System.String	name	The name of the data type.

Returns

Type	Description
System.Int64[]	Array with elements holding the size of the pointer table in each pointer table dimension. The length of the array (number of dimensions) is equal to the number of SIF indices for the given datatype.

Write(String, Double[])

Write non-text data.

Declaration

bool Write(string name, double[] data)

Parameters

Type	Name	Description
System.String	name	The name of the data type.
System.Double[]	data	The numeric data. sifVal[0] must equal the length of the data (including data[0]), also for data types not defined with the data length as the first element.

Returns

Type	Description
System.Boolean	true

Write(String, Double[], Boolean)

Write non-text data.

Declaration

bool Write(string name, double[] data, bool appendDataLength)

Parameters

Type	Name	Description
System.String	name	The name of the data type.
System.Double[]	data	The numeric data.
System.Boolean	appendDataLength	Must be set to true iff sifVal[] does not hold the length of the data.

Returns

Type	Description
System.Boolean	true

WriteData(String, List<ISifData>)

Writes a list of data. The data must be headed by the data length, also for data types not defined with the data length as the first element.

Declaration

bool WriteData(string name, List<ISifData> listOfData)

Parameters

Type	Name	Description
System.String	name	The name of the data type.
System.Collections.Generic.List<ISifData>	listOfData	The list of data to write.

Returns

Type	Description
System.Boolean

WriteDate(String, String, String)

Write the data type DATE for an actual program, application or service.

Declaration

bool WriteDate(string programName, string programVersion, string programReleaseDate)

Parameters

Type	Name	Description
System.String	programName	The program, application or service name.
System.String	programVersion	The program, application or service version.
System.String	programReleaseDate	The program, application or service release date.

Returns

Type	Description
System.Boolean	true

WriteSifFile(String)

Export data to a SIF file.

Declaration

bool WriteSifFile(string filename)

Parameters

Type	Name	Description
System.String	filename	The name of the SIF file.

Returns

Type	Description
System.Boolean	true

WriteText(String, Int64, List<String>)

Write text data.

Declaration

bool WriteText(string name, long id, List<string> sifText)

Parameters

Type	Name	Description
System.String	name	The name of the data type.
System.Int64	id	The id of the data.
System.Collections.Generic.List<System.String>	sifText	List of text strings to write.

Returns

Type	Description
System.Boolean	true