#include <OpalVariableRFCavityFringeField.h>

Inheritance diagram for OpalVariableRFCavityFringeField:

[legend]

Collaboration diagram for OpalVariableRFCavityFringeField:

[legend]

Public Types
enum	{ PHASE_MODEL = COMMON , AMPLITUDE_MODEL , FREQUENCY_MODEL , WIDTH , HEIGHT , CENTRE_LENGTH , END_LENGTH , CAVITY_CENTRE , MAX_ORDER , SIZE }

Public Types inherited from OpalElement
enum	{ TYPE , APERT , LENGTH , ELEMEDGE , WAKEF , PARTICLEMATTERINTERACTION , ORIGIN , ORIENTATION , X , Y , Z , THETA , PHI , PSI , DX , DY , DZ , DTHETA , DPHI , DPSI , OUTFN , DELETEONTRANSVERSEEXIT , COMMON }
	The common attributes for all elements. More...

Public Types inherited from Element
enum	ReferenceType { IS_ENTRY , IS_CENTRE , IS_EXIT }
	Reference for element positioning. More...

Public Member Functions
	OpalVariableRFCavityFringeField (const std::string &name, OpalVariableRFCavityFringeField *parent)

	OpalVariableRFCavityFringeField ()

OpalVariableRFCavityFringeField *	clone ()

virtual OpalVariableRFCavityFringeField *	clone (const std::string &name)

virtual	~OpalVariableRFCavityFringeField ()

virtual void	update ()

Public Member Functions inherited from OpalElement
virtual	~OpalElement ()

virtual double	getLength () const
	Return element length. More...

const std::string	getTypeName () const
	Return the element's type name. More...

std::pair< ApertureType, std::vector< double > >	getApert () const

const std::string	getWakeF () const
	Return the element's type name. More...

const std::string	getParticleMatterInteraction () const

const std::string	getWMaterial () const

const std::string	getWakeGeom () const

std::vector< double >	getWakeParam () const

const std::string	getWakeConductivity () const

virtual void	parse (Statement &)
	Parse the element. More...

virtual void	print (std::ostream &) const
	Print the object. More...

virtual void	update ()
	Update the embedded CLASSIC element. More...

