Package org.dcm4che.typeddicom.dataelements

Class InstructionText

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.InstructionText

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class InstructionText
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: Instruction Text
Keyword: InstructionText
Tag: (0018,9916)
Value Representation: LO
Value Multiplicity: 1

• Described in the contexts:
  • Instructions Module > Instruction Sequence > Instruction Text
  as follows:
  Attribute Name: Instruction Text
  Type: 1
  Attribute Description:

  A short displayable string indicating what should be done.

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

  A displayable string explaining what should be done.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InstructionText.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Instruction Text" (see InstructionText)

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
InstructionText()	Creates a new Instruction Text object which wraps a new and empty Attributes object.
InstructionText(org.dcm4che3.data.Attributes attributes)	Creates a new Instruction Text object which wraps the provided attributes.

Method Summary

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

InstructionText

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

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

Parameters:

attributes - The Attributes object to be wrapped.

InstructionText

public InstructionText()

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

Method Details

copy

public InstructionText copy()

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

Returns:

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

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.