Package cern.accsoft.steering.aloha.read.yasp

Class YaspCorrectorKickDataReader

java.lang.Object

cern.accsoft.steering.util.meas.read.yasp.YaspFileReader

cern.accsoft.steering.aloha.read.yasp.YaspCorrectorKickDataReader

All Implemented Interfaces:

CorrectorKickDataReader, ReadingDataReader

public class YaspCorrectorKickDataReader
extends YaspFileReader
implements CorrectorKickDataReader

this class represents a reader for CorrectorKickData as generated by Yasp

Constructor Summary

Constructors

Constructor	Description
YaspCorrectorKickDataReader()

Method Summary

Modifier and Type	Method	Description
static java.lang.String	constructFileName(java.lang.String correctorName, cern.accsoft.steering.jmad.tools.response.DeflectionSign sign, boolean gzip)	constructs fileName from correctorName and sign.
static java.lang.String	constructFileName(java.lang.String correctorName, cern.accsoft.steering.jmad.tools.response.DeflectionSign sign, java.lang.Integer measurementNumber, boolean gzip)	constructs fileName from correctorName, sign and (optional) measurement-number
static java.lang.String	constructFileName(java.lang.String correctorName, Plane plane, cern.accsoft.steering.jmad.tools.response.DeflectionSign sign, java.lang.Integer measurementNumber, boolean gzip)	constructs a fileName from correctornamen, plane, sign and measurement number
static boolean	isCorrectorFile(java.lang.String fileName)	checks if the given fileName is ad Yasp-Corrector file
CorrectorKickData	read(java.io.File file, ReadSelectionFilter selection, MeasurementReaderOptions options)	reads the data from files.

Methods inherited from class cern.accsoft.steering.util.meas.read.yasp.YaspFileReader

parseCorrectorLine, parseMonitorLine, read, read, read

Methods inherited from class java.lang.Object

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

Constructor Detail

YaspCorrectorKickDataReader

public YaspCorrectorKickDataReader()

Method Detail

read

public CorrectorKickData read(java.io.File file,
                              ReadSelectionFilter selection,
                              MeasurementReaderOptions options)
                       throws YaspReaderException

reads the data from files.

Specified by:

read in interface CorrectorKickDataReader

Returns:

the CorrectorKickData

Throws:

YaspReaderException

constructFileName

public static java.lang.String constructFileName(java.lang.String correctorName,
                                                 cern.accsoft.steering.jmad.tools.response.DeflectionSign sign,
                                                 java.lang.Integer measurementNumber,
                                                 boolean gzip)

constructs fileName from correctorName, sign and (optional) measurement-number

Parameters:

correctorName - The Corrector Name (including plane - token)

sign - the sign

measurementNumber - the measurement number

Returns:

the Filename (without path)

constructFileName

public static java.lang.String constructFileName(java.lang.String correctorName,
                                                 cern.accsoft.steering.jmad.tools.response.DeflectionSign sign,
                                                 boolean gzip)

constructs fileName from correctorName and sign.

Parameters:

correctorName - The Corrector Name (including plane - token)

sign - the sign

gzip - if the file is gzipped

Returns:

the Filename (without path)

constructFileName

public static java.lang.String constructFileName(java.lang.String correctorName,
                                                 Plane plane,
                                                 cern.accsoft.steering.jmad.tools.response.DeflectionSign sign,
                                                 java.lang.Integer measurementNumber,
                                                 boolean gzip)

constructs a fileName from correctornamen, plane, sign and measurement number

Parameters:

correctorName - the correctorname (WITHOUT plane-token)

plane - the plane

sign - the sign

measurementNumber - measurement number

gzip - if the file is gzipped

Returns:

the file name

isCorrectorFile

public static boolean isCorrectorFile(java.lang.String fileName)

checks if the given fileName is ad Yasp-Corrector file

Parameters:

fileName - the filename to check

Returns:

true if it is a filename, false is not.