virtual void	updateUnknown (ElementBase *)
	Transmit the `‘unknown’' (not known to OPAL) attributes to CLASSIC. More...

Public Member Functions inherited from Element
virtual	~Element ()

virtual bool	canReplaceBy (Object *object)
	Test if replacement is allowed. More...

virtual const std::string	getCategory () const
	Return the object category as a string. More...

virtual bool	shouldTrace () const
	Trace flag. More...

virtual bool	shouldUpdate () const
	Update flag. More...

virtual double	getLength () const =0
	Return element length. More...

virtual double	getEntrance (ReferenceType) const
	Return arc length from origin to entrance (negative !). More...

virtual double	getExit (ReferenceType) const
	Return arc length from origin to exit (positive !). More...

virtual void	setShared (bool)
	Set shared flag. More...

ElementBase *	getElement () const
	Return the embedded CLASSIC element. More...

void	setElement (ElementBase *)
	Assign new CLASSIC element. More...

Public Member Functions inherited from Object
virtual	~Object ()

virtual bool	canReplaceBy (Object *object)
	Test if replacement is allowed. More...

virtual Object *	clone (const std::string &name)=0
	Return a clone. More...

void	copyAttributes (const Object &)
	Copy attributes from another object. More...

virtual void	execute ()
	Execute the command. More...

virtual Attribute *	findAttribute (const std::string &name)
	Find an attribute by name. More...

virtual const Attribute *	findAttribute (const std::string &name) const
	Find an attribute by name. More...

virtual const std::string	getCategory () const =0
	Return the object category as a string. More...

virtual bool	shouldTrace () const =0
	Trace flag. More...

virtual bool	shouldUpdate () const =0
	Update flag. More...

virtual Object *	makeTemplate (const std::string &, TokenStream &, Statement &)
	Macro handler function. More...

virtual Object *	makeInstance (const std::string &name, Statement &, const Parser *)
	Macro handler function. More...

virtual void	parse (Statement &)
	Parse the object. More...

virtual void	parseShortcut (Statement &, bool eval=true)
	Parser for single-attribute commands. More...

virtual void	print (std::ostream &) const
	Print the object. More...

virtual void	printValue (std::ostream &) const

virtual void	printHelp (std::ostream &) const
	Print help. More...

virtual void	replace (Object oldObject, Object newObject)
	Replace references. More...

virtual void	update ()
	Update this object. More...

bool	isBuiltin () const
	True, if [b]this[/b] is a built-in object. More...

virtual bool	isShared () const
	Shared flag. More...

virtual void	setShared (bool)
	Set/reset shared flag. More...

void	setDirty (bool)
	Set/reset the [b]modified[/b] flag. More...

bool	isDirty () const
	True, if the [b]modified[/b] flag is set. More...

void	setFlag (bool)
	Flag/unflag this object, e. g. to control output of objects for. More...

bool	isFlagged () const
	True, if [b]this[/b] is flagged by setFlag(true). More...

const Object *	getBaseObject () const
	Return the object's base type object. More...

const std::string &	getOpalName () const
	Return object name. More...

Object *	getParent () const
	Return parent pointer. More...

bool	isTreeMember (const Object *subTree) const
	Test for tree membership. More...

void	setOpalName (const std::string &name)
	Set object name. More...

void	setParent (Object *)
	Set parent object. More...

void	clear ()
	Clear the occurrence counter. More...

int	increment ()
	Increment and return the occurrence counter. More...

int	occurrenceCount ()
	Return the occurrence counter. More...

void	registerReference (Invalidator *a)
	Register a reference to this object. More...

void	unregisterReference (Invalidator *a)
	Unegister a reference to this object. More...

void	registerOwnership (const AttributeHandler::OwnerType &itsClass) const

Public Member Functions inherited from RCObject
int	addReference () const
	Increment reference count. More...

int	removeReference () const
	Decrement the reference count. More...

bool	isShared () const
	Test for sharing. More...

Private Member Functions
	OpalVariableRFCavityFringeField (const OpalVariableRFCavityFringeField &)

void	operator= (const OpalVariableRFCavityFringeField &)

Static Private Member Functions
static size_t	convertToUnsigned (double value, std::string name)

Static Private Attributes
static const std::string	doc_string

static constexpr double	unsignedTolerance = 1e-9

Additional Inherited Members
Static Public Member Functions inherited from Element
static Element *	find (const std::string &name)
	Find named Element. More...

Public Attributes inherited from Object
std::vector< Attribute >	itsAttr
	The object attributes. More...

Protected Member Functions inherited from OpalElement
	OpalElement (int size, const char name, const char help)
	Exemplar constructor. More...

	OpalElement (const std::string &name, OpalElement *parent)
	Clone constructor. More...

void	registerOwnership () const

Protected Member Functions inherited from Element
	Element (int size, const char name, const char help)
	Constructor for exemplars. More...

	Element (const std::string &name, Element *parent)
	Constructor for clones. More...

Protected Member Functions inherited from Object
	Object (int size, const char name, const char help)
	Constructor for exemplars. More...

	Object (const std::string &name, Object *parent)
	Constructor for clones. More...

Protected Member Functions inherited from RCObject
	RCObject ()
	Default constructor. More...

	RCObject (const RCObject &)
	Copy constructor. More...

virtual	~RCObject ()=0

RCObject &	operator= (const RCObject &right)

Static Protected Member Functions inherited from OpalElement
static void	printMultipoleStrength (std::ostream &os, int order, int &len, const std::string &sName, const std::string &tName, const Attribute &length, const Attribute &vNorm, const Attribute &vSkew)
	Print multipole components in OPAL-8 format. More...

static void	printAttribute (std::ostream &os, const std::string &name, const std::string &image, int &len)
	Print an attribute with a OPAL-8 name (as an expression). More...

static void	printAttribute (std::ostream &os, const std::string &name, double value, int &len)
	Print an attribute with a OPAL-8 name (as a constant). More...

Protected Attributes inherited from Object
bool	builtin
	Built-in flag. More...

bool	modified
	Dirty flag. More...

bool	flagged
	Object flag. More...

Detailed Description

OpalVariableRFCavityFringeField

Definition at line 35 of file OpalVariableRFCavityFringeField.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

enum maps string to integer value for UI definitions

Enumerator
PHASE_MODEL
AMPLITUDE_MODEL
FREQUENCY_MODEL
WIDTH
HEIGHT
CENTRE_LENGTH
END_LENGTH
CAVITY_CENTRE
MAX_ORDER
SIZE

Definition at line 38 of file OpalVariableRFCavityFringeField.h.

Constructor & Destructor Documentation

◆ OpalVariableRFCavityFringeField() [1/3]

OpalVariableRFCavityFringeField::OpalVariableRFCavityFringeField	(	const std::string &	name,
		OpalVariableRFCavityFringeField *	parent
	)

Copy constructor

Definition at line 70 of file OpalVariableRFCavityFringeField.cpp.

References Element::getElement(), and Element::setElement().

Here is the call graph for this function:

◆ OpalVariableRFCavityFringeField() [2/3]

OpalVariableRFCavityFringeField::OpalVariableRFCavityFringeField ( )

Default constructor

Definition at line 44 of file OpalVariableRFCavityFringeField.cpp.

References AMPLITUDE_MODEL, CAVITY_CENTRE, CENTRE_LENGTH, END_LENGTH, FREQUENCY_MODEL, HEIGHT, Object::itsAttr, Attributes::makeReal(), Attributes::makeString(), MAX_ORDER, PHASE_MODEL, OpalElement::registerOwnership(), Element::setElement(), and WIDTH.

Referenced by clone().

Here is the call graph for this function:

◆ ~OpalVariableRFCavityFringeField()

OpalVariableRFCavityFringeField::~OpalVariableRFCavityFringeField ( )

virtual

Destructor does nothing

Definition at line 79 of file OpalVariableRFCavityFringeField.cpp.

◆ OpalVariableRFCavityFringeField() [3/3]

OpalVariableRFCavityFringeField::OpalVariableRFCavityFringeField ( const OpalVariableRFCavityFringeField & )

private

Member Function Documentation

◆ clone() [1/2]

OpalVariableRFCavityFringeField * OpalVariableRFCavityFringeField::clone ( )

Inherited copy constructor

Call on a base class to instantiate an object of derived class's type

Definition at line 87 of file OpalVariableRFCavityFringeField.cpp.

References Object::getOpalName(), and OpalVariableRFCavityFringeField().

Here is the call graph for this function:

◆ clone() [2/2]

OpalVariableRFCavityFringeField * OpalVariableRFCavityFringeField::clone ( const std::string & name )

virtual

Inherited copy constructor

Call on a base class to instantiate an object of derived class's type

Implements Object.

Definition at line 82 of file OpalVariableRFCavityFringeField.cpp.

References name, and OpalVariableRFCavityFringeField().

Here is the call graph for this function:

◆ convertToUnsigned()

size_t OpalVariableRFCavityFringeField::convertToUnsigned	(	double	value,
		std::string	name
	)

inlinestaticprivate

Check for conversion to unsigned int

Definition at line 126 of file OpalVariableRFCavityFringeField.cpp.

References abs(), floor(), name, and unsignedTolerance.

Referenced by update().

Here is the call graph for this function:

◆ operator=()

void OpalVariableRFCavityFringeField::operator= ( const OpalVariableRFCavityFringeField & )

private

◆ update()

void OpalVariableRFCavityFringeField::update ( )

virtual

Update the OpalVariableRFCavity with new parameters from UI parser

Reimplemented from OpalElement.

Definition at line 91 of file OpalVariableRFCavityFringeField.cpp.

References AMPLITUDE_MODEL, CAVITY_CENTRE, CENTRE_LENGTH, convertToUnsigned(), end(), END_LENGTH, FREQUENCY_MODEL, Element::getElement(), Attributes::getReal(), Attributes::getString(), HEIGHT, Object::itsAttr, OpalElement::LENGTH, Units::m2mm, MAX_ORDER, PHASE_MODEL, VariableRFCavity::setAmplitudeName(), VariableRFCavityFringeField::setCavityCentre(), Element::setElement(), VariableRFCavityFringeField::setEndField(), VariableRFCavity::setFrequencyName(), VariableRFCavity::setHeight(), VariableRFCavity::setLength(), VariableRFCavityFringeField::setMaxOrder(), VariableRFCavity::setPhaseName(), VariableRFCavity::setWidth(), tanh(), OpalElement::update(), and WIDTH.

Here is the call graph for this function:

Member Data Documentation

◆ doc_string

const std::string OpalVariableRFCavityFringeField::doc_string

staticprivate

Initial value:

=
      std::string("The \"VARIABLE_RF_CAVITY_FRINGE_FIELD\" element defines an RF cavity ")+
      std::string("with time dependent frequency, phase and amplitude.")

Definition at line 83 of file OpalVariableRFCavityFringeField.h.

◆ unsignedTolerance

constexpr double OpalVariableRFCavityFringeField::unsignedTolerance = 1e-9

staticconstexprprivate

Definition at line 84 of file OpalVariableRFCavityFringeField.h.

Referenced by convertToUnsigned().

The documentation for this class was generated from the following files:

/Users/gsell/src/OPAL/src/src/Elements/OpalVariableRFCavityFringeField.h
/Users/gsell/src/OPAL/src/src/Elements/OpalVariableRFCavityFringeField.cpp

Public Types

Public Member Functions

Private Member Functions

Static Private Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ OpalVariableRFCavityFringeField() [1/3]

◆ OpalVariableRFCavityFringeField() [2/3]

◆ ~OpalVariableRFCavityFringeField()

◆ OpalVariableRFCavityFringeField() [3/3]

Member Function Documentation

◆ clone() [1/2]

◆ clone() [2/2]

◆ convertToUnsigned()

◆ operator=()

◆ update()

Member Data Documentation

◆ doc_string

◆ unsignedTolerance