Class SecStrucElement


  • public class SecStrucElement
    extends java.lang.Object
    A secondary structure element (SSE) is an object representing a block of sequential residues that share the same secondary structure type.
    Since:
    4.1.1
    Author:
    Aleix Lafita
    • Constructor Detail

      • SecStrucElement

        public SecStrucElement​(SecStrucType type,
                               ResidueNumber start,
                               ResidueNumber end,
                               int length,
                               int index,
                               java.lang.String chainID)
        Create a new SSE object. The start and end residue numbers cannot be the same.
        Parameters:
        type - object describing the type of SS
        start - first residue of the SSE
        end - final residue of the SSE
        length - number of residues included in the SSE
        index -
        chainID - the chain ID
    • Method Detail

      • getIndex

        public int getIndex()
        Returns the index of the SSE for its type. This is, the sequential position of this SSE relative to the other SSE of the same type.
        Returns:
      • getLength

        public int getLength()
        Return the length (number of residues) in the SSE.
        Returns:
      • getId

        public java.lang.String getId()
        Returns the ID of this element. The ID is the concatenation of the type letter and the numerical element identifier (e.g. H1, S1, ...).
        Returns:
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object