public final class DlisFrame extends Object
A frame is one set of curves with a common index curve. A DlisFile instance may contain multiple frames.
Modifier and Type | Class and Description |
---|---|
static class |
DlisFrame.IndexType
Possible index types for a DLIS file.
|
Constructor and Description |
---|
DlisFrame(DlisSet frameSet,
DlisComponent frameObject)
Create a new DLIS frame instance.
|
Modifier and Type | Method and Description |
---|---|
void |
addCurve(DlisCurve curve)
Add a curve to this frame.
|
void |
clearCurves()
Clear curve data from all curves of this frame.
|
boolean |
equals(Object object) |
DlisCurve |
findCurve(String curveName)
Find the curve of the given name.
|
List<DlisCurve> |
getCurves()
Return the curves of this frame in the order of which
the data is organized in the corresponding DLIS file.
|
DlisCurve |
getIndexCurve()
Return the index curve of this frame.
|
String |
getIndexCurveName()
Return name of the index curve.
|
DlisType |
getIndexStep()
Return the index step.
|
DlisFrame.IndexType |
getIndexType()
Return index type of this frame.
|
String |
getIndexUnit()
Return the unit of the index curve.
|
DlisType |
getMaxIndex()
Return the maximum index value.
|
DlisType |
getMinIndex()
Return the minimum index value.
|
String |
getName()
Return the name of this frame.
|
int |
getNCurves()
Return number of curves in this frame.
|
int |
getNValues()
Return the number of values (per curve) in this frame.
|
int |
hashCode() |
boolean |
isTimeIndex()
Check if this frame is time indexed.
|
String |
toString() |
public DlisFrame(DlisSet frameSet, DlisComponent frameObject)
frameSet
- The frame set. Non-null.frameObject
- The frame object component. Non-null.IllegalArgumentException
- If frameSet or frameObject is null.public String getName()
public DlisFrame.IndexType getIndexType()
public boolean isTimeIndex()
public String getIndexCurveName()
public String getIndexUnit()
public DlisType getMinIndex()
Note that this is an optional (but convenient) property of the frame set. If it is not given, the client must read the data to extract the index range. The index min value from the frame set can anyway not necessarily be trusted, as the producer of the DLIS are free to enter whatever value it wishes.
Experience shows that the value usually is correct when present, but that it is often missing.
public DlisType getMaxIndex()
Note that this is an optional (but convenient) property of the frame set. If it is not given, the client must read the data to extract the index range. The index max value from the frame set can anyway not necessarily be trusted, as the producer of the DLIS are free to enter whatever value it wishes.
Experience shows that the value usually is correct when present, but that it is often missing.
public DlisType getIndexStep()
Note that this is an optional (but convenient) property of the frame set. If it is not given, the client must read the data to extract the index range and compute the step. The index step value from the frame set can anyway not necessarily be trusted, as the producer of the DLIS are free to enter whatever value it wishes.
Experience shows that the value usually is correct when present, but that it is often missing. There is no convention on what this property should contain if the actual step is varying.
public int getNValues()
public int getNCurves()
public void addCurve(DlisCurve curve)
curve
- Curve to add. Non-null.IllegalArgumentException
- If curve is null.public List<DlisCurve> getCurves()
public DlisCurve getIndexCurve()
public DlisCurve findCurve(String curveName)
curveName
- Name of curve to find. Non-null. Case sensitive.IllegalArgumentException
- If curveName is null.public void clearCurves()
Copyright © 2024 Petroware AS - https://petroware.no