Package org.dcm4che.typeddicom.iods

Class HangingProtocolIOD

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractInformationObjectDefinition

org.dcm4che.typeddicom.iods.HangingProtocolIOD

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, AuthorizationEquipmentCertificationNumber.Holder, BarcodeValue.Holder, CodingSchemeIdentificationSequence.Holder, ContentQualification.Holder, ContextGroupIdentificationSequence.Holder, ContributingEquipmentSequence.Holder, ConversionSourceAttributesSequence.Holder, DigitalSignaturesSequence.Holder, DisplaySetsSequence.Holder, EncryptedAttributesSequence.Holder, HangingProtocolCreationDateTime.Holder, HangingProtocolCreator.Holder, HangingProtocolDefinitionSequence.Holder, HangingProtocolDescription.Holder, HangingProtocolLevel.Holder, HangingProtocolName.Holder, HangingProtocolUserGroupName.Holder, HangingProtocolUserIdentificationCodeSequence.Holder, HL7StructuredDocumentReferenceSequence.Holder, ImageSetsSequence.Holder, InstanceCoercionDateTime.Holder, InstanceCreationDate.Holder, InstanceCreationTime.Holder, InstanceCreatorUID.Holder, InstanceNumber.Holder, InstanceOriginStatus.Holder, LongitudinalTemporalInformationModified.Holder, MACParametersSequence.Holder, MappingResourceIdentificationSequence.Holder, NavigationIndicatorSequence.Holder, NominalScreenDefinitionSequence.Holder, NumberOfPriorsReferenced.Holder, NumberOfScreens.Holder, OriginalAttributesSequence.Holder, OriginalSpecializedSOPClassUID.Holder, PartialDataDisplayHandling.Holder, PrivateDataElementCharacteristicsSequence.Holder, QueryRetrieveView.Holder, ReferencedDefinedProtocolSequence.Holder, ReferencedPerformedProtocolSequence.Holder, RelatedGeneralSOPClassUID.Holder, SOPAuthorizationComment.Holder, SOPAuthorizationDateTime.Holder, SOPClassUID.Holder, SOPInstanceStatus.Holder, SOPInstanceUID.Holder, SourceHangingProtocolSequence.Holder, SpecificCharacterSet.Holder, SynchronizedScrollingSequence.Holder, TimezoneOffsetFromUTC.Holder, HangingProtocolDefinitionModule, HangingProtocolDisplayModule, HangingProtocolEnvironmentModule, SOPCommonModule

public class HangingProtocolIOD
extends org.dcm4che.typeddicom.AbstractInformationObjectDefinition
implements SOPCommonModule, HangingProtocolDefinitionModule, HangingProtocolEnvironmentModule, HangingProtocolDisplayModule

Name: Hanging Protocol IOD
Description:

A Hanging Protocol entity specifies the viewing preferences of a specific user or group, for a specific type of Study (Modality, Anatomy, Laterality combination, and optionally Procedure, and/or Reason), that may be exchanged between connecting devices that claim conformance to the DICOM Standard. The Hanging Protocol contains information about the Hanging Protocol, the creator, the type of Study it addresses, the type of image sets to display, the intended display environment, and the intended layout for the screen(s).

See Also:

DICOM Standard Part 3 - Hanging Protocol IOD

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HangingProtocolIOD.Builder

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.modules.HangingProtocolDefinitionModule

HangingProtocolDefinitionModule.SimpleWrapper

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.modules.HangingProtocolDisplayModule

HangingProtocolDisplayModule.SimpleWrapper

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.modules.HangingProtocolEnvironmentModule

HangingProtocolEnvironmentModule.SimpleWrapper

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.modules.SOPCommonModule

SOPCommonModule.SimpleWrapper

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.Set<org.dcm4che.typeddicom.SOPClass>	STANDARD_SOP_CLASSES

Constructor Summary

Constructors

Constructor	Description
HangingProtocolIOD()
HangingProtocolIOD(org.dcm4che3.data.Attributes attributes)

Method Summary

Modifier and Type	Method	Description
static HangingProtocolIOD.Builder	builder()
static HangingProtocolIOD.Builder	builder(org.dcm4che3.data.Attributes attributes)
java.util.Set<org.dcm4che.typeddicom.SOPClass>	getStandardSOPClasses()

Methods inherited from class org.dcm4che.typeddicom.AbstractAttributesWrapper

