DlisFileWriter Class Reference

Class for writing DLIS files to disk. More...

Public Member Functions
void	Append (DlisFrame dlisFrame)
	Append the curve data of the specified DLIS frame to this file.
void	Close ()
	Close the back-end stream.
	DlisFileWriter (FileInfo file)
	Create a DLIS file writer for the specified disk file.
	DlisFileWriter (Stream outputStream)
	Create a DLIS file writer for the specified stream.
void	Write (DlisFile dlisFile)
	Write the specified DLIS file.
void	Write (IList< DlisFile > dlisFiles)
	Write the specified DLIS files.

Detailed Description

Class for writing DLIS files to disk.

Typical usage:

    DlisFileWriter writer = new DlisFiledWriter(new FileInfo("path/to/file.dlis"));
    writer.Write(dlisFile);
    writer.Close();

If there is to much data to keep in memory, or the writing is based on a streaming source, it is possible to append chunks of data to the last DlisFile instance written, like:

    DlisFileWriter writer = new DlisFiledWriter(new FileInfo("path/to/file.dlis"));
    writer.Write(dlisFile);
    writer.Append(dlisFrame);
    writer.Append(dlisFrame);
    :
    writer.Close();

See also

RP66 V1

Author

Petroware AS

Constructor & Destructor Documentation

DlisFileWriter() [1/2]

DlisFileWriter

(

Stream

outputStream

)

Create a DLIS file writer for the specified stream.

Parameters

outputStream

Stream to write. Non-null.

Exceptions

ArgumentNullException

If outputStream is null.

DlisFileWriter() [2/2]

DlisFileWriter

(

FileInfo

file

)

Create a DLIS file writer for the specified disk file.

Parameters

file	Disk file to write. Non-null.

Exceptions

ArgumentNullException

If file is null.

Member Function Documentation

Append()

void Append

(

DlisFrame

dlisFrame

)

Append the curve data of the specified DLIS frame to this file.

This feature can be used to stream data to a DLIS file. By repeatedly clearing and populating the frame curves with new data there is no need for the client to keep the entire volume in memory at any time.

NOTE: This method should be called after the DLIS meta data has been written to file, and the DLIS frame must be compatible with this.

Parameters

dlisFrame

DLIS frame of curves to append to file. Non-null.

Exceptions

ArgumentNullException	If dlisFrame is null.
IOException	If the write operation fails for some reason.

Write() [1/2]

void Write

(

DlisFile

dlisFile

)

Write the specified DLIS file.

Multiple logical DLIS files can be written in sequence to the same stream. When writing is done, close the writer with Close().

Parameters

dlisFile

DLIS file to write. Non-null.

Exceptions

ArgumentNullException	If dlisFile is null.
IOException	If the write operation fails for some reason.

Write() [2/2]

void Write

(

IList< DlisFile >

dlisFiles

)

Write the specified DLIS files.

Convenience method, equivalent of calling Write(DlisFile) in sequence.

Parameters

dlisFiles

DLIS files to write. Non-null.

Exceptions

ArgumentNullException

If dlisFiles is null.

---

The documentation for this class was generated from the following file:

• Petroware/LogIo/Dlis/DlisFileWriter.cs