Enum CESymmParameters.SymmetryType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CESymmParameters.SymmetryType>
    Enclosing class:
    CESymmParameters

    public static enum CESymmParameters.SymmetryType
    extends java.lang.Enum<CESymmParameters.SymmetryType>
    The internal symmetry detection can be divided into two types: CLOSE: includes the circular and dihedral symmetries, and OPEN: includes the helical and protein repeats symmetries.

    All internal symmetry cases share one property: all the repeats have the same 3D transformation.

    AUTO option automatically identifies the type. The criterion for classification is that the CLOSE symmetry generates CeSymm alignments with circular permutations (2 blocks in AFPChain), whereas the OPEN symmetry generates alignments without a CP (only one block in AFPChain).

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AUTO  
      CLOSED  
      OPEN  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static CESymmParameters.SymmetryType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static CESymmParameters.SymmetryType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Method Detail

      • values

        public static CESymmParameters.SymmetryType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (CESymmParameters.SymmetryType c : CESymmParameters.SymmetryType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static CESymmParameters.SymmetryType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null