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:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, DecimalStringWrapper, org.dcm4che.typeddicom.valuerepresentations.DoubleDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.FloatDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

public class WaterDepth
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Water Depth
Keyword: WaterDepth
Tag: (0016,0033)
Value Representation: DecimalString
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.Builder<SELF extends WaterDepth.Builder<SELF,T>,T extends WaterDepth.Holder>
static interface	WaterDepth.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Water Depth" (see WaterDepth)

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.DecimalStringWrapper

DecimalStringWrapper.Setter<B extends org.dcm4che.typeddicom.Builder<B,? extends org.dcm4che.typeddicom.AttributesWrapper>,D extends DecimalStringWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PRIVATE_CREATOR	The Private Creator associated with this class.
static int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.DecimalStringWrapper

VALUE_REPRESENTATION

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.
java.lang.String	getPrivateCreator()
int	getTag()

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, getKnownAttributeTags, getUnknownAttributeTags, 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.DecimalStringWrapper

getValueRepresentation

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 Detail

PRIVATE_CREATOR

public static final java.lang.String PRIVATE_CREATOR

The Private Creator associated with this class.

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

Constant Field Values

Constructor Detail

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 Detail

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.

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper