Package org.dcm4che.typeddicom.dataelements

Class StructureSetLabel

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.StructureSetLabel

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class StructureSetLabel
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: Structure Set Label
Keyword: StructureSetLabel
Tag: (3006,0002)
Value Representation: SH
Value Multiplicity: 1

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

  User-defined label for Structure Set.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
StructureSetLabel()	Creates a new Structure Set Label object which wraps a new and empty Attributes object.
StructureSetLabel(org.dcm4che3.data.Attributes attributes)	Creates a new Structure Set Label object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
StructureSetLabel	copy()	Returns a new Structure Set Label which wraps a copy of the Attributes wrapped in this Structure Set Label.
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.ShortStringWrapper

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

StructureSetLabel

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

Creates a new Structure Set Label object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

StructureSetLabel

public StructureSetLabel()

Creates a new Structure Set Label object which wraps a new and empty Attributes object.

Method Details

copy

public StructureSetLabel copy()

Returns a new Structure Set Label which wraps a copy of the Attributes wrapped in this Structure Set Label. (see Attributes(Attributes)

Returns:

a new Structure Set Label which wraps a copy of the Attributes wrapped in this Structure Set Label.

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.