class PatchRep : public Patch

(Return to index)

Representation for a geometry patch.

Type:	Instantiable
Superclasses:	public Patch
Include file:	./BeamlineCore/PatchRep.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • PatchRep (const string&) ;
  • PatchRep () ;
  • PatchRep (const PatchRep&) ;
  • virtual ~PatchRep () ;
  • virtual ElementBase* clone ()const ;
  • virtual Channel* getChannel (const string&) ;
  • virtual NullField& getField () ;
  • virtual const NullField& getField ()const ;
  • virtual NullGeometry& getGeometry () ;
  • virtual const NullGeometry& getGeometry ()const ;
  • virtual const Euclid3D& getPatch ()const ;
  • void setPatch (const Euclid3D&) ;
  • void setPatch (double,double,double,double,double,double) ;
  • virtual ElementImage* getImage ()const ;
  • virtual const string& getType ()const ;
  • double getX ()const ;
  • double getY ()const ;
  • double getZ ()const ;
  • double getVX ()const ;
  • double getVY ()const ;
  • double getVZ ()const ;
  • void setX (double) ;
  • void setY (double) ;
  • void setZ (double) ;
  • void setVX (double) ;
  • void setVY (double) ;
  • void setVZ (double) ;
  • virtual void accept (BeamlineVisitor&)const ;
  • EVector Efield (const Point3D&)const ;
  • BVector Bfield (const Point3D&)const ;
  • EVector Efield (const Point3D&,double)const ;
  • BVector Bfield (const Point3D&,double)const ;
  • EBVectors EBfield (const Point3D&)const ;
  • EBVectors EBfield (const Point3D&,double)const ;
  • virtual const ElementBase& getDesign ()const ;
  • virtual void trackBunch (PartBunch&,const PartData&,bool,bool)const ;
  • virtual void trackMap (FVps<double,6>&,const PartData&,bool,bool)const ;
  • virtual const string& getName ()const ;
  • virtual void setName (const string&) ;
  • virtual double getArcLength ()const ;
  • virtual double getElementLength ()const ;
  • virtual void setElementLength (double) ;
  • virtual double getOrigin ()const ;
  • virtual double getEntrance ()const ;
  • virtual double getExit ()const ;
  • virtual Euclid3D getTransform (double,double)const ;
  • virtual Euclid3D getTransform (double)const ;
  • virtual Euclid3D getTotalTransform ()const ;
  • virtual Euclid3D getEntranceFrame ()const ;
  • virtual Euclid3D getExitFrame ()const ;
  • virtual Euclid3D getEntrancePatch ()const ;
  • virtual Euclid3D getExitPatch ()const ;
  • virtual double getAttribute (const string&)const ;
  • virtual bool hasAttribute (const string&)const ;
  • virtual void removeAttribute (const string&) ;
  • virtual void setAttribute (const string&,double) ;
  • virtual const ConstChannel* getConstChannel (const string&)const ;
  • virtual ElementBase* copyStructure () ;
  • bool isSharable ()const ;
  • virtual void makeSharable () ;
  • virtual ElementBase* makeAlignWrapper () ;
  • virtual ElementBase* makeFieldWrapper () ;
  • virtual ElementBase* makeWrappers () ;
  • virtual ElementBase* removeAlignWrapper () ;
  • virtual const ElementBase* removeAlignWrapper ()const ;
  • virtual ElementBase* removeFieldWrapper () ;
  • virtual const ElementBase* removeFieldWrapper ()const ;
  • virtual ElementBase* removeWrappers () ;
  • virtual const ElementBase* removeWrappers ()const ;
  • bool update (const AttributeSet&) ;
  • int addReference ()const ;
  • int removeReference ()const ;
  • bool isShared ()const ;

Documentation:

• Public members:

  PatchRep (const string&) ;

  Constructor with given name.

  virtual ElementBase* clone ()const ;

  Return clone.
  Return an identical deep copy of the element.

  virtual Channel* getChannel (const string&) ;

  Construct a read/write channel.
  This method constructs a Channel permitting read/write access to the attribute aKey and returns it. If the attribute does not exist, it returns NULL.

  virtual NullField& getField () ;

  Get field.
  Version for non-constant object.

  virtual const NullField& getField ()const ;

  Get field.
  Version for constant object.

  virtual NullGeometry& getGeometry () ;

  Get geometry.
  Version for non-constant object.

  virtual const NullGeometry& getGeometry ()const ;

  Get geometry.
  Version for constant object.

  virtual ElementImage* getImage ()const ;

  Construct an image.
  Return the image of the element, containing the name and type string of the element, and a copy of the user-defined attributes.

  virtual const Euclid3D& getPatch ()const ;

  Get patch.
  Return the geometric patch to transform from input to output.

  virtual const string& getType ()const ;

  Get element type string.

  double getVX ()const ;

  Get rotation.
  Return the rotation around the x-axis

  double getVY ()const ;

  Get rotation.
  Return the rotation around the y-axis

  double getVZ ()const ;

  Get rotation.
  Return the rotation around the z-axis

  double getX ()const ;

  Get displacement.
  Return the x-displacement.

  double getY ()const ;

  Get displacement.
  Return the y-displacement.

  double getZ ()const ;

  Get displacement.
  Return the z-displacement.

  void setPatch (const Euclid3D&) ;

  Set patch.
  Assign the geometric patch to transform from input to output.

  void setPatch (double,double,double,double,double,double) ;

  Set patch.
  Assign the geometric patch to transform from input to output, using the displacement (x,y,z) and the rotation vector (vx,vy,vz).

  void setVX (double) ;

  Set rotation.
  Assign the rotation around the x-axis

  void setVY (double) ;

  Set rotation.
  Assign the rotation around the y-axis

  void setVZ (double) ;

  Set rotation.
  Assign the rotation around the z-axis

  void setX (double) ;

  Set displacement.
  Assign the x-displacement.

  void setY (double) ;

  Set displacement.
  Assign the y-displacement.

  void setZ (double) ;

  Set displacement.
  Assign the z-displacement.