Package ffx.crystal

Class SpaceGroupDefinitions

java.lang.Object

ffx.crystal.SpaceGroupDefinitions

public class SpaceGroupDefinitions
extends Object

The SpaceGroupDefinitions class defines the 230 distinct space groups in three dimensions.

Since:

1.0

Author:

Michael J. Schnieders

See Also:

• • International Tables for Crystallography Volume A: Space-group symmetry
  • CCP4 Symlib

Method Summary

Modifier and Type	Method	Description
static SpaceGroup	spaceGroupFactory(int number)	Returns a SpaceGroup instance corresponding to the number parameter.
static SpaceGroup	spaceGroupFactory(String name)	Return a SpaceGroup based on its name.
static int	spaceGroupNumber(String name)	Returns the space group number for a given space group name.

Methods inherited from class java.lang.Object

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

Method Details

spaceGroupFactory

public static SpaceGroup spaceGroupFactory(int number)

Returns a SpaceGroup instance corresponding to the number parameter. If number is not between 1-230 inclusive then null is returned.

Parameters:

number - All 230 3D spacegroups are available.

Returns:

The space group corresponding to the given number.

Since:

1.0

spaceGroupFactory

public static SpaceGroup spaceGroupFactory(String name)

Return a SpaceGroup based on its name.

Parameters:

name - Available SpaceGroup names are given in the "spaceGroupName" array.

Returns:

The space group corresponding to the given number.

Since:

1.0

spaceGroupNumber

public static int spaceGroupNumber(String name)

Returns the space group number for a given space group name.

Parameters:

name - The space group name.

Returns:

The space group number.

Since:

1.0