BaseErrorController#

class orbit.py_linac.errors.BaseErrorController(name='no_name', type_in='Base_Error_Controller')[source]#

Bases: orbit.utils.NamedObject.NamedObject, orbit.utils.TypedObject.TypedObject, orbit.utils.ParamsDictObject.ParamsDictObject

The base class for Error Controllers. It keeps the reference to start and stop lattice nodes. The transformation function is defined by self.entranceErrorAccNode, and backward transformation is defined by self.exitErrorAccNode which are set up as children of two (or just one) entrance and exit lattice nodes.

Methods Summary

`cleanParentNodes`()	Removes children representing error nodes from the parent node or nodes.
`getEntanceNode`()	Returns the lattice entrance (start) node for errors application.
`getEntanceNodeParameters`()	Returns tuple with parameters for entranceAccNode.
`getEntanceNodeParent`()	Returns the entrance (start) lattice node for error effects.
`getExitNode`()	Returns the lattice exit (stop) node for errors application.
`getExitNodeParameters`()	Returns tuple with parameters for exitAccNode.
`getExitNodeParent`()	Returns the exit (stop) lattice node for error effects.
`getLattice`()	Returns the reference to the lattice.
`getShortTypeName`()	Returns the short type name that will be included into the error node name.
`setEntanceNodeParent`(entranceAccNodeParent)	Set up the entrance (start) lattice node for error effects.
`setExitNodeParent`(exitAccNodeParent)	Set up the exit (stop) lattice node for error effects.
`setLattice`(accLattice)	Sets the lattice.
`setOneNodeParent`(accNodeParent)	If we apply error transformation only for one lattice node.

Methods Documentation

cleanParentNodes()[source]#: Removes children representing error nodes from the parent node or nodes.

getEntanceNode()[source]#: Returns the lattice entrance (start) node for errors application.

getEntanceNodeParameters()[source]#: Returns tuple with parameters for entranceAccNode. This method should be implemented by sub-classes.

getEntanceNodeParent()[source]#: Returns the entrance (start) lattice node for error effects.

getExitNode()[source]#: Returns the lattice exit (stop) node for errors application.

getExitNodeParameters()[source]#: Returns tuple with parameters for exitAccNode. This method should be implemented by sub-classes.

getExitNodeParent()[source]#: Returns the exit (stop) lattice node for error effects.

getLattice()[source]#: Returns the reference to the lattice.

getShortTypeName()[source]#: Returns the short type name that will be included into the error node name.

setEntanceNodeParent(entranceAccNodeParent)[source]#: Set up the entrance (start) lattice node for error effects.

setExitNodeParent(exitAccNodeParent)[source]#: Set up the exit (stop) lattice node for error effects.

setLattice(accLattice)[source]#: Sets the lattice.

setOneNodeParent(accNodeParent)[source]#: If we apply error transformation only for one lattice node.