Package org.dcm4che.typeddicom.dataelements

Class ROINumber

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ROINumber

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, IntegerStringWrapper, StringDataElementWrapper

public class ROINumber
extends AbstractDataElementWrapper
implements IntegerStringWrapper

Name: ROI Number
Keyword: ROINumber
Tag: (3006,0022)
Value Representation: IS
Value Multiplicity: 1

• Described in the contexts:
  • Structure Set Module > Structure Set ROI Sequence > ROI Number
  as follows:
  Attribute Name: ROI Number
  Type: 1
  Attribute Description:

  Identification number of the ROI. The value of ROI Number (3006,0022) shall be unique within the Structure Set in which it is created.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ROINumber.Builder<SELF extends ROINumber.Builder<SELF,T>,T extends ROINumber.Holder>
static interface	ROINumber.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "ROI Number" (see ROINumber)
static class	ROINumber.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 String	PRIVATE_CREATOR	The Private Creator associated with this class.
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
ROINumber()	Creates a new ROI Number object which wraps a new and empty Attributes object.
ROINumber(org.dcm4che3.data.Attributes attributes)	Creates a new ROI Number object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ROINumber	copy()	Returns a new ROI Number which wraps a copy of the Attributes wrapped in this ROI Number.
String	getPrivateCreator()
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, 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

PRIVATE_CREATOR

public static final String PRIVATE_CREATOR

The Private Creator associated with this class.

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

ROINumber

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

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

Parameters:

attributes - The Attributes object to be wrapped.

ROINumber

public ROINumber()

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

Method Details

copy

public ROINumber copy()

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

Returns:

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

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.