edu.sdsc.mbt
Class Symmetry

java.lang.Object
  edu.sdsc.mbt.StructureComponent
      edu.sdsc.mbt.Symmetry

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class Symmetry

extends StructureComponent

implements java.lang.Cloneable, java.io.Serializable

Implements a StructureComponent container for Symmetry data.

See the "PROGRAMMING NOTE" section of the StructureComponent class.

Author:

John L. Moreland

See Also:

StructureComponent, Structure,

, Serialized Form

Field Summary

int	count The count of the number of symmetry copies.
double[][][]	matrix The symmetry matricies expressed as an array of 4x4 3D transforms.
java.lang.String	name The symmetry space group name.

Fields inherited from class edu.sdsc.mbt.StructureComponent

structure

Constructor Summary

Symmetry()
Creates a new Symmetry object.

Method Summary

java.lang.Object	clone() Clone this object.
void	copy(StructureComponent structureComponent) Copy all of the field values from the parameter object into "this".
static java.lang.String	getClassName() This method returns the fully qualified name of this class.
java.lang.String	getStructureComponentType() This method returns the fully qualified name of this class.
boolean	isVisible()

Methods inherited from class edu.sdsc.mbt.StructureComponent

getStructure, setStructure

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

The symmetry space group name. For example, "C 2", "I 2"

count

public int count

The count of the number of symmetry copies. For example, 6

matrix

public double[][][] matrix

The symmetry matricies expressed as an array of 4x4 3D transforms. For example, [1.0, 0.0, 0.0, 0.0] [0.0, 1.0, 0.0, 0.0] [0.0, 0.0, 1.0, 0.0] [0.0, 0.0, 0.0, 1.0] The 1st array index is the matrix number. The 2nd array index is the row number. The 3rd array index is the column number.

Constructor Detail

Symmetry

public Symmetry()

Creates a new Symmetry object.

Method Detail

copy

public void copy(StructureComponent structureComponent)

Copy all of the field values from the parameter object into "this".

Specified by:

copy in class StructureComponent

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone this object.

Overrides:

clone in class StructureComponent

Throws:

java.lang.CloneNotSupportedException

getClassName

public static java.lang.String getClassName()

Description copied from class: StructureComponent

This method returns the fully qualified name of this class. Sub-classes must override this method (This method should really be declared abstract, but unfortunately Java does not allow a method to be both static AND abstract). Instead, this base class implementation will through an UnsupportedOperationException.

This name is used by the StructureComponentRegistry class to enable dynamic registration and discovery of new StructureComponent sub-classes/types. The name is also used to create instances of any sublcass dynamically from this name.

getStructureComponentType

public java.lang.String getStructureComponentType()

This method returns the fully qualified name of this class.

Specified by:

getStructureComponentType in class StructureComponent

isVisible

public boolean isVisible()

Specified by:

isVisible in class StructureComponent