class Beam : public Definition

(Return to index)

The BEAM definition.

Type:	Instantiable
Superclasses:	public Definition
Include file:	./Structure/Beam.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • Beam () ;
  • virtual ~Beam () ;
  • virtual bool canReplaceBy (Object*) ;
  • virtual Beam* clone (const string&) ;
  • virtual void execute () ;
  • static Beam* find (const string&) ;
  • double getEX ()const ;
  • double getEY ()const ;
  • double getET ()const ;
  • const PartData& getReference ()const ;
  • void setEX (double) ;
  • void setEY (double) ;
  • void setET (double) ;
  • virtual void update () ;
  • void tfsDescriptors (std::ostream&)const ;
  • virtual const string getCategory ()const ;
  • virtual bool shouldTrace ()const ;
  • virtual bool shouldUpdate ()const ;
  • void copyAttributes (const Object&) ;
  • virtual void doomGet (const DoomReader&) ;
  • virtual void doomPut (DoomWriter&)const ;
  • virtual Attribute* findAttribute (const string&) ;
  • virtual const Attribute* findAttribute (const string&)const ;
  • virtual Object* makeTemplate (const string&,TokenStream&,Statement&) ;
  • virtual Object* makeInstance (const string&,Statement&) ;
  • virtual void parse (Statement&) ;
  • virtual void parseShortcut (Statement&) ;
  • virtual void print (std::ostream&)const ;
  • virtual void printHelp (std::ostream&)const ;
  • virtual void replace (Object*,Object*) ;
  • bool isBuiltin ()const ;
  • virtual bool isShared ()const ;
  • virtual void setShared (bool) ;
  • void setDirty (bool) ;
  • bool isDirty ()const ;
  • void setFlag (bool) ;
  • bool isFlagged ()const ;
  • void setDoomTime (double) ;
  • double getDoomTime ()const ;
  • const Object* getBaseObject ()const ;
  • const string& getMadName ()const ;
  • Object* getParent ()const ;
  • bool isTreeMember (const Object*)const ;
  • void setMadName (const string&) ;
  • void setParent (Object*) ;
  • void clear () ;
  • int increment () ;
  • int occurrenceCount () ;
  • void registerReference (AttributeBase*) ;
  • void unregisterReference (AttributeBase*) ;
  • std::vector<Attribute> itsAttr ;

Documentation:

• Public members:

  Beam () ;

  Exemplar constructor.

  virtual bool canReplaceBy (Object*) ;

  Test if replacement is allowed.
  Can replace only by another BEAM.

  virtual Beam* clone (const string&) ;

  Make clone.

  virtual void execute () ;

  Check the BEAM data.

  static Beam* find (const string&) ;

  Find named BEAM.

  double getET ()const ;

  Return emittance for mode 3.

  double getEX ()const ;

  Return emittance for mode 1.

  double getEY ()const ;

  Return emittance for mode 2.

  const PartData& getReference ()const ;

  Return the embedded CLASSIC PartData.

  void setET (double) ;

  Store emittance for mode 3.

  void setEX (double) ;

  Store emittance for mode 1.

  void setEY (double) ;

  Store emittance for mode 2.

  void tfsDescriptors (std::ostream&)const ;

  Print the TFS descriptors for the beam.

  virtual void update () ;

  Update the BEAM data.