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

Class representing a LIS file header record ("FHLR") More...

Inherits LisRecord.

Public Member Functions

string GetFileName ()
 Return logical file name.
 
string GetFileType ()
 Return file type of this record.
 
DateTime? GetGeneratedDate ()
 Return generated date of this record.
 
int GetMaxSegmentLength ()
 Return maximum segment length for the file.
 
string GetPreviousFileName ()
 Get name of previous file.
 
string GetServiceId ()
 Return service ID of this record.
 
string GetVersionNo ()
 Get software version number of this record.
 
 LisFileHeaderRecord (string fileName, string serviceId, string versionNo, DateTime? generatedDate, int maxSegmentLength, string fileType, string previousFileName)
 Create a file header record.
 
override string ToString ()
 
- Public Member Functions inherited from LisRecord
int GetAttributes ()
 Return attributes of this record.
 
int GetRecordType ()
 Return type of this record.
 
override string ToString ()
 

Additional Inherited Members

- Static Public Attributes inherited from LisRecord
const int ALTERNATE_DATA = 1
 Type 1: Alternate data.
 
const int BLANK = 234
 Type 234: Blank.
 
const int BOOTSTRAP_LOADER = 96
 Type 96: Bootstrap loader.
 
const int COMMENT = 232
 Type 232: Comment.
 
const int DATA_FORMAT_SPECIFICATION = 64
 Type 64: Data format specification.
 
const int ENCRYPTED_TABLE = 42
 Type 42: Encrypted table dump.
 
const int FILE_HEADER = 128
 Type 128: File header.
 
const int FILE_TRAILER = 129
 Type 129: File trailer.
 
const int IMAGE = 86
 Type 86: Image.
 
const int JOB_IDENTIFICATION = 32
 Type 32: Information (job identification).
 
const int KERNEL_LOADER_BOOT = 97
 Type 97: CP-Kernel loader boot.
 
const int LOGICAL_BOT = 138
 Type 138: Logical beginning-of-tape.
 
const int LOGICAL_EOF = 137
 Type 137: Logical end-of-file.
 
const int LOGICAL_EOM = 141
 Type 141: Logical end-of-medium.
 
const int LOGICAL_EOT = 139
 Type 139: Logical end-of-tap.
 
const int NORMAL_DATA = 0
 Type 0: Normal data.
 
const int OPERATOR_COMMAND_INPUTS = 224
 Type 224: Operator command inputs.
 
const int OPERATOR_RESPONSE_INPUTS = 225
 Type 225: Operator response inputs.
 
const int PICTURE = 85
 Type 85: Picture.
 
const int PROGRAM_OVERLAY_HEADER = 101
 Type 101: Program overlay header.
 
const int PROGRAM_OVERLAY_LOAD = 102
 Type 102: Program overlay load.
 
const int REEL_HEADER = 132
 Type 132: Reel header.
 
const int REEL_TRAILER = 133
 Type 133: Reel trailer.
 
const int SOFTWARE_BOOT = 95
 Type 95: TU10 Software boot.
 
const int SYSTEM_OUTPUTS_TO_OPERATOR = 227
 Type 227: System outputs to operator.
 
const int TABLE_DUMP = 47
 Type 47: Table dump.
 
const int TAPE_HEADER = 130
 Type 130: Tape header.
 
const int TAPE_TRAILER = 131
 Type 131: Tape trailer.
 
const int TOOL_STRING_INFO = 39
 Type 39: Information (tool string info).
 
const int WELL_SITE_DATA = 34
 Type 34: Information (well site data).
 
- Protected Member Functions inherited from LisRecord
 LisRecord (int recordType, int attributes)
 Create a new LIS record.
 

Detailed Description

Class representing a LIS file header record ("FHLR")

See LIS 79 Documentation Section 4.1.14.

Author
Petroware AS

Constructor & Destructor Documentation

◆ LisFileHeaderRecord()

LisFileHeaderRecord ( string fileName,
string serviceId,
string versionNo,
DateTime? generatedDate,
int maxSegmentLength,
string fileType,
string previousFileName )

Create a file header record.

Parameters
fileNameFile name. Should be within 10 characters or it will be clipped when written to file. Null if N/A.
serviceIdService ID. Should be within 6 characters or it will be clipped when written to file. Null if N/A.
versionNoVersion number for the software that wrote the original data. Should be within 8 characters or it will be clipped when written to file. Null if N/A.
generatedDateDate of generation. Null to indicate unknown or N/A.
maxSegmentLengthMaximum segment length.
fileTypeFile type. Should be within two characters or it will be clipped when written to file. Null if N/A.
previousFileNamePrevious file name. Should be within 10 characters or it will be clipped when written to file. Null if N/A.

Member Function Documentation

◆ GetFileName()

string GetFileName ( )

Return logical file name.

Returns
Logical file name. Null if N/A.

◆ GetFileType()

string GetFileType ( )

Return file type of this record.

Returns
File type. Null if N/A.

◆ GetGeneratedDate()

DateTime? GetGeneratedDate ( )

Return generated date of this record.

Returns
Generated date. Null if unknown or N/A.

◆ GetMaxSegmentLength()

int GetMaxSegmentLength ( )

Return maximum segment length for the file.

Returns
Maximum segment length for the file. [4,99999].

◆ GetPreviousFileName()

string GetPreviousFileName ( )

Get name of previous file.

Returns
Name of previous file. Null if N/A.

◆ GetServiceId()

string GetServiceId ( )

Return service ID of this record.

Returns
Service ID. Null if N/A.Never null.

◆ GetVersionNo()

string GetVersionNo ( )

Get software version number of this record.

Returns
Software version number. Null if N/A.

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