Package org.dcm4che.typeddicom.dataelements

Interface PerformedProtocolCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

EncapsulatedDocumentSeriesModule, EnhancedUSSeriesModule, GeneralSeriesModule, ImageAcquisitionResultsModule, RTSeriesModule, VisualFieldStaticPerimetryMeasurementsSeriesModule

All Known Implementing Classes:

AdvancedBlendingPresentationStateIOD, AmbulatoryECGIOD, ArterialPulseWaveformIOD, AutorefractionMeasurementsIOD, BasicCardiacElectrophysiologyWaveformIOD, BasicStructuredDisplayIOD, BasicVoiceAudioWaveformIOD, BlendingSoftcopyPresentationStateIOD, BodyPositionWaveformIOD, BreastProjectionXRayImageIOD, BreastTomosynthesisImageIOD, CArmPhotonElectronRadiationIOD, CArmPhotonElectronRadiationRecordIOD, ColorSoftcopyPresentationStateIOD, ContentAssessmentResultsIOD, ContributingSourcesSequence.Item, CornealTopographyMapIOD, CRImageIOD, CTImageIOD, CTPerformedProcedureProtocolIOD, DeformableSpatialRegistrationIOD, DermoscopicPhotographyImageIOD, DigitalIntraOralXRayImageIOD, DigitalMammographyXRayImageIOD, DigitalXRayImageIOD, ElectromyogramIOD, ElectrooculogramIOD, EncapsulatedCDAIOD, EncapsulatedMTLIOD, EncapsulatedOBJIOD, EncapsulatedPDFIOD, EncapsulatedSTLIOD, EnhancedCTImageIOD, EnhancedMRColorImageIOD, EnhancedMRImageIOD, EnhancedPETImageIOD, EnhancedUSVolumeIOD, EnhancedXAImageIOD, EnhancedXRFImageIOD, GeneralAudioWaveformIOD, GeneralECGIOD, GrayscaleSoftcopyPresentationStateIOD, HemodynamicWaveformIOD, IntraocularLensCalculationsIOD, IntravascularOpticalCoherenceTomographyImageIOD, KeratometryMeasurementsIOD, LegacyConvertedEnhancedCTImageIOD, LegacyConvertedEnhancedMRImageIOD, LegacyConvertedEnhancedPETImageIOD, LensometryMeasurementsIOD, MicroscopyBulkSimpleAnnotationsIOD, ModalityPerformedProcedureStepIOD, MRImageIOD, MRSpectroscopyIOD, MultiChannelRespiratoryWaveformIOD, MultiFrameGrayscaleByteSCImageIOD, MultiFrameGrayscaleWordSCImageIOD, MultiFrameSingleBitSCImageIOD, MultiFrameTrueColorSCImageIOD, NMImageIOD, OphthalmicAxialMeasurementsIOD, OphthalmicOpticalCoherenceTomographyBScanVolumeAnalysisIOD, OphthalmicOpticalCoherenceTomographyEnFaceImageIOD, OphthalmicPhotography16BitImageIOD, OphthalmicPhotography8BitImageIOD, OphthalmicThicknessMapIOD, OphthalmicTomographyImageIOD, OphthalmicVisualFieldStaticPerimetryMeasurementsIOD, ParametricMapIOD, PerformedProtocolCodeSequence.SimpleHolder, PETImageIOD, PlanarMPRVolumetricPresentationStateIOD, PseudoColorSoftcopyPresentationStateIOD, RawDataIOD, RealTimeAudioWaveformIOD, RealTimeVideoEndoscopicImageIOD, RealTimeVideoPhotographicImageIOD, RealWorldValueMappingIOD, RespiratoryWaveformIOD, RoboticArmRadiationIOD, RoboticArmRadiationRecordIOD, RoutineScalpElectroencephalogramIOD, RTBeamsDeliveryInstructionIOD, RTBeamsTreatmentRecordIOD, RTBrachyApplicationSetupDeliveryInstructionIOD, RTBrachyTreatmentRecordIOD, RTDoseIOD, RTImageIOD, RTIonBeamsTreatmentRecordIOD, RTIonPlanIOD, RTPhysicianIntentIOD, RTPlanIOD, RTRadiationRecordSetIOD, RTRadiationSalvageRecordIOD, RTRadiationSetDeliveryInstructionIOD, RTRadiationSetIOD, RTSegmentAnnotationIOD, RTStructureSetIOD, RTTreatmentPreparationIOD, RTTreatmentSummaryRecordIOD, SecondaryCaptureImageIOD, SegmentationIOD, SleepElectroencephalogramIOD, SpatialFiducialsIOD, SpatialRegistrationIOD, StereometricRelationshipIOD, SubjectiveRefractionMeasurementsIOD, SurfaceScanMeshIOD, SurfaceScanPointCloudIOD, SurfaceSegmentationIOD, TomotherapeuticRadiationIOD, TomotherapeuticRadiationRecordIOD, TractographyResultsIOD, TwelveLeadECGIOD, USImageIOD, USMultiFrameImageIOD, VideoEndoscopicImageIOD, VideoMicroscopicImageIOD, VideoPhotographicImageIOD, VisualAcuityMeasurementsIOD, VLEndoscopicImageIOD, VLMicroscopicImageIOD, VLPhotographicImageIOD, VLSlideCoordinatesMicroscopicImageIOD, VLWholeSlideMicroscopyImageIOD, VolumeRenderingVolumetricPresentationStateIOD, WideFieldOphthalmicPhotography3DCoordinatesImageIOD, WideFieldOphthalmicPhotographyStereographicProjectionImageIOD, XAPerformedProcedureProtocolIOD, XAXRFGrayscaleSoftcopyPresentationStateIOD, XRay3DAngiographicImageIOD, XRay3DCraniofacialImageIOD, XRayAngiographicImageIOD, XRayRadiofluoroscopicImageIOD

