Package org.dcm4che.typeddicom.dataelements

Class StructureSetDescription

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.StructureSetDescription

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortTextWrapper, StringDataElementWrapper

public class StructureSetDescription
extends AbstractDataElementWrapper
implements ShortTextWrapper

Name: Structure Set Description
Keyword: StructureSetDescription
Tag: (3006,0006)
Value Representation: ST
Value Multiplicity: 1

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

  User-defined description for Structure Set.

  
  

Nested Class Summary

Nested Classes

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
StructureSetDescription	copy()	Returns a new Structure Set Description which wraps a copy of the Attributes wrapped in this Structure Set Description.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

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

getString, setString

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

StructureSetDescription

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

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

Parameters:

attributes - The Attributes object to be wrapped.

StructureSetDescription

public StructureSetDescription()

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

Method Details

copy

public StructureSetDescription copy()

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

Returns:

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

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.