Package org.rcsb.cif.model.generated

Class IhmGeometricObjectDistanceRestraint

  • All Implemented Interfaces:
    Category
    @Generated("org.rcsb.cif.generator.SchemaGenerator")
public class IhmGeometricObjectDistanceRestraint
extends BaseCategory
    Data items in the IHM_GEOMETRIC_OBJECT_DISTANCE_RESTRAINT category records the details of distance restraints involving geometric objects. If the geometric object involved is a plane, then the distance is along the normal following the right-hand rule. So for the xy plane, distance is along the z axis in the positive direction, 'above' the plane such that negative distances corresponded to positions below the plane.

    • Constructor Detail

      • IhmGeometricObjectDistanceRestraint

        public IhmGeometricObjectDistanceRestraint​(String name,
                                           Map<String,​Column> columns)

      • IhmGeometricObjectDistanceRestraint

        public IhmGeometricObjectDistanceRestraint​(String name,
                                           int rowCount,
                                           Object[] encodedColumns)

      • IhmGeometricObjectDistanceRestraint

        public IhmGeometricObjectDistanceRestraint​(String name)

    • Method Detail

      • getId

        public IntColumn getId()
        A unique id for the geometric object distance restraint.
        Returns:
        IntColumn

      • getObjectId

        public IntColumn getObjectId()
        Identifier to the geometric object involved in the distance restraint. This data item is a pointer to the _ihm_geometric_object_list.object_id in the IHM_GEOMETRIC_OBJECT_LIST category.
        Returns:
        IntColumn

      • getFeatureId

        public IntColumn getFeatureId()
        Identifier to the molecular feature involved in the distance restraint. This data item is a pointer to the _ihm_feature_list.feature_id in the IHM_FEATURE_LIST category.
        Returns:
        IntColumn

      • getObjectCharacteristic

        public StrColumn getObjectCharacteristic()
        The characteristic of the geometric object used in the restraint.
        Returns:
        StrColumn

      • getRestraintType

        public StrColumn getRestraintType()
        The type of restraint applied.
        Returns:
        StrColumn

      • getHarmonicForceConstant

        public FloatColumn getHarmonicForceConstant()
        The harmonic force constant, if applicable.
        Returns:
        FloatColumn

      • getGroupConditionality

        public StrColumn getGroupConditionality()
        If a group of atoms or residues are restrained, this data item defines the conditionality based on which the restraint is applied in the modeling.
        Returns:
        StrColumn

      • getDistanceLowerLimit

        public FloatColumn getDistanceLowerLimit()
        The lower limit to the distance threshold, if applicable.
        Returns:
        FloatColumn

      • getDistanceUpperLimit

        public FloatColumn getDistanceUpperLimit()
        The upper limit to the distance threshold, if applicable.
        Returns:
        FloatColumn

      • getDistanceLowerLimitEsd

        public FloatColumn getDistanceLowerLimitEsd()
        The estimated standard deviation of the lower limit distance threshold, if applicable.
        Returns:
        FloatColumn

      • getDistanceUpperLimitEsd

        public FloatColumn getDistanceUpperLimitEsd()
        The estimated standard deviation of the upper limit distance threshold, if applicable.
        Returns:
        FloatColumn

      • getDistanceProbability

        public FloatColumn getDistanceProbability()
        The real number that indicates the probability that the distance restraint is correct. This number should fall between 0.0 and 1.0.
        Returns:
        FloatColumn

      • getDatasetListId

        public IntColumn getDatasetListId()
        Identifier to the input data from which the restraint is derived. This data item is a pointer to the _ihm_dataset_list.id in the IHM_DATASET_LIST category.
        Returns:
        IntColumn

      • getOtherDetails

        public StrColumn getOtherDetails()
        Additional details about the geometric object distance restraints, especially if _ihm_geometric_object_distance_restraint.restraint_type or _ihm_geometric_object_distance_restraint.object_characteristic is "other".
        Returns:
        StrColumn