Package org.dcm4che.typeddicom.dataelements

Class StudyID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.StudyID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class StudyID
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: Study ID
Keyword: StudyID
Tag: (0020,0010)
Value Representation: SH
Value Multiplicity: 1

• Described in the contexts:
  • Image Acquisition Results Module > Study ID
  as follows:
  Attribute Name: Study ID
  Type:
  Attribute Description:

  User or equipment generated Study Identifier.

  
  
• Described in the contexts:
  • General Study Module > Study ID
  as follows:
  Attribute Name: Study ID
  Type: 2
  Attribute Description:

  User or equipment generated Study identifier.

  
  

Nested Class Summary

Nested Classes

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

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

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

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
StudyID()	Creates a new Study ID object which wraps a new and empty Attributes object.
StudyID(org.dcm4che3.data.Attributes attributes)	Creates a new Study ID object which wraps the provided attributes.

Method Summary

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

StudyID

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

Creates a new Study ID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

StudyID

public StudyID()

Creates a new Study ID object which wraps a new and empty Attributes object.

Method Details

copy

public StudyID copy()

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

Returns:

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

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.