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

Class representing the content of one BIT (sub-) file. More...

Public Member Functions

 BitFile ()
 Create an empty BIT file instance with a default header.
 
 BitFile (BitGeneralHeadingRecord header)
 Create an empty BIT file instance with the specified header.
 
IList< BitCurveGetCurves ()
 Return the curves of this BIT file.
 
BitGeneralHeadingRecord GetHeader ()
 Return header of this BIT file.
 
string GetName ()
 Return name of this BIT file.
 
int GetNCurves ()
 Return the number of curves in this BIT file, including the index curve.
 
int GetNValues ()
 Return the number of values in each curve of this BIT file.
 
bool HasCurveData ()
 Check if this BIT file instance contains bulk data.
 
override string ToString ()
 

Detailed Description

Class representing the content of one BIT (sub-) file.

Author
Petroware AS

Constructor & Destructor Documentation

◆ BitFile()

Create an empty BIT file instance with the specified header.

Parameters
headerFile header. Non-null.
Exceptions
ArgumentNullExceptionIf header is null.

Member Function Documentation

◆ GetCurves()

IList< BitCurve > GetCurves ( )

Return the curves of this BIT file.

If the BIT file contains curves, the index curve is always the first one.

Returns
The curves of this BIT file. Including index curve. Never null.

◆ GetHeader()

BitGeneralHeadingRecord GetHeader ( )

Return header of this BIT file.

Returns
Header of this BIT file. Never null.

◆ GetName()

string GetName ( )

Return name of this BIT file.

Returns
Name of this BIT file. Never null.

◆ GetNCurves()

int GetNCurves ( )

Return the number of curves in this BIT file, including the index curve.

Returns
Number of curves in this BIT file. [0,>.

◆ GetNValues()

int GetNValues ( )

Return the number of values in each curve of this BIT file.

Returns
Number of values in the curves. [0,>.

◆ HasCurveData()

bool HasCurveData ( )

Check if this BIT file instance contains bulk data.

Returns
True if the instance contains curve data, false otherwise.

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