Package org.dcm4che.typeddicom.dataelements

Class WaterDepth

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.WaterDepth

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DecimalStringWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, StringDataElementWrapper

public class WaterDepth
extends AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Water Depth
Keyword: WaterDepth
Tag: (0016,0033)
Value Representation: DS
Value Multiplicity: 1

• Described in the contexts:
  • VL Photographic Acquisition Module > Water Depth
  as follows:
  Attribute Name: Water Depth
  Type: 3
  Attribute Description:

  The water depth at the time of acquisition, in m.

  When the value is negative, the absolute value of it indicates the height (elevation) above the water level.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WaterDepth.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Water Depth" (see WaterDepth)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

Constructor	Description
WaterDepth()	Creates a new Water Depth object which wraps a new and empty Attributes object.
WaterDepth(org.dcm4che3.data.Attributes attributes)	Creates a new Water Depth object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
WaterDepth	copy()	Returns a new Water Depth which wraps a copy of the Attributes wrapped in this Water Depth.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

Methods inherited from class org.dcm4che.typeddicom.AbstractDataElementWrapper

equals, exists, getValue, hashCode, toString

Methods inherited from class org.dcm4che.typeddicom.AbstractAttributesWrapper

getAttributes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper

getBytes, getSafeBytes, setBytes

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.DoubleDataElementWrapper

getDouble, setDouble

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.FloatDataElementWrapper

getFloat, setFloat

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

getString, setString

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

WaterDepth

public WaterDepth(org.dcm4che3.data.Attributes attributes)

Creates a new Water Depth object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

WaterDepth

public WaterDepth()

Creates a new Water Depth object which wraps a new and empty Attributes object.

Method Details

copy

public WaterDepth copy()

Returns a new Water Depth which wraps a copy of the Attributes wrapped in this Water Depth. (see Attributes(Attributes)

Returns:

a new Water Depth which wraps a copy of the Attributes wrapped in this Water Depth.

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.