Package org.rcsb.cif.model.generated

Class IhmGeometricObjectTorus

java.lang.Object

org.rcsb.cif.model.BaseCategory

org.rcsb.cif.model.generated.IhmGeometricObjectTorus

All Implemented Interfaces:

Category

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

Data items in the IHM_GEOMETRIC_OBJECT_TORUS category records the parameters of a torus. By definition, the base plane of the torus is the XY plane. The `ihm_geometric_object_transformation` category can be used to generate transformations to any other plane.

Field Summary

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

isText, textFields

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
IntColumn	getCenterId()	Identifier to the description of the center.
FloatColumn	getMajorRadiusR()	Major radius "R" of the torus.
FloatColumn	getMinorRadiusR()	Minor radius "r" of the torus.
IntColumn	getObjectId()	Identifier to the geometric object.
IntColumn	getTransformationId()	Identifier to the description of the transformation.

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

IhmGeometricObjectTorus

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

IhmGeometricObjectTorus

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

IhmGeometricObjectTorus

public IhmGeometricObjectTorus(String name)

Method Detail

getObjectId

public IntColumn getObjectId()

Identifier to the geometric object. This data item is a pointer to the _ihm_geometric_object_list.object_id in the IHM_GEOMETRIC_OBJECT_LIST category.

Returns:

IntColumn

getCenterId

public IntColumn getCenterId()

Identifier to the description of the center. This data item is a pointer to the _ihm_geometric_object_center.id in the IHM_GEOMETRIC_OBJECT_CENTER category.

Returns:

IntColumn

getTransformationId

public IntColumn getTransformationId()

Identifier to the description of the transformation. This data item is a pointer to the _ihm_geometric_object_transformation.id in the IHM_GEOMETRIC_OBJECT_TRANSFORMATION category. If no transformation is provide, identity transformation is assumed.

Returns:

IntColumn

getMajorRadiusR

public FloatColumn getMajorRadiusR()

Major radius "R" of the torus.

Returns:

FloatColumn

getMinorRadiusR

public FloatColumn getMinorRadiusR()

Minor radius "r" of the torus.

Returns:

FloatColumn