#include <OpalTrimCoil.h>

Inheritance diagram for OpalTrimCoil:

[legend]

Collaboration diagram for OpalTrimCoil:

[legend]

Public Member Functions
	OpalTrimCoil ()
	Exemplar constructor. More...

virtual	~OpalTrimCoil ()

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

virtual OpalTrimCoil *	clone (const std::string &name)
	Make clone. More...

virtual void	execute ()
	Check the OpalTrimCoil data. More...

virtual void	update ()
	Update the OpalTrimCoil data. More...

Inform &	print (Inform &os) const

void	initOpalTrimCoil ()
	Initialise implementation. More...

Public Member Functions inherited from Definition
virtual	~Definition ()

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...

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...

Static Public Member Functions
static OpalTrimCoil *	find (const std::string &name)
	Find named trim coil. More...

Public Attributes
std::unique_ptr< TrimCoil >	trimcoil_m
	Actual implementation. More...

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

Private Member Functions
	OpalTrimCoil (const std::string &name, OpalTrimCoil *parent)

void	printPolynom (Inform &os, const Attribute &attr) const
	Helper method for printing. More...


	OpalTrimCoil (const OpalTrimCoil &)=delete
	Not implemented. More...

void	operator= (const OpalTrimCoil &)=delete

Additional Inherited Members
Protected Member Functions inherited from Definition
	Definition (int size, const char name, const char help)
	Constructor for exemplars. More...

	Definition (const std::string &name, Definition *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)

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

bool	modified
	Dirty flag. More...

bool	flagged
	Object flag. More...

Detailed Description

Definition at line 37 of file OpalTrimCoil.h.

Constructor & Destructor Documentation

◆ OpalTrimCoil() [1/3]

OpalTrimCoil::OpalTrimCoil ( )

Exemplar constructor.

Definition at line 56 of file OpalTrimCoil.cpp.

References Object::builtin, clone(), OpalData::define(), OpalData::getInstance(), Object::itsAttr, Attributes::makePredefinedString(), Attributes::makeReal(), Attributes::makeRealArray(), Object::registerOwnership(), AttributeHandler::STATEMENT, Attrib::Distribution::TYPE, and update().

Referenced by clone().

Here is the call graph for this function:

◆ ~OpalTrimCoil()

OpalTrimCoil::~OpalTrimCoil ( )

virtual

Definition at line 114 of file OpalTrimCoil.cpp.

◆ OpalTrimCoil() [2/3]

OpalTrimCoil::OpalTrimCoil ( const OpalTrimCoil & )

privatedelete

Not implemented.

◆ OpalTrimCoil() [3/3]

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

private

Private copy constructor, called by clone

Definition at line 108 of file OpalTrimCoil.cpp.

Member Function Documentation

◆ canReplaceBy()

bool OpalTrimCoil::canReplaceBy ( Object * object )

virtual

Test if replacement is allowed.

Reimplemented from Object.

Definition at line 118 of file OpalTrimCoil.cpp.

◆ clone()

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

virtual

Make clone.

Implements Object.

Definition at line 124 of file OpalTrimCoil.cpp.

References name, and OpalTrimCoil().

Referenced by OpalTrimCoil().

Here is the call graph for this function:

◆ execute()

void OpalTrimCoil::execute ( )

virtual

Check the OpalTrimCoil data.

Reimplemented from Object.

Definition at line 129 of file OpalTrimCoil.cpp.

References update().

Here is the call graph for this function:

◆ find()

OpalTrimCoil * OpalTrimCoil::find ( const std::string & name )

static

Find named trim coil.

Definition at line 134 of file OpalTrimCoil.cpp.

References OpalData::find(), OpalData::getInstance(), and name.

Referenced by OpalCyclotron::update().

Here is the call graph for this function:

◆ initOpalTrimCoil()

void OpalTrimCoil::initOpalTrimCoil ( )

Initialise implementation.

Definition at line 150 of file OpalTrimCoil.cpp.

References endl(), Attributes::getReal(), Attributes::getRealArray(), Attributes::getString(), gmsg, Object::itsAttr, level3(), trimcoil_m, and Attrib::Distribution::TYPE.

Referenced by OpalCyclotron::update().

Here is the call graph for this function:

◆ operator=()

void OpalTrimCoil::operator= ( const OpalTrimCoil & )

privatedelete

◆ print()

Inform & OpalTrimCoil::print ( Inform & os ) const

Definition at line 181 of file OpalTrimCoil.cpp.

References endl(), Object::getOpalName(), Attributes::getReal(), Attributes::getString(), Object::itsAttr, printPolynom(), and Attrib::Distribution::TYPE.

Referenced by operator<<().

Here is the call graph for this function:

◆ printPolynom()

void OpalTrimCoil::printPolynom	(	Inform &	os,
		const Attribute &	attr
	)		const

private

Helper method for printing.

Definition at line 205 of file OpalTrimCoil.cpp.

References Attribute::getName(), and Attributes::getRealArray().

Referenced by print().

Here is the call graph for this function:

◆ update()

void OpalTrimCoil::update ( )

virtual

Update the OpalTrimCoil data.

Reimplemented from Object.

Definition at line 144 of file OpalTrimCoil.cpp.

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

Referenced by execute(), and OpalTrimCoil().

Here is the call graph for this function:

Member Data Documentation

◆ trimcoil_m

std::unique_ptr<TrimCoil> OpalTrimCoil::trimcoil_m

Actual implementation.

Definition at line 69 of file OpalTrimCoil.h.

Referenced by initOpalTrimCoil(), and OpalCyclotron::update().

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

/Users/gsell/src/OPAL/src/src/Classic/TrimCoils/OpalTrimCoil.h
/Users/gsell/src/OPAL/src/src/Classic/TrimCoils/OpalTrimCoil.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OpalTrimCoil() [1/3]

◆ ~OpalTrimCoil()

◆ OpalTrimCoil() [2/3]

◆ OpalTrimCoil() [3/3]

Member Function Documentation

◆ canReplaceBy()

◆ clone()

◆ execute()

◆ find()

◆ initOpalTrimCoil()

◆ operator=()

◆ print()

◆ printPolynom()

◆ update()

Member Data Documentation

◆ trimcoil_m