Package ffx.potential.parameters

Class BaseType

java.lang.Object

ffx.potential.parameters.BaseType

Direct Known Subclasses:

AngleTorsionType, AngleType, AtomType, BioType, BondType, ChargeType, ImproperTorsionType, MultipoleType, OutOfPlaneBendType, PiOrbitalTorsionType, PolarizeType, RelativeSolvationType, SoluteType, StretchBendType, StretchTorsionType, TorsionTorsionType, TorsionType, UreyBradleyType, VDWPairType, VDWType

public abstract class BaseType
extends Object

All force field types should extend the BaseType class.

Since:

1.0

Author:

Michael J. Schnieders

Field Summary

Fields

Modifier and Type	Field	Description
protected String	key	The look-up key for this term, which is usually a concatenation of atom classes or atom types.

Constructor Summary

Constructors

Constructor	Description
BaseType(ForceField.ForceFieldType forceFieldType, int[] keys)	Public constructor.
BaseType(ForceField.ForceFieldType forceFieldType, String key)	Public constructor.

Method Summary

Modifier and Type	Method	Description
String	getKey()	Get the key for this Type.
void	log()	Log this type.
void	print()	Print this to System.out.
void	setKey(int[] keys)	Setter for the field key.
void	setKey(String key)	Setter for the field key.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

key

protected String key

The look-up key for this term, which is usually a concatenation of atom classes or atom types.

Constructor Details

BaseType

public BaseType(ForceField.ForceFieldType forceFieldType,
 int[] keys)

Public constructor.

Parameters:

forceFieldType - a ForceField.ForceFieldType object.

keys - an array of int.

Since:

1.0

BaseType

public BaseType(ForceField.ForceFieldType forceFieldType,
 String key)

Public constructor.

Parameters:

forceFieldType - a ForceField.ForceFieldType object.

key - a String object.

Since:

1.0

Method Details

getKey

public String getKey()

Get the key for this Type.

Returns:

the key

Since:

1.0

setKey

public void setKey(int[] keys)

Setter for the field key.

Parameters:

keys - an array of int.

setKey

public void setKey(String key)

Setter for the field key.

Parameters:

key - a String object.

log

public void log()

Log this type.

Since:

1.0

print

public void print()

Print this to System.out.

Since:

1.0

toString

public String toString()

Basic toString method.

Overrides:

toString in class Object

Since:

1.0