Package org.dcm4che.typeddicom.dataelements

Class ProtocolName

  • All Implemented Interfaces:
    org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, LongStringWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper
    public class ProtocolName
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements LongStringWrapper
    Name: Protocol Name
    Keyword: ProtocolName
    Tag: (0018,1030)
    Value Representation: LongString
    Value Multiplicity: 1
    • Described in the contexts: as follows:
      Attribute Name: Protocol Name
      Type: 1
      Attribute Description:

      Name for this Protocol.


    • Described in the contexts: as follows:
      Attribute Name: Protocol Name
      Type: 3
      Attribute Description:

      User-defined description of the conditions under which the Series was performed.

      Note

      This Attribute conveys Series-specific protocol identification and may or may not be identical to the protocol described in the Performed Protocol Code Sequence (0040,0260) in the Performed Protocol Code Sequence (0040,0260) in DICOM Standard Part 3 - Table 10-16.


    • Described in the contexts: as follows:
      Attribute Name: Protocol Name
      Type: 3
      Attribute Description:

      Description of the conditions under which the Series was performed.

      Note

      This may represent the type of analysis used in creation of the KO SOP Instances.


    • Described in the contexts: as follows:
      Attribute Name: Protocol Name
      Type: 1C
      Attribute Description:

      User-defined description of the conditions under which the Series was performed.

      Required if present and consistent in the contributing SOP Instances.

      Note

      This Attribute conveys Series-specific protocol identification and may or may not be identical to the one presented in the Performed Protocol Code Sequence (0040,0260).


    • Described in the contexts: as follows:
      Attribute Name: Protocol Name
      Type:
      Attribute Description:

      User-defined description of the conditions under which the Series was performed.

      Note

      This Attribute conveys Series-specific protocol identification and may or may not be identical to the one presented in the Performed Protocol Code Sequence (0040,0260).


    • Described in the contexts: as follows:
      Attribute Name: Protocol Name
      Type: 3
      Attribute Description:

      Description of the conditions under which the Series was performed.


    • Described in the contexts: as follows:
      Attribute Name: Protocol Name
      Type: 3
      Attribute Description:

      Description of the conditions under which the Series was performed.

      Note

      This may represent the type of analysis used in creation of the SR SOP Instances.


    • Constructor Summary

      Constructors 
      Constructor Description
      ProtocolName()
      Creates a new Protocol Name object which wraps a new and empty Attributes object.
      ProtocolName​(org.dcm4che3.data.Attributes attributes)
      Creates a new Protocol Name object which wraps the provided attributes.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ProtocolName copy()
      Returns a new Protocol Name which wraps a copy of the Attributes wrapped in this Protocol Name.
      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.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.StringDataElementWrapper

        getString, setString

    • Constructor Detail

      • ProtocolName

        public ProtocolName​(org.dcm4che3.data.Attributes attributes)
        Creates a new Protocol Name object which wraps the provided attributes.
        Parameters:
        attributes - the Attributes object to be wrapped.

      • ProtocolName

        public ProtocolName()
        Creates a new Protocol Name object which wraps a new and empty Attributes object.

    • Method Detail

      • copy

        public ProtocolName copy()
        Returns a new Protocol Name which wraps a copy of the Attributes wrapped in this Protocol Name. (see Attributes(Attributes)
        Returns:
        a new Protocol Name which wraps a copy of the Attributes wrapped in this Protocol Name.

      • 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