Package org.dcm4che.typeddicom.dataelements

Class DVHType

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DVHType

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class DVHType
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: DVH Type
Keyword: DVHType
Tag: (3004,0001)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT DVH Module > DVH Sequence > DVH Type
  as follows:
  Attribute Name: DVH Type
  Type: 1
  Attribute Description:

  Type of DVH.

  Enumerated Values:

  DIFFERENTIAL

  differential dose-volume histogram

  CUMULATIVE

  cumulative dose-volume histogram

  NATURAL

  natural dose volume histogram

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DVHType.Builder<SELF extends DVHType.Builder<SELF,T>,T extends DVHType.Holder>
static interface	DVHType.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "DVH Type" (see DVHType)
static class	DVHType.SimpleHolder

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

CodeStringWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends CodeStringWrapper>

Field Summary

Fields

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
DVHType()	Creates a new DVH Type object which wraps a new and empty Attributes object.
DVHType(org.dcm4che3.data.Attributes attributes)	Creates a new DVH Type object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
DVHType	copy()	Returns a new DVH Type which wraps a copy of the Attributes wrapped in this DVH Type.
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, isEmpty

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

getBytes, getSafeBytes, setBytes

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

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

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

getString, setString

Field Details

PRIVATE_CREATOR

public static final 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 Details

DVHType

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

Creates a new DVH Type object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

DVHType

public DVHType()

Creates a new DVH Type object which wraps a new and empty Attributes object.

Method Details

copy

public DVHType copy()

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

Returns:

a new DVH Type which wraps a copy of the Attributes wrapped in this DVH Type.

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.