Package org.dcm4che.typeddicom.dataelements

Class InstructionDescription

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.InstructionDescription

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, StringDataElementWrapper, UnlimitedTextWrapper

public class InstructionDescription
extends AbstractDataElementWrapper
implements UnlimitedTextWrapper

Name: Instruction Description
Keyword: InstructionDescription
Tag: (0018,9917)
Value Representation: UT
Value Multiplicity: 1

• Described in the contexts:
  • Patient Positioning Module > Patient Positioning Instruction Sequence > Instruction Description
  • Instructions Module > Instruction Sequence > Instruction Description
  as follows:
  Attribute Name: Instruction Description
  Type: 3
  Attribute Description:

  A detailed description explaining what should be done.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

getString, setString

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.UnlimitedTextWrapper

getValueRepresentation

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

InstructionDescription

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

Creates a new Instruction Description object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

InstructionDescription

public InstructionDescription()

Creates a new Instruction Description object which wraps a new and empty Attributes object.

Method Details

copy

public InstructionDescription copy()

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

Returns:

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

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.