class FlaggedElmPtr : public ElmPtr

(Return to index)

A section of a beam line.

A FlaggedBeamline is built as a list of FlaggedElmPtr objects. A FlaggedElmPtr contains two flags:

reflected

If true, this section of the line is reversed.

selected

Can be set to indicate a selected status for algorithms.

Type:	Instantiable
Superclasses:	public ElmPtr
Include file:	./Beamlines/FlaggedElmPtr.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • FlaggedElmPtr (const ElmPtr&,bool,bool) ;
  • FlaggedElmPtr (const FlaggedElmPtr&) ;
  • FlaggedElmPtr () ;
  • virtual ~FlaggedElmPtr () ;
  • virtual void accept (BeamlineVisitor&)const ;
  • inline int getCounter ()const ;
  • inline bool getReflectionFlag ()const ;
  • inline bool getSelectionFlag ()const ;
  • inline void setCounter (int)const ;
  • inline void setReflectionFlag (bool)const ;
  • inline void setSelectionFlag (bool)const ;
  • inline ElementBase* getElement ()const ;
  • inline void setElement (ElementBase*) ;
• Protected Members:
  • mutable int itsCounter ;
  • mutable bool isReflected ;
  • mutable bool isSelected ;
  • Pointer<ElementBase> itsElement ;

Documentation:

• Public members:

  FlaggedElmPtr (const ElmPtr&,bool,bool) ;

  Constructor.
  Assign an element to this beamline position.

  FlaggedElmPtr (const FlaggedElmPtr&) ;

  Copy constructor.

  virtual void accept (BeamlineVisitor&)const ;

  Apply visitor.
  If any error occurs, this method throws an exception.

  inline int getCounter ()const ;

  Get clone counter.
  Return the value set by the last call to setCounter(). See FlaggedElmPtr::itsCounter for details.

  inline bool getReflectionFlag ()const ;

  Get reflection flag.

  inline bool getSelectionFlag ()const ;

  Get selection flag.

  inline void setCounter (int)const ;

  Set clone counter.
  The value set is the entire responsibility of any algorithm using it. See FlaggedElmPtr::itsCounter for details.

  inline void setReflectionFlag (bool)const ;

  Set reflection flag.

  inline void setSelectionFlag (bool)const ;

  Get selection flag.

• Protected members:

  mutable bool isReflected ;

  The reflection flag.
  If true, the portion of the line pointed at by itsElement is reflected, i.e. its elements occur in reverse order.

  mutable bool isSelected ;

  The selection flag.
  This flag can be set to indicate a ``selected'' status for certain algorithms.

  mutable int itsCounter ;

  Clone counter.
  This value can be set and interrogated by an algorithm. It is not used by the CLASSIC library.