Package org.rcsb.cif.model.generated

Class IhmDerivedDistanceRestraint

  • All Implemented Interfaces:
    Category
    @Generated("org.rcsb.cif.generator.SchemaGenerator")
public class IhmDerivedDistanceRestraint
extends BaseCategory
    Data items in the IHM_DERIVED_DISTANCE_RESTRAINT category records the list of distance restraints used in the integrative modeling experiment. These distance redistance restraints may be derived from various kinds of experiments.

    • Constructor Detail

      • IhmDerivedDistanceRestraint

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

      • IhmDerivedDistanceRestraint

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

      • IhmDerivedDistanceRestraint

        public IhmDerivedDistanceRestraint​(String name)

    • Method Detail

      • getId

        public IntColumn getId()
        A unique identifier for the derived distance restraint.
        Returns:
        IntColumn

      • getGroupId

        public IntColumn getGroupId()
        An identifier to group the distance restraints. This can be the same as the _ihm_derived_distance_restraint.id in case the some of the restraints are not grouped.
        Returns:
        IntColumn

      • getFeatureId1

        public IntColumn getFeatureId1()
        The feature identifier for the first partner in the distance restraint. This data item is a pointer to _ihm_feature_list.feature_id in the IHM_FEATURE_LIST category.
        Returns:
        IntColumn

      • getFeatureId2

        public IntColumn getFeatureId2()
        The feature identifier for the second partner in the distance restraint. This data item is a pointer to _ihm_feature_list.feature_id in the IHM_FEATURE_LIST category.
        Returns:
        IntColumn

      • 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

      • getRandomExclusionFraction

        public FloatColumn getRandomExclusionFraction()
        The fraction of randomly excluded distance restraints during modeling. In HADDOCK, this is used along with ambiguous interface restraints (AIRs) to account for uncertainties in AIRs.
        Returns:
        FloatColumn

      • getDistanceLowerLimit

        public FloatColumn getDistanceLowerLimit()
        The lower limit to the distance threshold applied to this distance restraint in the integrative modeling task.
        Returns:
        FloatColumn

      • getDistanceUpperLimit

        public FloatColumn getDistanceUpperLimit()
        The upper limit to the distance threshold applied to this distance restraint in the integrative modeling task.
        Returns:
        FloatColumn

      • getDistanceLowerLimitEsd

        public FloatColumn getDistanceLowerLimitEsd()
        The estimated standard deviation of the lower limit distance threshold applied to this distance restraint in the integrative modeling task.
        Returns:
        FloatColumn

      • getDistanceUpperLimitEsd

        public FloatColumn getDistanceUpperLimitEsd()
        The estimated standard deviation of the upper limit distance threshold applied to this distance restraint in the integrative modeling task.
        Returns:
        FloatColumn

      • getProbability

        public FloatColumn getProbability()
        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

      • getRestraintType

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

      • getDatasetListId

        public IntColumn getDatasetListId()
        Identifier to the input data from which the distance restraint is derived. This data item is a pointer to the _ihm_dataset_list.id in the IHM_DATASET_LIST category. This data item may not be applicable for all cases. For example, in case of ambiguous interface restraints where the interface residues are identified from multiple experiments, the reference to the _ihm_dataset_list.id is handled in the IHM_INTERFACE_RESIDUE_FEATURE category rather than here.
        Returns:
        IntColumn