Base class for records holding information.
More...
Inherits LisRecord.
Inherited by LisJobIdentificationRecord, LisToolStringInfoRecord, and LisWellSiteDataRecord.
|
void | AddRow () |
| Add a table row with empty values to this component.
|
|
void | AddRow (IList< object > values) |
| Add a table row to this component.
|
|
int | FindColumn (string columnName) |
| Find column with the specified name.
|
|
string | GetColumnName (int columnNo) |
| Return the name of the specified column.
|
|
LisComponent | GetComponent (int rowNo, string columnName) |
| Return the component of from the specified column in the given row.
|
|
LisComponent | GetComponentAt (int rowNo, int columnNo) |
| Return component at the specified index.
|
|
IList< LisComponent > | GetComponents () |
| Return the components of this record.
|
|
string | GetName () |
| Return name of this information record.
|
|
int | GetNColumns () |
| Return number of columns of information.
|
|
int | GetNRows () |
| Return number of rows of information.
|
|
bool | IsTable () |
| Check if this record contains a table of information.
|
|
| LisInformationRecord (int recordType, IList< LisComponent > components) |
| Create a LIS information record.
|
|
void | RemoveRow (int rowNo) |
| Remove the specified row from this record.
|
|
override string | ToString () |
|
int | GetAttributes () |
| Return attributes of this record.
|
|
int | GetRecordType () |
| Return type of this record.
|
|
override string | ToString () |
|
|
| LisInformationRecord (int recordType, string tableName, IList< string > columnNames) |
| Create an empty information record table with a set of prepared column names as specified.
|
|
| LisRecord (int recordType, int attributes) |
| Create a new LIS record.
|
|
Base class for records holding information.
Information records can be of two types, a one-dimensional list or a two-dimensional table.
A table is identified by having the first record as type = 73. Then each row of the table is started with a record of type = 0, being the component of the first column cell, and then N records of type = 69 being the cells for the consecutive columns.
See LIS 79 Documentation Section 4.1.3.
- Author
- Petroware AS
◆ LisInformationRecord() [1/2]
Create a LIS information record.
- Parameters
-
recordType | Information record type. |
components | The components that makes up the record. Non-null. |
- Exceptions
-
ArgumentNullException | If components is null. |
◆ LisInformationRecord() [2/2]
Create an empty information record table with a set of prepared column names as specified.
Actual content to the table is added through the AddRow() method.
- Parameters
-
recordType | Information record type. |
tableName | Table name. Non-null. |
columnNames | Name of columns. Non-null and with at least two entries. |
- Exceptions
-
ArgumentNullException | If tableName or columnNames are null. |
◆ AddRow()
void AddRow |
( |
IList< object > | values | ) |
|
Add a table row to this component.
- Parameters
-
values | The values making up the table row. Should have as many entries as the table has columns. |
- Exceptions
-
ArgumentNullException | If values is null |
ArgumentException | If number of values doesn't match the number of columns in the table. |
◆ FindColumn()
int FindColumn |
( |
string | columnName | ) |
|
Find column with the specified name.
Case-insensitive search.
- Parameters
-
columnName | Name of column to locate. Non-null. |
- Returns
- Requested column number (0-based) or -1 if not found.
- Exceptions
-
ArgumentNullException | If columnName is null |
◆ GetColumnName()
string GetColumnName |
( |
int | columnNo | ) |
|
Return the name of the specified column.
- Parameters
-
columnNo | Column to get name of. [0,nColumns>. |
- Returns
- The requested column name. Never null.
- Exceptions
-
ArgumentException | If columnNo is out of bounds. |
◆ GetComponent()
Return the component of from the specified column in the given row.
- Parameters
-
rowNo | Row number to pick from. [0,nRows> |
columnName | Name of column to get value from. Non-null. |
- Returns
- The requested component, or null if the column could not be found.
- Exceptions
-
ArgumentNullException | If rowNo is out of bounds or columnName is null. |
◆ GetComponentAt()
Return component at the specified index.
- Parameters
-
rowNo | Row number index. [0,nRows> |
columnNo | Column number index. [0,nRColumns> |
- Returns
- The requested component. Null if there is no component at this location.
- Exceptions
-
ArgumentException | If rowNo or columnNo are out of bounds. |
◆ GetComponents()
Return the components of this record.
- Returns
- The components of this record. Never null.
◆ GetName()
Return name of this information record.
A name is only provided for table data, and in that case it is the value of the table identifying component.
- Returns
- The name of this information record. Null if non-provided or N/A.
◆ GetNColumns()
Return number of columns of information.
- Returns
- Number of information columns.
◆ GetNRows()
Return number of rows of information.
For a non-table record this will be the number of contained components.
- Returns
- Number of information rows. [0,>.
◆ IsTable()
Check if this record contains a table of information.
- Returns
- True if this is a table of information, otherwise it is a one-dimensional list.
◆ RemoveRow()
void RemoveRow |
( |
int | rowNo | ) |
|
Remove the specified row from this record.
- Parameters
-
rowNo | Row to remove. [0,nRows>. |
- Exceptions
-
ArgumentException | If rowNo is out of bounds. |
The documentation for this class was generated from the following file:
- Petroware/LogIo/Lis/LisInformationRecord.cs