OPAL (Object Oriented Parallel Accelerator Library)  2024.1
OPAL
Public Member Functions | Static Public Member Functions | Public Attributes | Private Types | Private Member Functions | List of all members
OpalTrimCoil Class Reference

#include <OpalTrimCoil.h>

Inheritance diagram for OpalTrimCoil:
Inheritance graph
[legend]
Collaboration diagram for OpalTrimCoil:
Collaboration graph
[legend]

Public Member Functions

 OpalTrimCoil ()
 Exemplar constructor. More...
 
virtual ~OpalTrimCoil ()
 
virtual bool canReplaceBy (Object *object)
 Test if replacement is allowed. More...
 
virtual OpalTrimCoilclone (const std::string &name)
 Make clone. More...
 
virtual void execute ()
 Check the OpalTrimCoil data. More...
 
virtual void update ()
 Update the OpalTrimCoil data. More...
 
Informprint (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 ()
 
void copyAttributes (const Object &)
 Copy attributes from another object. More...
 
virtual AttributefindAttribute (const std::string &name)
 Find an attribute by name. More...
 
virtual const AttributefindAttribute (const std::string &name) const
 Find an attribute by name. More...
 
virtual ObjectmakeTemplate (const std::string &, TokenStream &, Statement &)
 Macro handler function. More...
 
virtual ObjectmakeInstance (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...
 
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 ObjectgetBaseObject () const
 Return the object's base type object. More...
 
const std::string & getOpalName () const
 Return object name. More...
 
ObjectgetParent () 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 OpalTrimCoilfind (const std::string &name)
 Find named trim coil. More...
 

Public Attributes

std::unique_ptr< TrimCoiltrimcoil_m
 Actual implementation. More...
 
- Public Attributes inherited from Object
std::vector< AttributeitsAttr
 The object attributes. More...
 

Private Types

enum  TrimCoilType : unsigned short { TrimCoilType::BFIELD, TrimCoilType::PHASE, TrimCoilType::BFIELDMIRRORED }
 

Private Member Functions

 OpalTrimCoil (const std::string &name, OpalTrimCoil *parent)
 
void printPolynom (Inform &os, const Attribute &attr) const
 Helper method for printing. More...
 
TrimCoilType getTrimCoilType () const
 
 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
 
RCObjectoperator= (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 38 of file OpalTrimCoil.h.

Member Enumeration Documentation

enum OpalTrimCoil::TrimCoilType : unsigned short
strongprivate
Enumerator
BFIELD 
PHASE 
BFIELDMIRRORED 

Definition at line 73 of file OpalTrimCoil.h.

Constructor & Destructor Documentation

OpalTrimCoil::OpalTrimCoil ( )
OpalTrimCoil::~OpalTrimCoil ( )
virtual

Definition at line 115 of file OpalTrimCoil.cpp.

OpalTrimCoil::OpalTrimCoil ( const OpalTrimCoil )
privatedelete

Not implemented.

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

Private copy constructor, called by clone

Definition at line 109 of file OpalTrimCoil.cpp.

Member Function Documentation

bool OpalTrimCoil::canReplaceBy ( Object object)
virtual

Test if replacement is allowed.

Reimplemented from Object.

Definition at line 119 of file OpalTrimCoil.cpp.

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

Make clone.

Implements Object.

Definition at line 125 of file OpalTrimCoil.cpp.

References OpalTrimCoil().

Referenced by OpalTrimCoil().

Here is the call graph for this function:

void OpalTrimCoil::execute ( )
virtual

Check the OpalTrimCoil data.

Reimplemented from Object.

Definition at line 130 of file OpalTrimCoil.cpp.

References update().

Referenced by minimal_runner.MinimalRunner::execute_fork().

Here is the call graph for this function:

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

Find named trim coil.

Definition at line 135 of file OpalTrimCoil.cpp.

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

Referenced by OpalCyclotron::update().

Here is the call graph for this function:

OpalTrimCoil::TrimCoilType OpalTrimCoil::getTrimCoilType ( ) const
private

Definition at line 151 of file OpalTrimCoil.cpp.

References BFIELD, BFIELDMIRRORED, Attributes::getString(), Object::itsAttr, PHASE, and Attrib::Distribution::TYPE.

Referenced by initOpalTrimCoil(), and print().

Here is the call graph for this function:

void OpalTrimCoil::initOpalTrimCoil ( )

Initialise implementation.

Definition at line 167 of file OpalTrimCoil.cpp.

References BFIELD, BFIELDMIRRORED, endl(), Attributes::getReal(), Attributes::getRealArray(), getTrimCoilType(), Object::itsAttr, level3(), PHASE, trimcoil_m, and type.

Referenced by OpalCyclotron::update().

Here is the call graph for this function:

void OpalTrimCoil::operator= ( const OpalTrimCoil )
privatedelete
Inform & OpalTrimCoil::print ( Inform os) const
void OpalTrimCoil::printPolynom ( Inform os,
const Attribute attr 
) const
private

Helper method for printing.

Definition at line 223 of file OpalTrimCoil.cpp.

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

Referenced by print().

Here is the call graph for this function:

void OpalTrimCoil::update ( )
virtual

Update the OpalTrimCoil data.

Reimplemented from Object.

Definition at line 145 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

std::unique_ptr<TrimCoil> OpalTrimCoil::trimcoil_m

Actual implementation.

Definition at line 70 of file OpalTrimCoil.h.

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


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