Enclosing class:

PerformedProtocolCodeSequence

public static interface PerformedProtocolCodeSequence.Holder
extends org.dcm4che.typeddicom.AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Performed Protocol Code Sequence" (see PerformedProtocolCodeSequence)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PerformedProtocolCodeSequence.Holder.Builder

Method Summary

Modifier and Type	Method	Description
static PerformedProtocolCodeSequence.Holder.Builder	builder()
static PerformedProtocolCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPerformedProtocolCodeSequence()
default PerformedProtocolCodeSequence	ensurePerformedProtocolCodeSequence()	Adds a new Performed Protocol Code Sequence (see PerformedProtocolCodeSequence) with initial capacity 1 (see ensurePerformedProtocolCodeSequence(int)) if it does not already exist.
default PerformedProtocolCodeSequence	ensurePerformedProtocolCodeSequence(int initialCapacity)	Adds a new Performed Protocol Code Sequence (see PerformedProtocolCodeSequence) if it does not already exist.
default PerformedProtocolCodeSequence	getPerformedProtocolCodeSequence()
default PerformedProtocolCodeSequence	newPerformedProtocolCodeSequence(int initialCapacity)	Adds a new Performed Protocol Code Sequence.
default void	removePerformedProtocolCodeSequence()	Removes the Performed Protocol Code Sequence (see PerformedProtocolCodeSequence
static PerformedProtocolCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

static PerformedProtocolCodeSequence.Holder wrap(org.dcm4che3.data.Attributes attributes)

Parameters:

attributes - an attributes object containing the Performed Protocol Code Sequence (see PerformedProtocolCodeSequence)

Returns:

a wrapper object implementing the PerformedProtocolCodeSequence.Holder interface.

builder

static PerformedProtocolCodeSequence.Holder.Builder builder()

Returns:

a PerformedProtocolCodeSequence.Holder.Builder to create Performed Protocol Code Sequence Items with a fluent API.

builder

static PerformedProtocolCodeSequence.Holder.Builder builder(org.dcm4che3.data.Attributes attributes)

Parameters:

attributes - the Attributes to be wrapped by the PerformedProtocolCodeSequence.Holder.Builder.

Returns:

a PerformedProtocolCodeSequence.Holder.Builder to create Performed Protocol Code Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getPerformedProtocolCodeSequence

default PerformedProtocolCodeSequence getPerformedProtocolCodeSequence()

Returns:

the Performed Protocol Code Sequence (see PerformedProtocolCodeSequence)

newPerformedProtocolCodeSequence

default PerformedProtocolCodeSequence newPerformedProtocolCodeSequence(int initialCapacity)

Adds a new Performed Protocol Code Sequence. (see PerformedProtocolCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new Performed Protocol Code Sequence

Returns:

the newly created PerformedProtocolCodeSequence.

ensurePerformedProtocolCodeSequence

default PerformedProtocolCodeSequence ensurePerformedProtocolCodeSequence(int initialCapacity)

Adds a new Performed Protocol Code Sequence (see PerformedProtocolCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Performed Protocol Code Sequence is created.

Returns:

either the already existing Performed Protocol Code Sequence (see PerformedProtocolCodeSequence) or a new one with capacity initialCapacity.

ensurePerformedProtocolCodeSequence

default PerformedProtocolCodeSequence ensurePerformedProtocolCodeSequence()

Adds a new Performed Protocol Code Sequence (see PerformedProtocolCodeSequence) with initial capacity 1 (see ensurePerformedProtocolCodeSequence(int)) if it does not already exist.

Returns:

either the already existing Performed Protocol Code Sequence (see PerformedProtocolCodeSequence) or a new one with capacity 1.

containsPerformedProtocolCodeSequence

default boolean containsPerformedProtocolCodeSequence()

Returns:

whether it contains the Performed Protocol Code Sequence (see PerformedProtocolCodeSequence)

removePerformedProtocolCodeSequence

default void removePerformedProtocolCodeSequence()

Removes the Performed Protocol Code Sequence (see PerformedProtocolCodeSequence