Package org.dcm4che.typeddicom.dataelements

Class ImageBoxNumber

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ImageBoxNumber

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.IntDataElementWrapper, UnsignedShortWrapper

public class ImageBoxNumber
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Image Box Number
Keyword: ImageBoxNumber
Tag: (0072,0302)
Value Representation: UnsignedShort
Value Multiplicity: 1

• Described in the contexts:
  • Structured Display Image Box Module > Structured Display Image Box Sequence > Image Box Number
  as follows:
  Attribute Name: Image Box Number
  Type: 1
  Attribute Description:

  An integer that is unique across all Items of the Structured Display Image Box Sequence (0072,0422) that identifies the Image Box.

  
  
• Described in the contexts:
  • Hanging Protocol Display Module > Display Sets Sequence > Image Boxes Sequence > Image Box Number
  as follows:
  Attribute Name: Image Box Number
  Type: 1
  Attribute Description:

  A monotonically increasing integer that identifies the order of image boxes for scrolling, starting from 1, incrementing by 1, unique within a Display Sets Sequence (0072,0200) Item.

  
  

Nested Class Summary

Nested Classes

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

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

UnsignedShortWrapper.Setter<B extends org.dcm4che.typeddicom.Builder<B,? extends org.dcm4che.typeddicom.AttributesWrapper>,D extends UnsignedShortWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PRIVATE_CREATOR	The Private Creator associated with this class.
static int	TAG	The DICOM Tag associated with this class.

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ImageBoxNumber()	Creates a new Image Box Number object which wraps a new and empty Attributes object.
ImageBoxNumber(org.dcm4che3.data.Attributes attributes)	Creates a new Image Box Number object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ImageBoxNumber	copy()	Returns a new Image Box Number which wraps a copy of the Attributes wrapped in this Image Box Number.
java.lang.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.IntDataElementWrapper

getInt, setInt

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

getValueRepresentation

Field Detail

PRIVATE_CREATOR

public static final java.lang.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 Detail

ImageBoxNumber

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

Creates a new Image Box Number object which wraps the provided attributes.

Parameters:

attributes - the Attributes object to be wrapped.

ImageBoxNumber

public ImageBoxNumber()

Creates a new Image Box Number object which wraps a new and empty Attributes object.

Method Detail

copy

public ImageBoxNumber copy()

Returns a new Image Box Number which wraps a copy of the Attributes wrapped in this Image Box Number. (see Attributes(Attributes)

Returns:

a new Image Box Number which wraps a copy of the Attributes wrapped in this Image Box Number.

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper