Package pl.poznan.put.torsion

Class TorsionAngleDelta

java.lang.Object

pl.poznan.put.torsion.TorsionAngleDelta

All Implemented Interfaces:

DisplayableExportable

Direct Known Subclasses:

ImmutableTorsionAngleDelta

@Immutable
public abstract class TorsionAngleDelta
extends Object
implements DisplayableExportable

A result of subtracting of two torsion angles.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TorsionAngleDelta.State	A state of comparison of two torsion angle values.

Constructor Summary

Constructors

Constructor	Description
TorsionAngleDelta()

Method Summary

Modifier and Type	Method	Description
abstract MasterTorsionAngleType	angleType()
static TorsionAngleDelta	bothInvalidInstance(MasterTorsionAngleType masterType)	Creates an instance of torsion angle delta, where both input angles were invalid.
abstract Angle	delta()
String	exportName()
String	longDisplayName()
abstract RangeDifference	rangeDifference()
String	shortDisplayName()
abstract TorsionAngleDelta.State	state()
static TorsionAngleDelta	subtractTorsionAngleValues(MasterTorsionAngleType masterType, Angle target, Angle model)	Subtracts torsion angle values and creates an instance of this class.
String	toString(boolean isDisplayable)

Methods inherited from class java.lang.Object

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

Constructor Detail

TorsionAngleDelta

public TorsionAngleDelta()

Method Detail

bothInvalidInstance

public static TorsionAngleDelta bothInvalidInstance(MasterTorsionAngleType masterType)

Creates an instance of torsion angle delta, where both input angles were invalid.

Parameters:

masterType - The type of torsion angle.

Returns:

An instance indicating that both input angles were invalid.

subtractTorsionAngleValues

public static TorsionAngleDelta subtractTorsionAngleValues(MasterTorsionAngleType masterType,
                                                           Angle target,
                                                           Angle model)

Subtracts torsion angle values and creates an instance of this class.

Parameters:

masterType - The type of torsion angle.

target - The value of the first torsion angle.

model - The value of the second torsion angle.

Returns:

An instance of this class containing the result of subtraction.

angleType

@Parameter(order=1)
public abstract MasterTorsionAngleType angleType()

Returns:

The type of torsion angle.

state

@Parameter(order=2)
public abstract TorsionAngleDelta.State state()

Returns:

The state of comparison depending on whether the inputs were valid or not.

delta

@Parameter(order=3)
public abstract Angle delta()

Returns:

The actual result of subtraction.

rangeDifference

@Parameter(order=4)
public abstract RangeDifference rangeDifference()

Returns:

The difference in terms of ranges the angles belong to.

toString

public final String toString(boolean isDisplayable)

shortDisplayName

public final String shortDisplayName()

Specified by:

shortDisplayName in interface DisplayableExportable

Returns:

A short name to be shown in UI summary.

longDisplayName

public final String longDisplayName()

Specified by:

longDisplayName in interface DisplayableExportable

Returns:

A long name to be shown in UI, may contain Unicode.

exportName

public final String exportName()

Specified by:

exportName in interface DisplayableExportable

Returns:

A name to be used during export to output file, should be ASCII only.