equals, getAttributes, hashCode, toString

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.dataelements.AuthorizationEquipmentCertificationNumber.Holder

containsAuthorizationEquipmentCertificationNumber, getAuthorizationEquipmentCertificationNumber, removeAuthorizationEquipmentCertificationNumber

Methods inherited from interface org.dcm4che.typeddicom.dataelements.BarcodeValue.Holder

containsBarcodeValue, getBarcodeValue, removeBarcodeValue

Methods inherited from interface org.dcm4che.typeddicom.dataelements.CodingSchemeIdentificationSequence.Holder

containsCodingSchemeIdentificationSequence, ensureCodingSchemeIdentificationSequence, ensureCodingSchemeIdentificationSequence, getCodingSchemeIdentificationSequence, newCodingSchemeIdentificationSequence, removeCodingSchemeIdentificationSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.ContentQualification.Holder

containsContentQualification, getContentQualification, removeContentQualification

Methods inherited from interface org.dcm4che.typeddicom.dataelements.ContextGroupIdentificationSequence.Holder

containsContextGroupIdentificationSequence, ensureContextGroupIdentificationSequence, ensureContextGroupIdentificationSequence, getContextGroupIdentificationSequence, newContextGroupIdentificationSequence, removeContextGroupIdentificationSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.ContributingEquipmentSequence.Holder

containsContributingEquipmentSequence, ensureContributingEquipmentSequence, ensureContributingEquipmentSequence, getContributingEquipmentSequence, newContributingEquipmentSequence, removeContributingEquipmentSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.ConversionSourceAttributesSequence.Holder

containsConversionSourceAttributesSequence, ensureConversionSourceAttributesSequence, ensureConversionSourceAttributesSequence, getConversionSourceAttributesSequence, newConversionSourceAttributesSequence, removeConversionSourceAttributesSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.DigitalSignaturesSequence.Holder

containsDigitalSignaturesSequence, ensureDigitalSignaturesSequence, ensureDigitalSignaturesSequence, getDigitalSignaturesSequence, newDigitalSignaturesSequence, removeDigitalSignaturesSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.DisplaySetsSequence.Holder

containsDisplaySetsSequence, ensureDisplaySetsSequence, ensureDisplaySetsSequence, getDisplaySetsSequence, newDisplaySetsSequence, removeDisplaySetsSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.EncryptedAttributesSequence.Holder

containsEncryptedAttributesSequence, ensureEncryptedAttributesSequence, ensureEncryptedAttributesSequence, getEncryptedAttributesSequence, newEncryptedAttributesSequence, removeEncryptedAttributesSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.HangingProtocolCreationDateTime.Holder

containsHangingProtocolCreationDateTime, getHangingProtocolCreationDateTime, removeHangingProtocolCreationDateTime

Methods inherited from interface org.dcm4che.typeddicom.dataelements.HangingProtocolCreator.Holder

containsHangingProtocolCreator, getHangingProtocolCreator, removeHangingProtocolCreator

Methods inherited from interface org.dcm4che.typeddicom.dataelements.HangingProtocolDefinitionSequence.Holder

containsHangingProtocolDefinitionSequence, ensureHangingProtocolDefinitionSequence, ensureHangingProtocolDefinitionSequence, getHangingProtocolDefinitionSequence, newHangingProtocolDefinitionSequence, removeHangingProtocolDefinitionSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.HangingProtocolDescription.Holder

containsHangingProtocolDescription, getHangingProtocolDescription, removeHangingProtocolDescription

Methods inherited from interface org.dcm4che.typeddicom.dataelements.HangingProtocolLevel.Holder

containsHangingProtocolLevel, getHangingProtocolLevel, removeHangingProtocolLevel

Methods inherited from interface org.dcm4che.typeddicom.dataelements.HangingProtocolName.Holder

containsHangingProtocolName, getHangingProtocolName, removeHangingProtocolName

Methods inherited from interface org.dcm4che.typeddicom.dataelements.HangingProtocolUserGroupName.Holder

containsHangingProtocolUserGroupName, getHangingProtocolUserGroupName, removeHangingProtocolUserGroupName

Methods inherited from interface org.dcm4che.typeddicom.dataelements.HangingProtocolUserIdentificationCodeSequence.Holder

