Package org.dcm4che.typeddicom.dataelements

Class EncapsulatedDocumentLength

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.EncapsulatedDocumentLength

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedLongWrapper

public class EncapsulatedDocumentLength
extends AbstractDataElementWrapper
implements UnsignedLongWrapper

Name: Encapsulated Document Length
Keyword: EncapsulatedDocumentLength
Tag: (0042,0015)
Value Representation: UL
Value Multiplicity: 1

• Described in the contexts:
  • Encapsulated Document Module > Encapsulated Document Length
  as follows:
  Attribute Name: Encapsulated Document Length
  Type: 3
  Attribute Description:

  The length of the Encapsulated Document stream, not including any trailing padding added for encapsulation as a DICOM object.

  If present, shall be equal to the Value Length if even, or one less than the Value Length if odd.

  Note

  In the absence of this Attribute, the value of Encapsulated Document (0042,0011) may have been padded to even length as required for all DICOM Data Element Values, so it would not be possible to extract the original unpadded document if it were of odd length.

  
  

Nested Class Summary

Nested Classes

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

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

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

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.UnsignedLongWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
EncapsulatedDocumentLength()	Creates a new Encapsulated Document Length object which wraps a new and empty Attributes object.
EncapsulatedDocumentLength(org.dcm4che3.data.Attributes attributes)	Creates a new Encapsulated Document Length object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
EncapsulatedDocumentLength	copy()	Returns a new Encapsulated Document Length which wraps a copy of the Attributes wrapped in this Encapsulated Document Length.
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.DataElementWrapper

exists, getValue

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

getInt, setInt

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

getValueRepresentation

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

EncapsulatedDocumentLength

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

Creates a new Encapsulated Document Length object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

EncapsulatedDocumentLength

public EncapsulatedDocumentLength()

Creates a new Encapsulated Document Length object which wraps a new and empty Attributes object.

Method Details

copy

public EncapsulatedDocumentLength copy()

Returns a new Encapsulated Document Length which wraps a copy of the Attributes wrapped in this Encapsulated Document Length. (see Attributes(Attributes)

Returns:

a new Encapsulated Document Length which wraps a copy of the Attributes wrapped in this Encapsulated Document Length.

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.