Package etomica.space1d

Class Orientation1D

java.lang.Object

etomica.space1d.Orientation1D

All Implemented Interfaces:

IOrientation

public class Orientation1D
extends java.lang.Object
implements IOrientation

Orientation in a 1-dimensional space. Only two values are possible, indicating one of two directions. Value of orientation is given as +1 or -1.

Constructor Summary

Constructors

Constructor	Description
Orientation1D()	Construct with default orientation of +1.

Method Summary

Modifier and Type	Method	Description
void	E(IOrientation o)	Copies the given orientation to this one.
Vector	getDirection()
void	randomRotation(IRandom random, double theta)	Sets orientation randomly to be +1 or -1.
void	setDirection(Vector newDirection)	Sets this orientation to point in the given direction.

Methods inherited from class java.lang.Object

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

Constructor Detail

Orientation1D

public Orientation1D()

Construct with default orientation of +1.

Method Detail

E

public void E(IOrientation o)

Description copied from interface: IOrientation

Copies the given orientation to this one.

Specified by:

E in interface IOrientation

Parameters:

o - the new orientation

getDirection

public Vector getDirection()

Specified by:

getDirection in interface IOrientation

setDirection

public void setDirection(Vector newDirection)

Description copied from interface: IOrientation

Sets this orientation to point in the given direction.

Specified by:

setDirection in interface IOrientation

Parameters:

newDirection - the new direction for this orientation

randomRotation

public void randomRotation(IRandom random,
                           double theta)

Sets orientation randomly to be +1 or -1.

Specified by:

randomRotation in interface IOrientation

Parameters:

random - used to generate random value to set orientation

theta - is ignored