Class BaseAperture#
Defined in File BaseAperture.hh
Inheritance Relationships#
Base Type#
public OrbitUtils::CppPyWrapper(Class CppPyWrapper)
Class Documentation#
-
class BaseAperture : public OrbitUtils::CppPyWrapper#
BaseAperture class defines actions with macro particles in a main bunch and a lost bunch instances with respect of transverse coordinates of macro particles. It can keep macro particle in the main bunch or remove it after asking the BaseApertureShape class instance about the suitability of particle’s coordinates.
Public Functions
-
BaseAperture()#
BaseAperture constructor
-
virtual ~BaseAperture()#
BaseAperture decstructor
-
BaseApertureShape *getApertureShape()#
Returns aperture shape
-
void setApertureShape(BaseApertureShape *apertureShape)#
Sets aperture shape
-
void checkBunch(Bunch *bunch, Bunch *lostbunch)#
Routine for transfering particles through a aperture
-
int getNumberOfLost()#
Returns the total number of partciles lost across all CPUs
Returns total particle loss across all CPUs in the bunch communicator
-
string getName()#
Returns the aperture name
-
void setName(string apertureNameIn)#
Sets the aperture name
-
double getPosition()#
Sets the position of the node in the lattice
Returns the position of the node in the lattice.
-
void setPosition(double position)#
Returns the position of the node in the lattice
Sets the position of the node in the lattice.
-
void setOnOff(int isActive)#
Sets the aperture in an active ( 1 )/ not active ( 0 ) state
-
int getOnOff()#
Returns the aperture in an active ( 1 )/ not active ( 0 ) state
-
BaseAperture()#