#include <OpalWake.h>

Inheritance diagram for OpalWake:

[legend]

Collaboration diagram for OpalWake:

[legend]

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

virtual	~OpalWake ()

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

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

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

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

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

int	getNumberOfBins ()

void	initWakefunction (const ElementBase &element)

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 ()

void	copyAttributes (const Object &)
	Copy attributes from another object. 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 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	printValue (std::ostream &) const

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

virtual void	replace (Object oldObject, Object newObject)
	Replace references. 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 OpalWake *	find (const std::string &name)
	Find named WAKE. More...

Public Attributes
WakeFunction *	wf_m

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

Private Member Functions
	OpalWake (const OpalWake &)

void	operator= (const OpalWake &)

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

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 26 of file OpalWake.h.

Constructor & Destructor Documentation

◆ OpalWake() [1/3]

OpalWake::OpalWake ( )

Exemplar constructor.

Definition at line 49 of file OpalWake.cpp.

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

Referenced by clone().

Here is the call graph for this function:

◆ ~OpalWake()

OpalWake::~OpalWake ( )

virtual

Definition at line 104 of file OpalWake.cpp.

References wf_m.

◆ OpalWake() [2/3]

OpalWake::OpalWake ( const OpalWake & )

private

◆ OpalWake() [3/3]

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

private

Definition at line 98 of file OpalWake.cpp.

Member Function Documentation

◆ canReplaceBy()

bool OpalWake::canReplaceBy ( Object * object )

virtual

Test if replacement is allowed.

Reimplemented from Object.

Definition at line 109 of file OpalWake.cpp.

◆ clone()

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

virtual

Make clone.

Implements Object.

Definition at line 115 of file OpalWake.cpp.

References name, and OpalWake().

Referenced by OpalWake().

Here is the call graph for this function:

◆ execute()

void OpalWake::execute ( )

virtual

Check the WAKE data.

Reimplemented from Object.

Definition at line 120 of file OpalWake.cpp.

References update().

Here is the call graph for this function:

◆ find()

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

static

Find named WAKE.

Definition at line 125 of file OpalWake.cpp.

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

Referenced by OpalCavity::update(), OpalDrift::update(), OpalProbe::update(), OpalRBend::update(), OpalRBend3D::update(), OpalSBend::update(), OpalSeptum::update(), and OpalTravelingWave::update().

Here is the call graph for this function:

◆ getNumberOfBins()

int OpalWake::getNumberOfBins ( )

Definition at line 135 of file OpalWake.cpp.

References Attributes::getReal(), Object::itsAttr, and Attrib::Distribution::NBIN.

Here is the call graph for this function:

◆ initWakefunction()

void OpalWake::initWakefunction ( const ElementBase & element )

Definition at line 146 of file OpalWake.cpp.

References endl(), OpalFilter::filter_m, OpalFilter::find(), Attrib::Distribution::FNAME, Attributes::getBool(), ElementBase::getName(), Object::getOpalName(), Attributes::getReal(), Attributes::getString(), Attributes::getStringArray(), gmsg, OpalFilter::initOpalFilter(), Object::itsAttr, Attrib::Distribution::NBIN, Attrib::Distribution::TYPE, and wf_m.

Referenced by OpalCavity::update(), OpalDrift::update(), OpalProbe::update(), OpalRBend::update(), OpalRBend3D::update(), OpalSBend::update(), OpalSeptum::update(), and OpalTravelingWave::update().

Here is the call graph for this function:

◆ operator=()

void OpalWake::operator= ( const OpalWake & )

private

◆ print()

void OpalWake::print ( std::ostream & msg ) const

virtual

Print the object.

Reimplemented from Object.

Definition at line 219 of file OpalWake.cpp.

References endl(), Object::getOpalName(), Attributes::getReal(), Object::itsAttr, and Attrib::Distribution::NBIN.

Referenced by operator<<().

Here is the call graph for this function:

◆ update()

void OpalWake::update ( )

virtual

Update the WAKE data.

Reimplemented from Object.

Definition at line 140 of file OpalWake.cpp.

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

Referenced by execute(), and OpalWake().

Here is the call graph for this function:

Member Data Documentation

◆ wf_m

WakeFunction* OpalWake::wf_m

Definition at line 57 of file OpalWake.h.

Referenced by initWakefunction(), OpalCavity::update(), OpalDrift::update(), OpalProbe::update(), OpalRBend::update(), OpalRBend3D::update(), OpalSBend::update(), OpalSeptum::update(), OpalTravelingWave::update(), and ~OpalWake().

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

/Users/gsell/src/OPAL/src/src/Structure/OpalWake.h
/Users/gsell/src/OPAL/src/src/Structure/OpalWake.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OpalWake() [1/3]

◆ ~OpalWake()

◆ OpalWake() [2/3]

◆ OpalWake() [3/3]

Member Function Documentation

◆ canReplaceBy()

◆ clone()

◆ execute()

◆ find()

◆ getNumberOfBins()

◆ initWakefunction()

◆ operator=()

◆ print()

◆ update()

Member Data Documentation

◆ wf_m