containsHangingProtocolUserIdentificationCodeSequence, ensureHangingProtocolUserIdentificationCodeSequence, ensureHangingProtocolUserIdentificationCodeSequence, getHangingProtocolUserIdentificationCodeSequence, newHangingProtocolUserIdentificationCodeSequence, removeHangingProtocolUserIdentificationCodeSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.HL7StructuredDocumentReferenceSequence.Holder

containsHL7StructuredDocumentReferenceSequence, ensureHL7StructuredDocumentReferenceSequence, ensureHL7StructuredDocumentReferenceSequence, getHL7StructuredDocumentReferenceSequence, newHL7StructuredDocumentReferenceSequence, removeHL7StructuredDocumentReferenceSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.ImageSetsSequence.Holder

containsImageSetsSequence, ensureImageSetsSequence, ensureImageSetsSequence, getImageSetsSequence, newImageSetsSequence, removeImageSetsSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InstanceCoercionDateTime.Holder

containsInstanceCoercionDateTime, getInstanceCoercionDateTime, removeInstanceCoercionDateTime

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InstanceCreationDate.Holder

containsInstanceCreationDate, getInstanceCreationDate, removeInstanceCreationDate

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InstanceCreationTime.Holder

containsInstanceCreationTime, getInstanceCreationTime, removeInstanceCreationTime

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InstanceCreatorUID.Holder

containsInstanceCreatorUID, getInstanceCreatorUID, removeInstanceCreatorUID

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InstanceNumber.Holder

containsInstanceNumber, getInstanceNumber, removeInstanceNumber

Methods inherited from interface org.dcm4che.typeddicom.dataelements.InstanceOriginStatus.Holder

containsInstanceOriginStatus, getInstanceOriginStatus, removeInstanceOriginStatus

Methods inherited from interface org.dcm4che.typeddicom.dataelements.LongitudinalTemporalInformationModified.Holder

containsLongitudinalTemporalInformationModified, getLongitudinalTemporalInformationModified, removeLongitudinalTemporalInformationModified

Methods inherited from interface org.dcm4che.typeddicom.dataelements.MACParametersSequence.Holder

containsMACParametersSequence, ensureMACParametersSequence, ensureMACParametersSequence, getMACParametersSequence, newMACParametersSequence, removeMACParametersSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.MappingResourceIdentificationSequence.Holder

containsMappingResourceIdentificationSequence, ensureMappingResourceIdentificationSequence, ensureMappingResourceIdentificationSequence, getMappingResourceIdentificationSequence, newMappingResourceIdentificationSequence, removeMappingResourceIdentificationSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.NavigationIndicatorSequence.Holder

containsNavigationIndicatorSequence, ensureNavigationIndicatorSequence, ensureNavigationIndicatorSequence, getNavigationIndicatorSequence, newNavigationIndicatorSequence, removeNavigationIndicatorSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.NominalScreenDefinitionSequence.Holder

containsNominalScreenDefinitionSequence, ensureNominalScreenDefinitionSequence, ensureNominalScreenDefinitionSequence, getNominalScreenDefinitionSequence, newNominalScreenDefinitionSequence, removeNominalScreenDefinitionSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.NumberOfPriorsReferenced.Holder

containsNumberOfPriorsReferenced, getNumberOfPriorsReferenced, removeNumberOfPriorsReferenced

Methods inherited from interface org.dcm4che.typeddicom.dataelements.NumberOfScreens.Holder

containsNumberOfScreens, getNumberOfScreens, removeNumberOfScreens

Methods inherited from interface org.dcm4che.typeddicom.dataelements.OriginalAttributesSequence.Holder

containsOriginalAttributesSequence, ensureOriginalAttributesSequence, ensureOriginalAttributesSequence, getOriginalAttributesSequence, newOriginalAttributesSequence, removeOriginalAttributesSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.OriginalSpecializedSOPClassUID.Holder

containsOriginalSpecializedSOPClassUID, getOriginalSpecializedSOPClassUID, removeOriginalSpecializedSOPClassUID

Methods inherited from interface org.dcm4che.typeddicom.dataelements.PartialDataDisplayHandling.Holder

containsPartialDataDisplayHandling, getPartialDataDisplayHandling, removePartialDataDisplayHandling

Methods inherited from interface org.dcm4che.typeddicom.dataelements.PrivateDataElementCharacteristicsSequence.Holder

