Package org.dcm4che.typeddicom.dataelements

Class RetrieveAETitle

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RetrieveAETitle

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, ApplicationEntityMultiWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementMultiWrapper

public class RetrieveAETitle
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements ApplicationEntityMultiWrapper

Name: Retrieve AE Title
Keyword: RetrieveAETitle
Tag: (0008,0054)
Value Representation: ApplicationEntity
Value Multiplicity: 1-n

• Described in the contexts:
  • Storage Commitment Module > Retrieve AE Title
  as follows:
  Attribute Name: Retrieve AE Title
  Type:
  Attribute Description:

  Application Entity Title where the SOP Instance(s) may be retrieved via a network based retrieve service.

  
  
• Described in the contexts:
  • Referenced Instances and Access Macro > DICOM Retrieval Sequence > Retrieve AE Title
  as follows:
  Attribute Name: Retrieve AE Title
  Type: 1
  Attribute Description:

  Title of a DICOM Application Entity where the referenced Instance(s) may be retrieved on the network.

  
  
• Described in the contexts:
  • Instance Availability Notification Module > Referenced Series Sequence > Referenced SOP Sequence > Retrieve AE Title
  as follows:
  Attribute Name: Retrieve AE Title
  Type:
  Attribute Description:

  Title of the DICOM Application Entity from which the referenced Instance may or may not be retrievable, i.e., the scope for which Instance Availability (0008,0056) applies. See DICOM Standard Part 3 - Section C.4.23.1.1.

  
  
• Described in the contexts:
  • Access End Points Macro > Retrieve AE Title
  as follows:
  Attribute Name: Retrieve AE Title
  Type: 3
  Attribute Description:

  AE Title end point from which SOP Instances may be retrieved using a C-MOVE or C-GET based SOP Class (see PS3.4 PS3.4). This AE Title is used together with one or more of Referenced SOP Instance UID (0008,1155), Study Instance UID (0020,000D), and/or and Series Instance UID (0020,000E) values.

  
  
• Described in the contexts:
  • Hierarchical Series Reference Macro > Retrieve AE Title
  as follows:
  Attribute Name: Retrieve AE Title
  Type: 3
  Attribute Description:

  Title of the DICOM Application Entity where the Composite Object(s) may be retrieved on the network.

  
  
• Described in the contexts:
  • Inventory Creation Module > Retrieve AE Title
  as follows:
  Attribute Name: Retrieve AE Title
  Type:
  Attribute Description:

  AE Title from which the Inventory SOP Instance may be retrieved through Inventory MOVE or Inventory GET SOP Classes (see PS3.4 chapterJJ).

  
  
• Described in the contexts:
  • Inventory Module > Inventoried Studies Sequence > Retrieve AE Title
  as follows:
  Attribute Name: Retrieve AE Title
  Type: 1C
  Attribute Description:

  AE Title from which this Study may be retrieved.

  Required if Study SOP Instances may be retrieved using a C-MOVE or C-GET based SOP Class (see PS3.4) and Study Access End Points Sequence (0008,0421) does not include Retrieve AE Title (0008,0054). May be present otherwise.

  
  
• Described in the contexts:
  • Storage Commitment Module > Referenced SOP Sequence > Retrieve AE Title
  as follows:
  Attribute Name: Retrieve AE Title
  Type:
  Attribute Description:

  Application Entity Title from which the SOP Instance may be retrieved via a network based retrieve service.

  
  
• Described in the contexts:
  • Image Acquisition Results Module > Performed Series Sequence > Retrieve AE Title
  as follows:
  Attribute Name: Retrieve AE Title
  Type:
  Attribute Description:

  Title of the DICOM Application Entity where the Images and other Composite SOP Instances in this Series may be retrieved on the network.

  Note

  The duration for which this location remains valid is unspecified.

  
  

Nested Class Summary

Nested Classes

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

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

ApplicationEntityMultiWrapper.Setter<B extends org.dcm4che.typeddicom.Builder<B,? extends org.dcm4che.typeddicom.AttributesWrapper>,D extends ApplicationEntityMultiWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PRIVATE_CREATOR	The Private Creator associated with this class.
static int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.ApplicationEntityMultiWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
RetrieveAETitle()	Creates a new Retrieve AE Title object which wraps a new and empty Attributes object.
RetrieveAETitle(org.dcm4che3.data.Attributes attributes)	Creates a new Retrieve AE Title object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
RetrieveAETitle	copy()	Returns a new Retrieve AE Title which wraps a copy of the Attributes wrapped in this Retrieve AE Title.
java.lang.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.valuerepresentations.ApplicationEntityMultiWrapper

getValueRepresentation

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

getString, getString, getStrings, setStrings

Field Detail

PRIVATE_CREATOR

public static final java.lang.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 Detail

RetrieveAETitle

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

Creates a new Retrieve AE Title object which wraps the provided attributes.

Parameters:

attributes - the Attributes object to be wrapped.

RetrieveAETitle

public RetrieveAETitle()

Creates a new Retrieve AE Title object which wraps a new and empty Attributes object.

Method Detail

copy

public RetrieveAETitle copy()

Returns a new Retrieve AE Title which wraps a copy of the Attributes wrapped in this Retrieve AE Title. (see Attributes(Attributes)

Returns:

a new Retrieve AE Title which wraps a copy of the Attributes wrapped in this Retrieve AE Title.

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper