Package org.dcm4che.typeddicom.dataelements

Class FileSetID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.FileSetID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class FileSetID
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: File-set ID
Keyword: FileSetID
Tag: (0004,1130)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • File-Set Identification Module > File-set ID
  as follows:
  Attribute Name: File-set ID
  Type: 2
  Attribute Description:

  User or implementation specific Identifier (up to 16 characters). For definition, see PS3.10 PS3.10. The File-set ID is intended to be a short human readable label to easily (but not necessarily uniquely) identify a specific File-set to facilitate operator manipulation of the physical media on which the File-set is stored. Assignment of Value and semantics are environment specific.

  
  

Nested Class Summary

Nested Classes

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

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

Method Summary

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

FileSetID

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

Creates a new File-set ID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

FileSetID

public FileSetID()

Creates a new File-set ID object which wraps a new and empty Attributes object.

Method Details

copy

public FileSetID copy()

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

Returns:

a new File-set ID which wraps a copy of the Attributes wrapped in this File-set 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.