Log I/O
Loading...
Searching...
No Matches
BitFileWriter Class Referencesealed

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

Public Member Functions

 BitFileWriter (FileInfo file)
 Create a BIT file writer for the specified disk file.
 
 BitFileWriter (Stream outputStream)
 Create a BIT file writer for the specified stream.
 
void Close ()
 Append the final EOF TIF marker to the stream and close the back-end stream.
 
void Write (BitFile bitFile)
 Write the specified BIT file.
 
void Write (IList< BitFile > bitFiles)
 Write a list of logical BIT files to this writer.
 

Detailed Description

Class for writing BIT files to disk.

Typical usage:

    BitFileWriter writer = new BitFileWriter(new FileInfo("path/to/file.bit"));
    writer.Write(bitFile);
    writer.Close();
Author
Petroware AS

Constructor & Destructor Documentation

◆ BitFileWriter() [1/2]

BitFileWriter ( Stream outputStream)

Create a BIT file writer for the specified stream.

Parameters
outputStreamStream to write. Non-null.
Exceptions
ArgumentNullExceptionIf outputStream is null.

◆ BitFileWriter() [2/2]

BitFileWriter ( FileInfo file)

Create a BIT file writer for the specified disk file.

Parameters
fileDisk file to write. Non-null.
Exceptions
ArgumentNullExceptionIf file is null.

Member Function Documentation

◆ Write() [1/2]

void Write ( BitFile bitFile)

Write the specified BIT file.

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

Parameters
bitFileBIT file to write. Non-null.
Exceptions
ArgumentNullExceptionIf bitFile is null.

◆ Write() [2/2]

void Write ( IList< BitFile > bitFiles)

Write a list of logical BIT files to this writer.

This is equivalent to calling Write(BitFile) in sequence.

Parameters
bitFilesBIT files to write. Non-null.
Exceptions
ArgumentNullExceptionIf bitFiles is null.

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