Package org.dcm4che.typeddicom.dataelements

Class RTSegmentAnnotationIndex

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RTSegmentAnnotationIndex

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class RTSegmentAnnotationIndex
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: RT Segment Annotation Index
Keyword: RTSegmentAnnotationIndex
Tag: (3010,003D)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • RT Segment Annotation Module > RT Segment Annotation Sequence > RT Segment Annotation Index
  as follows:
  Attribute Name: RT Segment Annotation Index
  Type: 1
  Attribute Description:

  Index of the Segment.

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

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RTSegmentAnnotationIndex.Builder<SELF extends RTSegmentAnnotationIndex.Builder<SELF,T>,T extends RTSegmentAnnotationIndex.Holder>
static interface	RTSegmentAnnotationIndex.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "RT Segment Annotation Index" (see RTSegmentAnnotationIndex)
static class	RTSegmentAnnotationIndex.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
RTSegmentAnnotationIndex()	Creates a new RT Segment Annotation Index object which wraps a new and empty Attributes object.
RTSegmentAnnotationIndex(org.dcm4che3.data.Attributes attributes)	Creates a new RT Segment Annotation Index object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
RTSegmentAnnotationIndex	copy()	Returns a new RT Segment Annotation Index which wraps a copy of the Attributes wrapped in this RT Segment Annotation Index.
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

RTSegmentAnnotationIndex

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

Creates a new RT Segment Annotation Index object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RTSegmentAnnotationIndex

public RTSegmentAnnotationIndex()

Creates a new RT Segment Annotation Index object which wraps a new and empty Attributes object.

Method Details

copy

public RTSegmentAnnotationIndex copy()

Returns a new RT Segment Annotation Index which wraps a copy of the Attributes wrapped in this RT Segment Annotation Index. (see Attributes(Attributes)

Returns:

a new RT Segment Annotation Index which wraps a copy of the Attributes wrapped in this RT Segment Annotation Index.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.