Package org.dcm4che.typeddicom.dataelements

Class PulseNumber

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.PulseNumber

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, UnsignedShortWrapper

public class PulseNumber
extends AbstractDataElementWrapper
implements UnsignedShortWrapper

Name: Pulse Number
Keyword: PulseNumber
Tag: (3008,0172)
Value Representation: US
Value Multiplicity: 1

• Described in the contexts:
  • RT Brachy Session Record Module > Treatment Session Application Setup Sequence > Recorded Channel Sequence > Pulse Specific Brachy Control Point Delivered Sequence > Pulse Number
  as follows:
  Attribute Name: Pulse Number
  Type: 1
  Attribute Description:

  Identification Number of this delivered Pulse.

  The pulse numbers for a treatment start at 1 and increase monotonically by 1. A given SOP Instance might only contain some of the pulses of the given treatment.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

getInt, setInt

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

getValueRepresentation

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

PulseNumber

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

Creates a new Pulse Number object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

PulseNumber

public PulseNumber()

Creates a new Pulse Number object which wraps a new and empty Attributes object.

Method Details

copy

public PulseNumber copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.