containsPrivateDataElementCharacteristicsSequence, ensurePrivateDataElementCharacteristicsSequence, ensurePrivateDataElementCharacteristicsSequence, getPrivateDataElementCharacteristicsSequence, newPrivateDataElementCharacteristicsSequence, removePrivateDataElementCharacteristicsSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.QueryRetrieveView.Holder

containsQueryRetrieveView, getQueryRetrieveView, removeQueryRetrieveView

Methods inherited from interface org.dcm4che.typeddicom.dataelements.ReferencedDefinedProtocolSequence.Holder

containsReferencedDefinedProtocolSequence, ensureReferencedDefinedProtocolSequence, ensureReferencedDefinedProtocolSequence, getReferencedDefinedProtocolSequence, newReferencedDefinedProtocolSequence, removeReferencedDefinedProtocolSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.ReferencedPerformedProtocolSequence.Holder

containsReferencedPerformedProtocolSequence, ensureReferencedPerformedProtocolSequence, ensureReferencedPerformedProtocolSequence, getReferencedPerformedProtocolSequence, newReferencedPerformedProtocolSequence, removeReferencedPerformedProtocolSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.RelatedGeneralSOPClassUID.Holder

containsRelatedGeneralSOPClassUID, getRelatedGeneralSOPClassUID, removeRelatedGeneralSOPClassUID

Methods inherited from interface org.dcm4che.typeddicom.dataelements.SOPAuthorizationComment.Holder

containsSOPAuthorizationComment, getSOPAuthorizationComment, removeSOPAuthorizationComment

Methods inherited from interface org.dcm4che.typeddicom.dataelements.SOPAuthorizationDateTime.Holder

containsSOPAuthorizationDateTime, getSOPAuthorizationDateTime, removeSOPAuthorizationDateTime

Methods inherited from interface org.dcm4che.typeddicom.dataelements.SOPClassUID.Holder

containsSOPClassUID, getSOPClassUID, removeSOPClassUID

Methods inherited from interface org.dcm4che.typeddicom.dataelements.SOPInstanceStatus.Holder

containsSOPInstanceStatus, getSOPInstanceStatus, removeSOPInstanceStatus

Methods inherited from interface org.dcm4che.typeddicom.dataelements.SOPInstanceUID.Holder

containsSOPInstanceUID, getSOPInstanceUID, removeSOPInstanceUID

Methods inherited from interface org.dcm4che.typeddicom.dataelements.SourceHangingProtocolSequence.Holder

containsSourceHangingProtocolSequence, ensureSourceHangingProtocolSequence, ensureSourceHangingProtocolSequence, getSourceHangingProtocolSequence, newSourceHangingProtocolSequence, removeSourceHangingProtocolSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.SpecificCharacterSet.Holder

containsSpecificCharacterSet, getSpecificCharacterSet, removeSpecificCharacterSet

Methods inherited from interface org.dcm4che.typeddicom.dataelements.SynchronizedScrollingSequence.Holder

containsSynchronizedScrollingSequence, ensureSynchronizedScrollingSequence, ensureSynchronizedScrollingSequence, getSynchronizedScrollingSequence, newSynchronizedScrollingSequence, removeSynchronizedScrollingSequence

Methods inherited from interface org.dcm4che.typeddicom.dataelements.TimezoneOffsetFromUTC.Holder

containsTimezoneOffsetFromUTC, getTimezoneOffsetFromUTC, removeTimezoneOffsetFromUTC

Field Detail

STANDARD_SOP_CLASSES

public static final java.util.Set<org.dcm4che.typeddicom.SOPClass> STANDARD_SOP_CLASSES

Constructor Detail

HangingProtocolIOD

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

HangingProtocolIOD

public HangingProtocolIOD()

Method Detail

builder

public static HangingProtocolIOD.Builder builder()

Returns:

a HangingProtocolIOD.Builder to create Hanging Protocol IODs with a fluent API.

builder

public static HangingProtocolIOD.Builder builder(org.dcm4che3.data.Attributes attributes)

Parameters:

attributes - the Attributes to be wrapped by the HangingProtocolIOD.Builder.

Returns:

a HangingProtocolIOD.Builder to create Hanging Protocol IOD Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getStandardSOPClasses

public java.util.Set<org.dcm4che.typeddicom.SOPClass> getStandardSOPClasses()

Specified by:

getStandardSOPClasses in class org.dcm4che.typeddicom.AbstractInformationObjectDefinition