Package org.dcm4che.typeddicom.dataelements

Class StartingRespiratoryPhase

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.StartingRespiratoryPhase

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class StartingRespiratoryPhase
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Starting Respiratory Phase
Keyword: StartingRespiratoryPhase
Tag: (0020,9247)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Respiratory Synchronization Macro > Respiratory Synchronization Sequence > Starting Respiratory Phase
  as follows:
  Attribute Name: Starting Respiratory Phase
  Type: 1C
  Attribute Description:

  The phase of respiration at which the Starting Respiratory Amplitude (0020,9246) was measured.

  Enumerated Values:

  INSPIRATION

  MAXIMUM

  EXPIRATION

  MINIMUM

  Required if Starting Respiratory Amplitude (0020,9246) is present.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
StartingRespiratoryPhase()	Creates a new Starting Respiratory Phase object which wraps a new and empty Attributes object.
StartingRespiratoryPhase(org.dcm4che3.data.Attributes attributes)	Creates a new Starting Respiratory Phase object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
StartingRespiratoryPhase	copy()	Returns a new Starting Respiratory Phase which wraps a copy of the Attributes wrapped in this Starting Respiratory Phase.
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.valuerepresentations.CodeStringWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

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

StartingRespiratoryPhase

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

Creates a new Starting Respiratory Phase object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

StartingRespiratoryPhase

public StartingRespiratoryPhase()

Creates a new Starting Respiratory Phase object which wraps a new and empty Attributes object.

Method Details

copy

public StartingRespiratoryPhase copy()

Returns a new Starting Respiratory Phase which wraps a copy of the Attributes wrapped in this Starting Respiratory Phase. (see Attributes(Attributes)

Returns:

a new Starting Respiratory Phase which wraps a copy of the Attributes wrapped in this Starting Respiratory Phase.

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.