Package org.dcm4che.typeddicom.dataelements

Class SeriesNumber

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SeriesNumber

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, IntegerStringWrapper, StringDataElementWrapper

public class SeriesNumber
extends AbstractDataElementWrapper
implements IntegerStringWrapper

Name: Series Number
Keyword: SeriesNumber
Tag: (0020,0011)
Value Representation: IS
Value Multiplicity: 1

• Described in the contexts:
  • Key Object Document Series Module > Series Number
  as follows:
  Attribute Name: Series Number
  Type: 1
  Attribute Description:

  A number that identifies the Series.

  Note

  No specific semantics are specified.

  
  
• Described in the contexts:
  • Tractography Results Series Module > Series Number
  • XA/XRF Series Module > Series Number
  • Ophthalmic Tomography B-scan Volume Analysis Series Module > Series Number
  • Intravascular OCT Series Module > Series Number
  • Ophthalmic Tomography Series Module > Series Number
  • Microscopy Bulk Simple Annotations Series Module > Series Number
  • Ophthalmic Tomography En Face Series Module > Series Number
  as follows:
  Attribute Name: Series Number
  Type: 1
  Attribute Description:

  A number that identifies this Series.

  
  
• Described in the contexts:
  • General Series Module > Series Number
  • General Contributing Sources Macro > Contributing SOP Instances Reference Sequence > Referenced Series Sequence > Series Number
  • RT Series Module > Series Number
  as follows:
  Attribute Name: Series Number
  Type: 2
  Attribute Description:

  A number that identifies this Series.

  
  
• Described in the contexts:
  • Parametric Map Series Module > Series Number
  • Segmentation Series Module > Series Number
  as follows:
  Attribute Name: Series Number
  Type: 1
  Attribute Description:

  A number that identifies this Series

  
  
• Described in the contexts:
  • SR Document Series Module > Series Number
  as follows:
  Attribute Name: Series Number
  Type: 1
  Attribute Description:

  A number that identifies the Series.

  Note

  No SR-specific semantics are specified.

  
  
• Described in the contexts:
  • Enhanced Series Module > Series Number
  as follows:
  Attribute Name: Series Number
  Type: 1
  Attribute Description:

  A number that identifies this Series.

  Note

  1. The value of this Attribute should be unique for all Series in a Study created on the same equipment.

  2. Because Series can be created on more than one equipment, it can not be guaranteed that the value of Series Number (0020,0011) is unique in a Study.

  
  
• Described in the contexts:
  • Enhanced RT Series Module > Series Number
  as follows:
  Attribute Name: Series Number
  Type: 1
  Attribute Description:

  A number that identifies this series.

  
  
• Described in the contexts:
  • Encapsulated Document Series Module > Series Number
  as follows:
  Attribute Name: Series Number
  Type: 1
  Attribute Description:

  A number that identifies the Series.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
SeriesNumber()	Creates a new Series Number object which wraps a new and empty Attributes object.
SeriesNumber(org.dcm4che3.data.Attributes attributes)	Creates a new Series Number object which wraps the provided attributes.

Method Summary

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

getValueRepresentation

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

Constructor Details

SeriesNumber

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

Creates a new Series Number object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

SeriesNumber

public SeriesNumber()

Creates a new Series Number object which wraps a new and empty Attributes object.

Method Details

copy

public SeriesNumber copy()

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

Returns:

a new Series Number which wraps a copy of the Attributes wrapped in this Series Number.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.