Package org.rcsb.cif.model.generated

Class IhmSasRestraint

java.lang.Object

org.rcsb.cif.model.BaseCategory

org.rcsb.cif.model.generated.IhmSasRestraint

All Implemented Interfaces:

Category

@Generated("org.rcsb.cif.generator.SchemaGenerator")
public class IhmSasRestraint
extends BaseCategory

Data items in the IHM_SAS_RESTRAINT category records the details of the SAS data used as restraints in the IHM modeling.

Field Summary

Fields inherited from class org.rcsb.cif.model.BaseCategory

isText, textFields

Constructor Summary

Constructors

Constructor	Description
IhmSasRestraint(String name)
IhmSasRestraint(String name, int rowCount, Object[] encodedColumns)
IhmSasRestraint(String name, Map<String,Column> columns)

Method Summary

Modifier and Type	Method	Description
FloatColumn	getChiValue()	The chi value resulting from fitting the model to the SAS data.
IntColumn	getDatasetListId()	Identifier to the SAS data used.
StrColumn	getDetails()	Additional details regarding the SAS restraint used.
StrColumn	getFittingAtomType()	The type of atoms in the model fit to the SAS data.
StrColumn	getFittingMethod()	The method used for fitting the model to the SAS data.
StrColumn	getFittingState()	An indicator to single or multiple state fitting.
IntColumn	getModelId()	The model number corresponding to the SAS fitting result presented.
IntColumn	getOrdinalId()	A unique identifier for the SAS restraint description.
StrColumn	getProfileSegmentFlag()	A flag that indicates whether or not the SAS profile is segmented i.e., whether the whole SAS profile is used or only a portion of it is used (by masking or by other means) as restraint in the modeling.
FloatColumn	getRadiusOfGyration()	Radius of gyration obtained from the SAS profile, if used as input restraint.
IntColumn	getStructAssemblyId()	An indicator to whether the whole assembly that is modeled is fit into the SAS data or if only a subset of the structural assembly is fit into the data.

Methods inherited from class org.rcsb.cif.model.BaseCategory

getBinaryColumn, getCategoryName, getColumn, getColumnNames, getRowCount, isDefined

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.rcsb.cif.model.Category

columnNames, columns, get

Constructor Detail

IhmSasRestraint

public IhmSasRestraint(String name,
                       Map<String,Column> columns)

IhmSasRestraint

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

IhmSasRestraint

public IhmSasRestraint(String name)

Method Detail

getOrdinalId

public IntColumn getOrdinalId()

A unique identifier for the SAS restraint description.

Returns:

IntColumn

getDatasetListId

public IntColumn getDatasetListId()

Identifier to the SAS data used. This data item is a pointer to the _ihm_dataset_list.id in the IHM_DATASET_LIST category.

Returns:

IntColumn

getModelId

public IntColumn getModelId()

The model number corresponding to the SAS fitting result presented. This data item is a pointer to _ihm_model_list.model_id in the IHM_MODEL_LIST category.

Returns:

IntColumn

getStructAssemblyId

public IntColumn getStructAssemblyId()

An indicator to whether the whole assembly that is modeled is fit into the SAS data or if only a subset of the structural assembly is fit into the data. This data item is a pointer to _ihm_struct_assembly.assembly_id in the IHM_STRUCT_ASSEMBLY category. The IHM_STRUCT_ASSEMBLY category provides the details regarding the different structural assemblies used in the modeling. The default value for this data item is "1" indicating that the entire assembly being modeled is fit into the SAS data.

Returns:

IntColumn

getProfileSegmentFlag

public StrColumn getProfileSegmentFlag()

A flag that indicates whether or not the SAS profile is segmented i.e., whether the whole SAS profile is used or only a portion of it is used (by masking or by other means) as restraint in the modeling.

Returns:

StrColumn

getFittingAtomType

public StrColumn getFittingAtomType()

The type of atoms in the model fit to the SAS data.

Returns:

StrColumn

getFittingMethod

public StrColumn getFittingMethod()

The method used for fitting the model to the SAS data.

Returns:

StrColumn

getFittingState

public StrColumn getFittingState()

An indicator to single or multiple state fitting.

Returns:

StrColumn

getRadiusOfGyration

public FloatColumn getRadiusOfGyration()

Radius of gyration obtained from the SAS profile, if used as input restraint.

Returns:

FloatColumn

getChiValue

public FloatColumn getChiValue()

The chi value resulting from fitting the model to the SAS data.

Returns:

FloatColumn

getDetails

public StrColumn getDetails()

Additional details regarding the SAS restraint used.

Returns:

StrColumn