class StraightGeometry : public Geometry

(Return to index)

A geometry representing a straight line.

StraightGeometry represents a straight line segment along the local z-axis with no torsion. The origin is defined at the centre of the segment, and the geometry runs from -length/2 to +length/2. All transformations are correspondingly only simple translations along the z-axis.

Type:	Instantiable
Superclasses:	public Geometry
Include file:	./BeamlineGeometry/StraightGeometry.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • StraightGeometry (double) ;
  • StraightGeometry (const StraightGeometry&) ;
  • virtual ~StraightGeometry () ;
  • const StraightGeometry& operator= (const StraightGeometry&) ;
  • virtual double getArcLength ()const ;
  • virtual double getElementLength ()const ;
  • virtual void setElementLength (double) ;
  • double getOrigin ()const ;
  • double getEntrance ()const ;
  • double getExit ()const ;
  • Euclid3D getTransform (double,double)const ;
  • Euclid3D getTransform (double)const ;
  • Euclid3D getTotalTransform ()const ;
  • Euclid3D getEntranceFrame ()const ;
  • Euclid3D getExitFrame ()const ;
  • const Geometry& operator= (const Geometry&) ;
  • virtual Euclid3D getEntrancePatch ()const ;
  • virtual Euclid3D getExitPatch ()const ;

Documentation:

• Public members:

  StraightGeometry (double) ;

  Constructor.
  Using the length.

  virtual double getArcLength ()const ;

  Get arc length.
  Return the arc length, identical to the straight design length.

  virtual double getElementLength ()const ;

  Get design length.
  Return the straight design length.

  double getEntrance ()const ;

  Get entrance.
  Return the arc length from the origin to the entrance of the element (entrance <= 0)

  Euclid3D getEntranceFrame ()const ;

  Get transform.
  Equivalent to getTransform(0.0, getEntrance()). Return the transform of the local coordinate system from the origin to the entrance of the element.

  double getExit ()const ;

  Get exit.
  Return the arc length from the origin to the exit of the element (exit >= 0)

  Euclid3D getExitFrame ()const ;

  Get transform.
  Equivalent to getTransform(0.0, getExit()). Return the transform of the local coordinate system from the origin to the exit of the element.

  double getOrigin ()const ;

  Get origin.
  Return the arc length from the entrance to the origin of the element (origin >= 0)

  Euclid3D getTotalTransform ()const ;

  Get transform.
  Equivalent to getTransform(getEntrance(), getExit()). Return the transform of the local coordinate system from the entrance to the exit of the element.

  Euclid3D getTransform (double,double)const ;

  Get transform.
  Return the transform of the local coordinate system from the position fromS to the position toS.

  Euclid3D getTransform (double)const ;

  Get transform.
  Equivalent to getTransform(0.0, s). Return the transform of the local coordinate system from the origin and s.

  virtual void setElementLength (double) ;

  Set design length.
  Assign the straight design length.