Package org.rcsb.cif.model.generated

Class IhmMultiStateModeling

java.lang.Object

org.rcsb.cif.model.BaseCategory

org.rcsb.cif.model.generated.IhmMultiStateModeling

All Implemented Interfaces:

Category

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

Data items in the IHM_MULTI_STATE_MODELING category records the details of the multi-state modeling protocol, if applicable.

Field Summary

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

isText, textFields

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
StrColumn	getDetails()	Additional textual details of the multi-state modeling, if required.
StrColumn	getExperimentType()	The type of multi-state modeling experiment carried out.
IntColumn	getModelGroupId()	The model group id corresponding to the particular state in the multi-state model.
IntColumn	getOrdinalId()	A unique identifier for the multiple states being described.
FloatColumn	getPopulationFraction()	A fraction representing the population of the particular state.
FloatColumn	getPopulationFractionSd()	The standard deviation of the population fraction.
IntColumn	getStateGroupId()	An identifier for a collections of states in the multi-state modeling.
IntColumn	getStateId()	An identifier for the particular state in the multi-state modeling.
StrColumn	getStateName()	A descriptive name for the state.
StrColumn	getStateType()	The type that the multiple states being modeled belong to.

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

IhmMultiStateModeling

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

IhmMultiStateModeling

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

IhmMultiStateModeling

public IhmMultiStateModeling(String name)

Method Detail

getOrdinalId

public IntColumn getOrdinalId()

A unique identifier for the multiple states being described.

Returns:

IntColumn

getStateId

public IntColumn getStateId()

An identifier for the particular state in the multi-state modeling.

Returns:

IntColumn

getStateGroupId

public IntColumn getStateGroupId()

An identifier for a collections of states in the multi-state modeling. If the states do not need to be grouped into collections, then _ihm_multi_state_modeling.state_group_id is the same as _ihm_multi_state_modeling.state_id.

Returns:

IntColumn

getPopulationFraction

public FloatColumn getPopulationFraction()

A fraction representing the population of the particular state.

Returns:

FloatColumn

getPopulationFractionSd

public FloatColumn getPopulationFractionSd()

The standard deviation of the population fraction.

Returns:

FloatColumn

getStateType

public StrColumn getStateType()

The type that the multiple states being modeled belong to.

Returns:

StrColumn

getStateName

public StrColumn getStateName()

A descriptive name for the state.

Returns:

StrColumn

getModelGroupId

public IntColumn getModelGroupId()

The model group id corresponding to the particular state in the multi-state model. This data item is a pointer to _ihm_model_list.model_group_id in the IHM_MODEL_LIST category. If there is only a single model corresponding to a particular state, then the _ihm_model_list.model_group_id is the same as the _ihm_model_list.model_id.

Returns:

IntColumn

getExperimentType

public StrColumn getExperimentType()

The type of multi-state modeling experiment carried out.

Returns:

StrColumn

getDetails

public StrColumn getDetails()

Additional textual details of the multi-state modeling, if required.

Returns:

StrColumn