Package org.dcm4che.typeddicom.dataelements

Class BlockName

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.BlockName

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class BlockName
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: Block Name
Keyword: BlockName
Tag: (300A,00FE)
Value Representation: LO
Value Multiplicity: 1

• Described in the contexts:
  • RT Beams Session Record Module > Treatment Session Beam Sequence > Recorded Block Sequence > Block Name
  as follows:
  Attribute Name: Block Name
  Type: 2
  Attribute Description:

  User-defined name for block.

  
  
• Described in the contexts:
  • RT Beams Module > Beam Sequence > Block Sequence > Block Name
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Recorded Block Sequence > Block Name
  • RT Image Module > Exposure Sequence > Block Sequence > Block Name
  • RT Ion Beams Module > Ion Beam Sequence > Ion Block Sequence > Block Name
  as follows:
  Attribute Name: Block Name
  Type: 3
  Attribute Description:

  User-defined name for block.

  
  

Nested Class Summary

Nested Classes

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

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.LongStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

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

getValueRepresentation

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

Constructor Details

BlockName

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

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

Parameters:

attributes - The Attributes object to be wrapped.

BlockName

public BlockName()

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

Method Details

copy

public BlockName copy()

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

Returns:

a new Block Name which wraps a copy of the Attributes wrapped in this Block Name.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.