Package org.dcm4che.typeddicom.dataelements

Class HPGLDocumentID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.HPGLDocumentID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class HPGLDocumentID
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: HPGL Document ID
Keyword: HPGLDocumentID
Tag: (0068,62D0)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • Generic Implant Template 2D Drawings Module > HPGL Document Sequence > HPGL Document ID
  as follows:
  Attribute Name: HPGL Document ID
  Type: 1
  Attribute Description:

  Identification number of the HPGL Document. Uniquely identifies an HPGL Document within this SOP Instance.

  The value shall start at 1, and increase monotonically by 1.

  
  

Nested Class Summary

Nested Classes

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

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

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

Field Summary

Fields

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
HPGLDocumentID()	Creates a new HPGL Document ID object which wraps a new and empty Attributes object.
HPGLDocumentID(org.dcm4che3.data.Attributes attributes)	Creates a new HPGL Document ID object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
HPGLDocumentID	copy()	Returns a new HPGL Document ID which wraps a copy of the Attributes wrapped in this HPGL Document ID.
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, getPrivateCreator, getValue

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

getInt, setInt

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

getValueRepresentation

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

HPGLDocumentID

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

Creates a new HPGL Document ID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

HPGLDocumentID

public HPGLDocumentID()

Creates a new HPGL Document ID object which wraps a new and empty Attributes object.

Method Details

copy

public HPGLDocumentID copy()

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

Returns:

a new HPGL Document ID which wraps a copy of the Attributes wrapped in this HPGL Document ID.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.