public abstract class WitsmlRealtime extends WitsmlObject
Modifier and Type | Class and Description |
---|---|
static class |
WitsmlRealtime.Channel |
static class |
WitsmlRealtime.Header
WITSML realtime header component object.
|
Modifier and Type | Method and Description |
---|---|
abstract WitsmlRealtime.Channel |
addChannel() |
String |
getActivityCode()
Return the activity code of this realtime.
|
String |
getActivityDescription()
Return the activity description of this realtime.
|
List<WitsmlRealtime.Channel> |
getChannels()
Return the channels of this realtime.
|
String |
getGroupName()
Return the group name of this realtime.
|
WitsmlRealtime.Header |
getHeader()
Return the header of this realtime.
|
Value |
getMd()
Return the md of this realtime.
|
Integer |
getSequenceNumber()
Return the sequence number of this realtime.
|
Date |
getTime()
Return the time of this realtime.
|
abstract WitsmlRealtime.Header |
newHeader() |
void |
setActivityCode(String activityCode)
Set the activity code of this realtime.
|
void |
setActivityDescription(String activityDescription)
Set the activity description of this realtime.
|
void |
setGroupName(String groupName)
Set the group name of this realtime.
|
void |
setMd(Value md)
Set the md of this realtime.
|
void |
setSequenceNumber(Integer sequenceNumber)
Set the sequence number of this realtime.
|
void |
setTime(Date time)
Set the time of this realtime.
|
equals, getAddQuery, getAliases, getCitation, getCommonData, getEtpResource, getEtpServer, getId, getName, getParent, getParentId, getReadLock, getServer, getVersion, getWitsmlServer, getWitsmlType, getWriteLock, hashCode, newAliases, newCitation, newCommonData, setEtpResource, setName, toString
public Date getTime()
Corresponds to the WITSML property dTim
:
The time index for the realtime object if the interval type is time-based. It is the default time index for all data in the realtime object. Both dTim and md can be overridden at the channel level. This value should be given when "dTim" is given with any channel.
public void setTime(Date time)
Corresponds to the WITSML property dTim
:
The time index for the realtime object if the interval type is time-based. It is the default time index for all data in the realtime object. Both dTim and md can be overridden at the channel level. This value should be given when "dTim" is given with any channel.
time
- The time to set.
May be null indicating absent or unknown.public Value getMd()
Corresponds to the WITSML property md
:
Along hole measured depth of measurement from the drill datum. It is the default depth index for all data in the realtime object. Both dTim and md can be overridden at the channel level. This value should be given when "md" is given with any channel.
public void setMd(Value md)
Corresponds to the WITSML property md
:
Along hole measured depth of measurement from the drill datum. It is the default depth index for all data in the realtime object. Both dTim and md can be overridden at the channel level. This value should be given when "md" is given with any channel.
md
- The md to set.
May be null indicating absent or unknown.public Integer getSequenceNumber()
Corresponds to the WITSML property sequence
:
The 1-based sequence of realtime messages for one subscription. The first message for a subscription should have a sequence number of 1 and each subsequent message for that subscription should increment by one.
public void setSequenceNumber(Integer sequenceNumber)
Corresponds to the WITSML property sequence
:
The 1-based sequence of realtime messages for one subscription. The first message for a subscription should have a sequence number of 1 and each subsequent message for that subscription should increment by one.
sequenceNumber
- The sequence number to set.
May be null indicating absent or unknown.public String getActivityCode()
Corresponds to the WITSML property activityCode
:
A code used to define rig activity.
public void setActivityCode(String activityCode)
Corresponds to the WITSML property activityCode
:
A code used to define rig activity.
activityCode
- The activity code to set.
May be null indicating absent or unknown.public String getActivityDescription()
Corresponds to the WITSML property detailActivity
:
Custom string to further define an activity.
public void setActivityDescription(String activityDescription)
Corresponds to the WITSML property detailActivity
:
Custom string to further define an activity.
activityDescription
- The activity description to set.
May be null indicating absent or unknown.public String getGroupName()
Corresponds to the WITSML property dataGroup
:
The group name of the channels in this realtime. For example, a publisher can publish data from the mudlogger, drilling and MWD systems at the same time. The drilling and mudlogger systems could have channels with the same mnemonic. The group name is used to distinguish between curves from these different source systems.
public void setGroupName(String groupName)
Corresponds to the WITSML property dataGroup
:
The group name of the channels in this realtime. For example, a publisher can publish data from the mudlogger, drilling and MWD systems at the same time. The drilling and mudlogger systems could have channels with the same mnemonic. The group name is used to distinguish between curves from these different source systems.
groupName
- The group name to set.
May be null indicating absent or unknown.public WitsmlRealtime.Header getHeader()
Corresponds to the WITSML property realtimeHeader
:
The information which is constant for all realtimes. This will only be sent with the first realtime for a subscription, when a retransmit is requested or when the header is updated (e.g., when more channels are added).
public abstract WitsmlRealtime.Header newHeader()
public List<WitsmlRealtime.Channel> getChannels()
Corresponds to the WITSML property realtimeHeader
:
The information which is constant for all realtimes. This will only be sent with the first realtime for a subscription, when a retransmit is requested or when the header is updated (e.g., when more channels are added).
public abstract WitsmlRealtime.Channel addChannel()
Copyright © 2023 Petroware AS - https://petroware.no