Class TransverseSolenoid

java.lang.Object

cnuphys.magfield.MagneticField

cnuphys.magfield.Solenoid

cnuphys.magfield.TransverseSolenoid

All Implemented Interfaces:

IMagField

public class TransverseSolenoid
extends Solenoid

Field Summary

Fields inherited from class MagneticField

_interpolate, _scaleFactor, _shiftX, _shiftY, _shiftZ, angularUnit, avgField, field, fieldCoordinateSystem, fieldUnit, gridCoordinateSystem, highTime, lengthUnit, LOGGER, lowTime, MAGICNUMBER, maxField, maxFieldIndex, maxFieldLocation, maxVectorField, MISALIGNTOL, numFieldPoints, q1Coordinate, q2Coordinate, q3Coordinate, reserved3, reserved4, reserved5

Method Summary

Modifier and Type	Method	Description
boolean	contains(double x, double y, double z)	Checks whether the field boundary contain the given point.
static TransverseSolenoid	fromBinaryFile(File file)	Obtain a transverse solenoid object from a binary file.
String	getName()	Get the name of the field
boolean	isActive()	Checks this field active.
void	printConfiguration(PrintStream ps)	Print the current configuration
final String	toString()	Get some data as a string.

Methods inherited from class Solenoid

isZeroField

Methods inherited from class MagneticField

computeMaxField, fieldMagnitude, getB1, getB2, getB3, getBaseFileName, getBComponent, getCompositeIndex, getCoordinateIndices, getCreationDate, getFakeZMax, getLocation, getMaxFieldMagnitude, getPhiCoordinate, getQ1Coordinate, getQ2Coordinate, getQ3Coordinate, getRCoordinate, getRhoMax, getRhoMin, getScaleFactor, getShiftX, getShiftY, getShiftZ, getXCoordinate, getYCoordinate, getZCoordinate, getZMax, getZMin, isInterpolate, isMisaligned, isMisalignedX, isMisalignedY, isMisalignedZ, maxFieldMagnitude, readBinaryMagneticField, setCoordinateNames, setFakeZMax, setInterpolate, setScaleFactor, setShiftX, setShiftY, setShiftZ, setZeroField, squareMagnitude, vectorField, vectorToString

Methods inherited from class Object

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

Method Details

getName

public String getName()

Description copied from interface: IMagField

Get the name of the field

Specified by:

getName in interface IMagField

Overrides:

getName in class Solenoid

Returns:

the name, e.e. "Torus"

toString

public final String toString()

Get some data as a string.

Overrides:

toString in class MagneticField

Returns:

a string representation.

printConfiguration

public void printConfiguration(PrintStream ps)

Print the current configuration

Specified by:

printConfiguration in interface IMagField

Overrides:

printConfiguration in class Solenoid

Parameters:

ps - the print stream

isActive

public boolean isActive()

Checks this field active.

Overrides:

isActive in class Solenoid

Returns:

true if this field is active;

fromBinaryFile

public static TransverseSolenoid fromBinaryFile(File file)
                                         throws FileNotFoundException

Obtain a transverse solenoid object from a binary file.

Parameters:

file - the file to read

Returns:

the transverse solenoid object

Throws:

FileNotFoundException - the file not found exception

contains

public boolean contains(double x,
 double y,
 double z)

Checks whether the field boundary contain the given point.

Specified by:

contains in interface IMagField

Overrides:

contains in class MagneticField

Parameters:

x - the x coordinate in cm

y - the y coordinate in cm

z - the z coordinate in cm

Returns:

true if the field contains the given point