Package org.rcsb.cif.model.generated

Class IhmModelingProtocol

java.lang.Object

org.rcsb.cif.model.BaseCategory

org.rcsb.cif.model.generated.IhmModelingProtocol

All Implemented Interfaces:

Category

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

Data items in the IHM_MODELING_PROTOCOL category records the step-wise details of the integrative modeling workflow.

Field Summary

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

isText, textFields

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
IntColumn	getDatasetGroupId()	An index for the dataset group being used in the modeling protocol.
StrColumn	getEnsembleFlag()	A flag to indicate if the modeling involves an ensemble.
StrColumn	getMultiScaleFlag()	A flag to indicate if the modeling is multi scale.
StrColumn	getMultiStateFlag()	A flag to indicate if the modeling is multi state.
IntColumn	getNumModelsBegin()	The number of models in the beginning of the step.
IntColumn	getNumModelsEnd()	The number of models at the end of the step.
StrColumn	getOrderedFlag()	A flag to indicate if the modeling involves an ensemble ordered by time or other order.
IntColumn	getOrdinalId()	A unique identifier for the modeling protocol/step combination.
IntColumn	getProtocolId()	An index for the modeling protocol carried out.
StrColumn	getProtocolName()	The name for the modeling protocol.
IntColumn	getScriptFileId()	The file id corresponding to the script used in the modeling protocol step.
IntColumn	getSoftwareId()	Identifier to the software used in the modeling protocol step.
IntColumn	getStepId()	An index for a particular step within the modeling protocol.
StrColumn	getStepMethod()	Description of the method involved in the modeling step.
StrColumn	getStepName()	The name or type of the modeling step.
StrColumn	getStructAssemblyDescription()	A textual description of the structural assembly being modeled.
IntColumn	getStructAssemblyId()	An index for the structural assembly being modeled.

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

IhmModelingProtocol

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

IhmModelingProtocol

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

IhmModelingProtocol

public IhmModelingProtocol(String name)

Method Detail

getOrdinalId

public IntColumn getOrdinalId()

A unique identifier for the modeling protocol/step combination.

Returns:

IntColumn

getProtocolId

public IntColumn getProtocolId()

An index for the modeling protocol carried out.

Returns:

IntColumn

getStepId

public IntColumn getStepId()

An index for a particular step within the modeling protocol.

Returns:

IntColumn

getStructAssemblyId

public IntColumn getStructAssemblyId()

An index for the structural assembly being modeled. This is an indicator to whether the whole assembly is modeled or if only a subset of the structural assembly is modeled. 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 is being modeled.

Returns:

IntColumn

getDatasetGroupId

public IntColumn getDatasetGroupId()

An index for the dataset group being used in the modeling protocol. This data item is a pointer to the _ihm_dataset_group.group_id in the IHM_DATASET_GROUP category.

Returns:

IntColumn

getStructAssemblyDescription

public StrColumn getStructAssemblyDescription()

A textual description of the structural assembly being modeled.

Returns:

StrColumn

getProtocolName

public StrColumn getProtocolName()

The name for the modeling protocol.

Returns:

StrColumn

getStepName

public StrColumn getStepName()

The name or type of the modeling step.

Returns:

StrColumn

getStepMethod

public StrColumn getStepMethod()

Description of the method involved in the modeling step.

Returns:

StrColumn

getNumModelsBegin

public IntColumn getNumModelsBegin()

The number of models in the beginning of the step.

Returns:

IntColumn

getNumModelsEnd

public IntColumn getNumModelsEnd()

The number of models at the end of the step.

Returns:

IntColumn

getMultiScaleFlag

public StrColumn getMultiScaleFlag()

A flag to indicate if the modeling is multi scale.

Returns:

StrColumn

getMultiStateFlag

public StrColumn getMultiStateFlag()

A flag to indicate if the modeling is multi state.

Returns:

StrColumn

getOrderedFlag

public StrColumn getOrderedFlag()

A flag to indicate if the modeling involves an ensemble ordered by time or other order.

Returns:

StrColumn

getEnsembleFlag

public StrColumn getEnsembleFlag()

A flag to indicate if the modeling involves an ensemble.

Returns:

StrColumn

getScriptFileId

public IntColumn getScriptFileId()

The file id corresponding to the script used in the modeling protocol step. This data item is a pointer to _ihm_external_files.id in the IHM_EXTERNAL_FILES category.

Returns:

IntColumn

getSoftwareId

public IntColumn getSoftwareId()

Identifier to the software used in the modeling protocol step. This data item is a pointer to the _software.pdbx_ordinal in the SOFTWARE category.

Returns:

IntColumn