AbstractRF_Gap#

class orbit.py_linac.lattice.AbstractRF_Gap(name='abstractfgap')[source]#

Bases: orbit.py_linac.lattice.LinacAccNodes.BaseLinacNode

This is an abstarct class for all RF Gap classes.

Methods Summary

`getGapPhase`()	Returns the rf gap phase.
`getRF_Cavity`()	Returns the parent RF Cavity.
`initialize`()	The AbstractRF_Gap class initialize() method.
`isFirstRFGap`()	Returns True if it is the first gap in RF cavity.
`isRFGap`()	Returns True.
`setAsFirstRFGap`(isFirst)	Sets if it is the first gap in RF cavity.
`setGapPhase`(gap_phase)	Sets the rf gap phase.
`setRF_Cavity`(rf_cav)	Sets the parent RF Cavity.
`track`(paramsDict)	The subclasses AbstractRF_Gap class should implement the BaseLinacNode class track(probe) method.
`trackDesign`(paramsDict)	The subclasses AbstractRF_Gap class should implement the BaseLinacNode class trackDesign(probe) method.

Methods Documentation

getGapPhase()[source]#: Returns the rf gap phase.

getRF_Cavity()[source]#: Returns the parent RF Cavity.

initialize()[source]#: The AbstractRF_Gap class initialize() method.

isFirstRFGap()[source]#: Returns True if it is the first gap in RF cavity.

isRFGap()[source]#: Returns True.

setAsFirstRFGap(isFirst)[source]#: Sets if it is the first gap in RF cavity.

setGapPhase(gap_phase)[source]#: Sets the rf gap phase.

setRF_Cavity(rf_cav)[source]#: Sets the parent RF Cavity.

track(paramsDict)[source]#: The subclasses AbstractRF_Gap class should implement the BaseLinacNode class track(probe) method.

trackDesign(paramsDict)[source]#: The subclasses AbstractRF_Gap class should implement the BaseLinacNode class trackDesign(probe) method.