Package org.dcm4che.typeddicom.dataelements

Class StageName

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.StageName

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class StageName
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: Stage Name
Keyword: StageName
Tag: (0008,2120)
Value Representation: SH
Value Multiplicity: 1

• Described in the contexts:
  • US Image Module > Stage Name
  as follows:
  Attribute Name: Stage Name
  Type: 3
  Attribute Description:

  A Stage is a particular time slice of a protocol in which a set of images are collected. The names can be free form text.

  Recommended text for Stress Echo stage names:

  PRE-EXERCISE

  POST-EXERCISE

  PEAK-EXERCISE

  RECOVERY

  BASELINE

  LOW DOSE

  PEAK DOSE

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

StageName

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

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

Parameters:

attributes - The Attributes object to be wrapped.

StageName

public StageName()

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

Method Details

copy

public StageName copy()

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

Returns:

a new Stage Name which wraps a copy of the Attributes wrapped in this Stage 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.