Package org.dcm4che.typeddicom.dataelements

Class SpecifiedChannelTotalTime

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SpecifiedChannelTotalTime

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DecimalStringWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, StringDataElementWrapper

public class SpecifiedChannelTotalTime
extends AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Specified Channel Total Time
Keyword: SpecifiedChannelTotalTime
Tag: (3008,0132)
Value Representation: DS
Value Multiplicity: 1

• Described in the contexts:
  • RT Brachy Session Record Module > Treatment Session Application Setup Sequence > Recorded Channel Sequence > Specified Channel Total Time
  as follows:
  Attribute Name: Specified Channel Total Time
  Type: 1
  Attribute Description:

  Total amount of time in seconds, scaled for the current source delivery strength and other delivery factors, specified to be delivered at the time of treatment between the first Control Point and the final Control Point for the current Channel.

  In the case of resuming a partially delivered treatment, the Specified Channel Total time will only include the remainder to be treated.

  See DICOM Standard Part 3 - Section C.8.8.22.2.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
SpecifiedChannelTotalTime()	Creates a new Specified Channel Total Time object which wraps a new and empty Attributes object.
SpecifiedChannelTotalTime(org.dcm4che3.data.Attributes attributes)	Creates a new Specified Channel Total Time object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
SpecifiedChannelTotalTime	copy()	Returns a new Specified Channel Total Time which wraps a copy of the Attributes wrapped in this Specified Channel Total Time.
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.DecimalStringWrapper

getValueRepresentation

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

getDouble, setDouble

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

getFloat, setFloat

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

getString, setString

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

SpecifiedChannelTotalTime

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

Creates a new Specified Channel Total Time object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

SpecifiedChannelTotalTime

public SpecifiedChannelTotalTime()

Creates a new Specified Channel Total Time object which wraps a new and empty Attributes object.

Method Details

copy

public SpecifiedChannelTotalTime copy()

Returns a new Specified Channel Total Time which wraps a copy of the Attributes wrapped in this Specified Channel Total Time. (see Attributes(Attributes)

Returns:

a new Specified Channel Total Time which wraps a copy of the Attributes wrapped in this Specified Channel Total Time.

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.