Log I/O
|
Class representing the content of one DLIS (sub-) file. More...
Public Member Functions | |
void | AddFrame (DlisFrame frame) |
Add the specified frame to this DLIS file. | |
void | AddSet (DlisSet set) |
Add the specified set to this DLIS file. | |
DlisFile () | |
Create a new empty DLIS file instance with default header. | |
DlisFrame | FindFrame (string frameName) |
Find frame with the specified name. | |
DlisSet | FindSet (string setType) |
Find set of the specified type. | |
IList< DlisEncryptedRecord > | GetEncryptedRecords () |
Return the encrypted records of this DLIS file. | |
string | GetFileId () |
Return the ID of this DLIS file as specified in the ORIGIN set of the file. | |
IList< DlisFrame > | GetFrames () |
Return the frames of this DLIS file. | |
DlisFileHeader | GetHeader () |
Return the header of this DLIS file. | |
string | GetName () |
Return the name of this file. | |
IList< DlisSet > | GetSets () |
Return the sets of this DLIS file. | |
string | GetUnit (string objectName, string attributeName) |
Return unit for the specified meta-data attribute of the specified object. | |
DlisType | GetValue (string objectName, string attributeName) |
Return value for the specified attribute of the specified object. | |
DlisComponent | GetValueComponent (string objectName, string attributeName) |
Return the value component (i.e. the instance holding the values and specifying the unit etc.) for the given attribute of the specified object. | |
IList< DlisType > | GetValues (string objectName, string attributeName) |
Return values for the specified attribute of the specified object. | |
bool | HasCurveData () |
Return whether the DLIS file instance includes curve data or not, i.e. if only header data was read or created. | |
override string | ToString () |
Class representing the content of one DLIS (sub-) file.
A DlisFile consists of the following elements:
File header - This is really a property of the disk file, but it is included in each DlisFile
instance for simplicity.
Meta-data - Data about the logging operation. Organized in sets (DlisSet
).
Encrypted records - Data that can't really be interpreted, but it is anyway read, and provided as simple byte arrays through the DlisEncryptedRecord
class.
DlisFrame
) which defines one set of curves sampled against a common reference index. void AddFrame | ( | DlisFrame | frame | ) |
Add the specified frame to this DLIS file.
Note that the associated FRAME set must be added by the client explicitly.
frame | Frame to add. Non-null. |
ArgumentNullException | If frame is null. |
void AddSet | ( | DlisSet | set | ) |
Add the specified set to this DLIS file.
set | Set to add. Non-null. |
ArgumentNullException | If set is null. |
DlisFrame FindFrame | ( | string | frameName | ) |
Find frame with the specified name.
frameName | Name of frame to find. Non-null. |
ArgumentNullException | If frameName is null. |
DlisSet FindSet | ( | string | setType | ) |
Find set of the specified type.
If there are more than one set with the given type, the first one found is returned.
Set types are dictionary controlled. Typical values are "FILE-HEADER", "ORIGIN", "PARAMETER", "CHANNEL", "FRAME" etc. See RP66 V1 Chapter 5.
setType | Type of set to find. Non-null. |
ArgumentNullException | If setType is null. |
IList< DlisEncryptedRecord > GetEncryptedRecords | ( | ) |
Return the encrypted records of this DLIS file.
string GetFileId | ( | ) |
Return the ID of this DLIS file as specified in the ORIGIN set of the file.
IList< DlisFrame > GetFrames | ( | ) |
Return the frames of this DLIS file.
DlisFileHeader GetHeader | ( | ) |
Return the header of this DLIS file.
Note that the file header is a property of the disk file and not the logical DLIS file instance. It is anyway included in each of the sub file instances for convenience.
string GetName | ( | ) |
Return the name of this file.
Typically the name of the back-end disk file, or null if not set.
IList< DlisSet > GetSets | ( | ) |
Return the sets of this DLIS file.
The sets contains the meta-data for the logging operation.
string GetUnit | ( | string | objectName, |
string | attributeName ) |
Return unit for the specified meta-data attribute of the specified object.
This is a convenience method for accessing meta-data across sets directly from the DlisFile instance.
objectName | Name of object to return unit from. |
attributeName | Name of attribute of unit to return. |
ArgumentNullException | If objectName or attributeName is null. |
DlisType GetValue | ( | string | objectName, |
string | attributeName ) |
Return value for the specified attribute of the specified object.
Search all sets. If the object has more than one value for the specified attribute, the first one is returned. Convenient if the caller knowns that there is exactly one value.
This is a convenience method for accessing meta-data across sets directly from the DlisFile instance.
objectName | Name of object to find value of. Non-null. |
attributeName | Attribute to find value of. Non-null. |
ArgumentNullException | If objectName or attributeName is null. |
DlisComponent GetValueComponent | ( | string | objectName, |
string | attributeName ) |
Return the value component (i.e. the instance holding the values and specifying the unit etc.) for the given attribute of the specified object.
Search all sets.
This is a convenience method for accessing meta-data across sets directly from the DlisFile instance.
objectName | Name of object to find value component of. Non-null. |
attributeName | Attribute to find value component of. Non-null. |
ArgumentNullException | If objectName or attributeName is null. |
IList< DlisType > GetValues | ( | string | objectName, |
string | attributeName ) |
Return values for the specified attribute of the specified object.
Search all sets.
This is a convenience method for accessing meta-data across sets directly from the DlisFile instance.
objectName | Name of object to return value from. Non-null. |
attributeName | Name of attribute to return. Non-null. |
ArgumentNullException | If objectName or attributeName is null. |
bool HasCurveData | ( | ) |
Return whether the DLIS file instance includes curve data or not, i.e. if only header data was read or created.