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

Class Micado. More...

#include <Micado.h>

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

Public Member Functions

 Micado ()
 Exemplar constructor. More...
 
virtual ~Micado ()
 
virtual Micadoclone (const std::string &name)
 Make clone. More...
 
virtual void execute ()
 Check validity of the table definition. More...
 
- Public Member Functions inherited from CorrectionBase
virtual ~CorrectionBase ()
 
- Public Member Functions inherited from Action
virtual ~Action ()
 
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...
 
- 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 &)
 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 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...
 

Private Types

enum  {
  METHOD = CorrectionBase::SIZE, TOL, ITERATIONS, CORRECTORS,
  PLANE, LISTC1, LISTC, LISTC2,
  LISTM1, LISTM2, SIZE
}
 The additional attributes for the "Micado" command. More...
 

Private Member Functions

 Micado (const Micado &)
 
void operator= (const Micado &)
 
 Micado (const std::string &name, Micado *parent)
 Clone constructor. More...
 
void applyCorrections (int mode, Vector< double > &X)
 
void findClosedOrbit ()
 
void setupInfluence (int mode, Matrix< double > &)
 
void setupReadings (int mode, Vector< double > &B)
 
void solve (int plane, Matrix< double > &A, Vector< double > &B)
 

Private Attributes

OwnPtr< AbstractMapperitsMapper
 

Additional Inherited Members

- Public Attributes inherited from Object
std::vector< AttributeitsAttr
 The object attributes (see Attribute.hh). More...
 
- Protected Types inherited from CorrectionBase
enum  { LINE, BEAM, RANGE, SIZE }
 The comon attributes for orbit correction commands. More...
 
typedef TBeamline< RowTLine
 
typedef std::list< Row * > LocalList
 
typedef LocalList::iterator LocalIter
 
- Protected Member Functions inherited from CorrectionBase
 CorrectionBase (int size, const char *name, const char *help)
 Exemplar constructor. More...
 
 CorrectionBase (const std::string &name, CorrectionBase *parent)
 Clone constructor. More...
 
void addKick (int plane, Row &, double kick)
 Add to kicker strength. More...
 
void listCorrectors (bool list, int plane)
 List correctors before or after correction. More...
 
void listMonitors (bool list, int plane)
 List monitors before or after correction. More...
 
void setupTables ()
 Set up the corrector and monitor tables. More...
 
void test (ElementBase *)
 Routine to test for corrector or monitor. More...
 
- Protected Member Functions inherited from Action
 Action (int size, const char *name, const char *help)
 Constructor for exemplars. More...
 
 Action (const std::string &name, Action *parent)
 Constructor for cloning. 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 CorrectionBase
TLine itsLine
 The flat beam line on which the correction is done. More...
 
PartData reference
 The particle reference data. More...
 
FVector< double, 6 > orbitGuess
 The closed orbit guess. More...
 
bool isCorr [2]
 Flags telling wether a corrector exists. More...
 
bool isMoni [2]
 Flag telling wether a monitor exists. More...
 
LocalList correctorTable [2]
 
LocalList monitorTable [2]
 
- Protected Attributes inherited from Object
bool builtin
 Built-in flag. More...
 
bool modified
 Dirty flag. More...
 
bool flagged
 Object flag. More...
 

Detailed Description

Class Micado.

OPAL command MICADO.

Definition at line 33 of file Micado.h.

Member Enumeration Documentation

anonymous enum
private

The additional attributes for the "Micado" command.

Enumerator
METHOD 
TOL 
ITERATIONS 
CORRECTORS 
PLANE 
LISTC1 
LISTC 
LISTC2 
LISTM1 
LISTM2 
SIZE 

Definition at line 51 of file Micado.h.

Constructor & Destructor Documentation

Micado::Micado ( )

Exemplar constructor.

Definition at line 44 of file Micado.cpp.

References AttributeHandler::COMMAND, CORRECTORS, ITERATIONS, Object::itsAttr, LISTC, LISTC1, LISTC2, LISTM1, LISTM2, Attributes::makeBool(), Attributes::makeReal(), Attributes::makeString(), METHOD, PLANE, Object::registerOwnership(), and TOL.

Referenced by clone().

Here is the call graph for this function:

Micado::~Micado ( )
virtual

Definition at line 78 of file Micado.cpp.

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

Clone constructor.

Definition at line 73 of file Micado.cpp.

Member Function Documentation

void Micado::applyCorrections ( int  mode,
Vector< double > &  X 
)
private
Micado * Micado::clone ( const std::string &  name)
virtual

Make clone.

Implements Object.

Definition at line 82 of file Micado.cpp.

References Micado().

Here is the call graph for this function:

void Micado::execute ( )
virtual
void Micado::findClosedOrbit ( )
private
void Micado::operator= ( const Micado )
private
void Micado::setupInfluence ( int  mode,
Matrix< double > &  A 
)
private
void Micado::setupReadings ( int  mode,
Vector< double > &  B 
)
private

Definition at line 300 of file Micado.cpp.

References CorrectionBase::monitorTable.

Referenced by execute().

void Micado::solve ( int  plane,
Matrix< double > &  A,
Vector< double > &  B 
)
private

Member Data Documentation

OwnPtr<AbstractMapper> Micado::itsMapper
private

Definition at line 91 of file Micado.h.

Referenced by execute(), and findClosedOrbit().


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