Package org.dcm4che.typeddicom.dataelements

Class ROIName

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ROIName

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class ROIName
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: ROI Name
Keyword: ROIName
Tag: (3006,0026)
Value Representation: LO
Value Multiplicity: 1

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

  User-defined name for ROI.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ROIName()	Creates a new ROI Name object which wraps a new and empty Attributes object.
ROIName(org.dcm4che3.data.Attributes attributes)	Creates a new ROI Name object which wraps the provided attributes.

Method Summary

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

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

ROIName

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

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

Parameters:

attributes - The Attributes object to be wrapped.

ROIName

public ROIName()

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

Method Details

copy

public ROIName copy()

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

Returns:

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

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.