public static class WitsmlWell.Datum extends Object
Modifier and Type | Class and Description |
---|---|
static class |
WitsmlWell.Datum.Type
The type of local or permanent reference datum for vertical gravity
based (i.e., elevation and vertical depth) and measured depth
coordinates within the context of a well.
|
Modifier and Type | Method and Description |
---|---|
String |
getComment()
Return the comment of this datum.
|
String |
getDatumName()
Return the datum name of this datum.
|
Value |
getElevation()
Return the elevation of this datum.
|
String |
getId()
Return the ID of this datum.
|
List<String> |
getKinds()
Return the kinds of this datum.
|
Value |
getMd()
Return the md of this datum.
|
String |
getName()
Return the name of this datum.
|
Reference |
getRig()
Return the rig of this datum.
|
Reference |
getRigWell()
Return the rig well of this datum.
|
Reference |
getRigWellbore()
Return the rig wellbore of this datum.
|
WitsmlWell.Datum.Type |
getType()
Return the type of this datum.
|
Reference |
getWellbore()
Return the wellbore of this datum.
|
Reference |
getWellboreWell()
Return the wellbore well of this datum.
|
Boolean |
isDefaultElevation()
Return if this datum is default elevation.
|
Boolean |
isDefaultMd()
Return if this datum is default MD.
|
Boolean |
isDefaultTvd()
Return if this datum is default TVD.
|
void |
setComment(String comment)
Set the comment of this datum.
|
void |
setDatumName(String datumName)
Set the datum name of this datum.
|
void |
setDefaultElevation(Boolean isDefaultElevation)
Set if this datum is is default elevation.
|
void |
setDefaultMd(Boolean isDefaultMd)
Set if this datum is is default MD.
|
void |
setDefaultTvd(Boolean isDefaultTvd)
Set if this datum is is default TVD.
|
void |
setElevation(Value elevation)
Set the elevation of this datum.
|
void |
setKinds(List<String> kinds) |
void |
setMd(Value md)
Set the md of this datum.
|
void |
setName(String name)
Set the name of this datum.
|
void |
setRig(Reference rig,
Reference rigWellbore,
Reference rigWell)
Set the rig of this datum.
|
void |
setType(WitsmlWell.Datum.Type type)
Set the type of this datum.
|
void |
setWellbore(Reference wellbore,
Reference wellboreWell)
Set the wellbore of this datum.
|
public String getId()
public String getName()
Corresponds to the WITSML property name
:
The human understandable contextual name of the reference datum.
public void setName(String name)
Corresponds to the WITSML property name
:
The human understandable contextual name of the reference datum.
name
- The name to set.
May be null indicating absent or unknown.public WitsmlWell.Datum.Type getType()
Corresponds to the WITSML property code
:
The type value that represents the type of reference datum. This may represent a point on a device (e.g., kelly bushing) or it may represent a vertical reference datum (e.g., mean sea level).
public void setType(WitsmlWell.Datum.Type type)
Corresponds to the WITSML property code
:
The type value that represents the type of reference datum. This may represent a point on a device (e.g., kelly bushing) or it may represent a vertical reference datum (e.g., mean sea level).
type
- The type to set.
May be null indicating absent or unknown.public String getDatumName()
Corresponds to the WITSML property datumName
:
The name of the vertical reference datum in a particular naming system. This should only be specified if the above 'code' represents some variation of sea level. An optional short name (code) can also be specified. Specifying a well known datum is highly desired if the above code is a variant of sea level because sea level varies over time and space. An example would be to specify a name of 'Caspian Sea' with a code of '5106' in the 'EPSG' naming system.
public void setDatumName(String datumName)
Corresponds to the WITSML property datumName
:
The name of the vertical reference datum in a particular naming system. This should only be specified if the above 'code' represents some variation of sea level. An optional short name (code) can also be specified. Specifying a well known datum is highly desired if the above code is a variant of sea level because sea level varies over time and space. An example would be to specify a name of 'Caspian Sea' with a code of '5106' in the 'EPSG' naming system.
datumName
- The datum name to set.
May be null indicating absent or unknown.public List<String> getKinds()
Corresponds to the WITSML property kind
:
Since various activities may use different points as measurement datums, it is useful to characterize the point based on its usage. A well reference datum may have more than one such characterization. For example, it may be the datum used by the driller and logger for measuring their depths. Example usage values would be 'permanent', 'driller', 'logger' 'WRP' (well reference point) and 'SRP' (site reference point).
public Reference getWellbore()
Corresponds to the WITSML property wellbore
:
A pointer to the wellbore that contains the reference datum. This should be specified if a measured depth is given.
public Reference getWellboreWell()
Corresponds to the WITSML property wellbore
:
A pointer to the wellbore that contains the reference datum. This should be specified if a measured depth is given.
public void setWellbore(Reference wellbore, Reference wellboreWell)
Corresponds to the WITSML property wellbore
:
A pointer to the wellbore that contains the reference datum. This should be specified if a measured depth is given.
wellbore
- The wellbore to set. May be null indicating absent or unknown.wellboreWell
- The wellbore well reference. May be null indicating absent or unknown.public Reference getRig()
Corresponds to the WITSML property rig
:
A pointer to the rig that contains the device used as a reference datum. The rig may be associated with a wellbore in another well (e.g., pattern drilling using a rig on a track). rig
public Reference getRigWellbore()
Corresponds to the WITSML property wellboreParent
:
A pointer to the rig that contains the device used as a reference datum. The rig may be associated with a wellbore in another well (e.g., pattern drilling using a rig on a track). rig
public Reference getRigWell()
Corresponds to the WITSML property wellParent
:
A pointer to the rig that contains the device used as a reference datum. The rig may be associated with a wellbore in another well (e.g., pattern drilling using a rig on a track). rig
public void setRig(Reference rig, Reference rigWellbore, Reference rigWell)
Corresponds to the WITSML property rig
:
A pointer to the rig that contains the device used as a reference datum. The rig may be associated with a wellbore in another well (e.g., pattern drilling using a rig on a track). rig
rig
- The rig to set.
May be null indicating absent or unknown.rigWellbore
- The rig wellbore reference. May be null indicating absent or unknown.rigWell
- The rig well reference. May be null indicating absent or unknown.public Value getElevation()
Corresponds to the WITSML property elevation
:
The gravity based elevation coordinate of this reference datum as measured from another datum. Positive moving upward from the elevation datum. An elevation should be given unless this is a vertical reference datum (e.g., sea level).
public void setElevation(Value elevation)
Corresponds to the WITSML property elevation
:
The gravity based elevation coordinate of this reference datum as measured from another datum. Positive moving upward from the elevation datum. An elevation should be given unless this is a vertical reference datum (e.g., sea level).
elevation
- The elevation to set.
May be null indicating absent or unknown.public Value getMd()
Corresponds to the WITSML property measuredDepth
:
The measured depth coordinate of this reference datum as measured from another datum. The measured depth datum should either be the same as the elevation datum or it should be relatable to the elevation datum through other datums. Positive moving toward the bottomhole from the measured depth datum. This should be given when a local reference is "downhole", such as a kickoff point or ocean bottom template, and the borehole may not be vertical. If a Depth is given then an Elevation should also be given.
public void setMd(Value md)
Corresponds to the WITSML property measuredDepth
:
The measured depth coordinate of this reference datum as measured from another datum. The measured depth datum should either be the same as the elevation datum or it should be relatable to the elevation datum through other datums. Positive moving toward the bottomhole from the measured depth datum. This should be given when a local reference is "downhole", such as a kickoff point or ocean bottom template, and the borehole may not be vertical. If a Depth is given then an Elevation should also be given.
md
- The md to set.
May be null indicating absent or unknown.public String getComment()
Corresponds to the WITSML property comment
:
A contextual description of the well reference datum.
public void setComment(String comment)
Corresponds to the WITSML property comment
:
A contextual description of the well reference datum.
comment
- The comment to set.
May be null indicating absent or unknown.public Boolean isDefaultMd()
Corresponds to the WITSML property defaultMeasuredDepth
:
True indicates that this is the default reference datum for measured depth coordinates. False or not given indicates that this is not the default reference datum. Measured depth coordinates that do not specify a datum reference should be assumed to be measured relative to this default reference datum. Only one reference datum may be designated as the default measured depth datum for each well. Values are "true" (or "1") and "false" ( or "0").
public void setDefaultMd(Boolean isDefaultMd)
Corresponds to the WITSML property defaultMeasuredDepth
:
True indicates that this is the default reference datum for measured depth coordinates. False or not given indicates that this is not the default reference datum. Measured depth coordinates that do not specify a datum reference should be assumed to be measured relative to this default reference datum. Only one reference datum may be designated as the default measured depth datum for each well. Values are "true" (or "1") and "false" ( or "0").
isDefaultMd
- The is default MD to set.
May be null indicating absent or unknown.public Boolean isDefaultTvd()
Corresponds to the WITSML property defaultVerticalDepth
:
True indicates that this is the default reference datum for vertical depth coordinates. False or not given indicates that this is not the default reference datum. Vertical depth coordinates that do not specify a datum reference should be assumed to be measured relative to the default reference datum. Only one reference datum may be designated as the default vertical depth datum for each well. Values are "true" (or "1") and "false" ( or "0").
public void setDefaultTvd(Boolean isDefaultTvd)
Corresponds to the WITSML property defaultVerticalDepth
:
True indicates that this is the default reference datum for vertical depth coordinates. False or not given indicates that this is not the default reference datum. Vertical depth coordinates that do not specify a datum reference should be assumed to be measured relative to the default reference datum. Only one reference datum may be designated as the default vertical depth datum for each well. Values are "true" (or "1") and "false" ( or "0").
isDefaultTvd
- The is default TVD to set.
May be null indicating absent or unknown.public Boolean isDefaultElevation()
Corresponds to the WITSML property defaultElevation
:
True indicates that this is the default reference datum for elevation coordinates. False or not given indicates that this is not the default reference datum. Elevation coordinates that do not specify a datum reference should be assumed to be measured relative to the default reference datum. Only one reference datum may be designated as the default elevation datum for each well. Values are "true" (or "1") and "false" ( or "0").
public void setDefaultElevation(Boolean isDefaultElevation)
Corresponds to the WITSML property defaultElevation
:
True indicates that this is the default reference datum for elevation coordinates. False or not given indicates that this is not the default reference datum. Elevation coordinates that do not specify a datum reference should be assumed to be measured relative to the default reference datum. Only one reference datum may be designated as the default elevation datum for each well. Values are "true" (or "1") and "false" ( or "0").
isDefaultElevation
- The is default elevation to set.
May be null indicating absent or unknown.Copyright © 2023 Petroware AS - https://petroware.no