Class StandardSolenoid

java.lang.Object

cnuphys.magfield.MagneticField

cnuphys.magfield.Solenoid

cnuphys.magfield.StandardSolenoid

All Implemented Interfaces:

IMagField

public final class StandardSolenoid
extends Solenoid

The Class Solenoid.

Version:

1.0

Author:

Sebouh Paul

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
static StandardSolenoid	fromBinaryFile(File file)	Obtain a solenoid object from a binary file, probably "clas12_solenoid_fieldmap_binary.dat"
String	getName()	Get the name of the field
boolean	isActive()	Checks this field active.
static void	main(String[] arg)	main method used for testing.
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, contains, 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

isActive

public boolean isActive()

Checks this field active.

Overrides:

isActive in class Solenoid

Returns:

true if this field is active;

fromBinaryFile

public static StandardSolenoid fromBinaryFile(File file)
                                       throws FileNotFoundException

Obtain a solenoid object from a binary file, probably "clas12_solenoid_fieldmap_binary.dat"

Parameters:

file - the file to read

Returns:

the solenoid object

Throws:

FileNotFoundException - the file not found exception

getName

public String getName()

Get the name of the field

Specified by:

getName in interface IMagField

Overrides:

getName in class Solenoid

Returns:

the name

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

main

public static void main(String[] arg)

main method used for testing.

Parameters:

arg - command line arguments