FRX SDK Documentation 2025 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
AcGeImpEllipArc3d Class Reference

#include <AcGeImpEllipArc3d.h>

Public Member Functions

 AcGeImpEllipArc3d (AcGeImpCurve3d const &, AcGeImpCurve3d const &, AcGeImpCurve3d const &, double &, double &, double &, int &)
 
 AcGeImpEllipArc3d (AcGeImpCurve3d const &, AcGeImpCurve3d const &, double, double &, double &, int &)
 
 AcGeImpEllipArc3d (AcGeImpEllipArc3d const &)
 
 AcGeImpEllipArc3d (AcGePoint3d const &, AcGePoint3d const &, AcGePoint3d const &)
 
 AcGeImpEllipArc3d (AcGePoint3d const &, AcGeVector3d const &, AcGeVector3d const &, double, double)
 
 AcGeImpEllipArc3d (AcGePoint3d const &, AcGeVector3d const &, AcGeVector3d const &, double, double, double, double)
 
 AcGeImpEllipArc3d (AcGePoint3d const &, AcGeVector3d const &, double)
 
 AcGeImpEllipArc3d (void)
 
AcGeImpCurve3dsetInterval (AcGePoint3d const &, AcGePoint3d const &, int, AcGeTol const &=AcGeContext::gTol)
 
AcGeImpEllipArc3doperator= (AcGeImpEllipArc3d const &)
 
AcGeImpEllipArc3dset (AcGeImpCurve3d const &, AcGeImpCurve3d const &, AcGeImpCurve3d const &, double &, double &, double &, int &)
 
AcGeImpEllipArc3dset (AcGeImpCurve3d const &, AcGeImpCurve3d const &, double, double &, double &, int &)
 
AcGeImpEllipArc3dset (AcGePoint3d const &, AcGePoint3d const &, AcGePoint3d const &)
 
AcGeImpEllipArc3dset (AcGePoint3d const &, AcGeVector3d const &, AcGeVector3d const &, double, double)
 
AcGeImpEllipArc3dset (AcGePoint3d const &, AcGeVector3d const &, AcGeVector3d const &, double, double, double, double)
 
AcGeImpEllipArc3dset (AcGePoint3d const &, AcGeVector3d const &, double)
 
AcGeImpEllipArc3dsetAngles (double, double, int)
 
AcGeImpEllipArc3dsetAxes (AcGeVector3d const &, AcGeVector3d const &)
 
AcGeImpEllipArc3dsetCenter (AcGePoint3d const &)
 
AcGeImpEllipArc3dsetRadii (double, double)
 
AcGePoint3d center (void) const
 
AcGePoint3d endPoint (void) const
 
AcGePoint3d startPoint (void) const
 
AcGeVector3d majorAxis (void) const
 
AcGeVector3d minorAxis (void) const
 
AcGeVector3d normal (void) const
 
double endAngle (void) const
 
double majorRadius (void) const
 
double minorRadius (void) const
 
double startAngle (void) const
 
int intersectWithArc (AcGeImpEllipArc3d const &, int &, AcGePoint3d &, AcGePoint3d &, int &, AcGeTol const &=AcGeContext::gTol) const
 
int intersectWithLine (AcGeImpLinearEnt3d const &, int &, AcGePoint3d &, AcGePoint3d &, int &, AcGeTol const &=AcGeContext::gTol) const
 
int intersectWithPlane (AcGeImpPlanarEnt const &, int &, AcGePoint3d &, AcGePoint3d &, int &, AcGeTol const &=AcGeContext::gTol) const
 
int isCircular (AcGeTol const &=AcGeContext::gTol) const
 
int isInside (AcGePoint3d const &, AcGeTol const &=AcGeContext::gTol) const
 
int isPlanar (AcGeTol const &=AcGeContext::gTol) const
 
int projIntersectWith (AcGeImpLinearEnt3d const &, AcGeVector3d const &, int &, AcGePoint3d &, AcGePoint3d &, AcGePoint3d &, AcGePoint3d &, AcGeTol const &=AcGeContext::gTol) const
 
int tangent (AcGePoint3d const &, AcGeImpLinearEnt3d &, AcGeTol const &=AcGeContext::gTol) const
 
int tangent (AcGePoint3d const &, AcGeImpPointOnCurve3d &, AcGeImpPointOnCurve3d &, AcGeTol const &=AcGeContext::gTol) const
 
virtual ~AcGeImpEllipArc3d (void)
 
virtual AcGeImpBoundBlock3d boundBlock (int, AcGeImpInterval const &, int) const
 
virtual AcGeImpCurve3dreverseParam (void)
 
virtual AcGeImpCurve3dsetInterval (AcGeImpInterval const &, int)
 
virtual AcGeImpCurve3dsetInterval (void)
 
virtual AcGeImpEntity3dscaleBy (double, AcGePoint3d const &)
 
virtual AcGeImpEntity3dtransformBy (AcGeMatrix3d const &)
 
virtual AcGeImpEntity3dtranslateBy (AcGeVector3d const &)
 
virtual AcGeImpEntity3dexactOffset (double, AcGeVector3d const &, AcGeDoubleArray *, AcGeDoubleArray *, AcGe::OffsetCrvExtType, AcGeTol const &=AcGeContext::gTol) const
 
virtual AcGeImpEntity3dproject (AcGeImpPlanarEnt const &, AcGeVector3d const &, AcGeTol const &=AcGeContext::gTol) const
 
virtual AcGeImpObjectcopy (void) const
 
virtual AcGePoint3d closestPointTo (AcGePoint3d const &, AcGeTol const &=AcGeContext::gTol) const
 
virtual AcGePoint3d evalPoint (double) const
 
virtual AcGePoint3d evalPoint (double, int, AcArray< AcGeVector3d, AcArrayMemCopyReallocator< AcGeVector3d > > &) const
 
virtual double length (double, double, double) const
 
virtual double paramAtLength (double, double, int, double) const
 
virtual double paramOf (AcGePoint3d const &, AcGeTol const &=AcGeContext::gTol) const
 
virtual AcGe::EntityId type (int) const
 
virtual int area (double, double, double &, AcGeTol const &=AcGeContext::gTol) const
 
virtual int getNormalPoint (AcGePoint3d const &, AcGeImpPointOnCurve3d &, AcGeTol const &=AcGeContext::gTol) const
 
virtual int intersectSelf (AcGeCurveIntData &, AcGeVector3d const &, double, AcGeTol const &=AcGeContext::gTol) const
 
virtual int intersectWith (AcGeImpCurve3d const &, AcGeVector3d const &, AcGeCurveIntData &, AcGeTol const &=AcGeContext::gTol) const
 
virtual int intersectWith (AcGeImpInterval const &, AcGeImpInterval const &, AcGeVector3d const &, AcGeCurveIntData &, AcGeTol const &=AcGeContext::gTol) const
 
virtual int isClosed (AcGeTol const &=AcGeContext::gTol) const
 
virtual int isDegenerate (AcGeImpEntity3d *&, AcGeTol const &=AcGeContext::gTol) const
 
virtual int isDegenerate (AcGe::EntityId &, AcGeTol const &=AcGeContext::gTol) const
 
virtual int isEqualTo (AcGeImpEntity3d const &, AcGeTol const &=AcGeContext::gTol) const
 
virtual int isLinear (AcGeImpLinearEnt3d &, AcGeTol const &=AcGeContext::gTol) const
 
virtual int isOn (AcGePoint3d const &, AcGeTol const &=AcGeContext::gTol) const
 
virtual int isOn (AcGePoint3d const &, double &, AcGeTol const &=AcGeContext::gTol) const
 
virtual int isOn (double, AcGeTol const &=AcGeContext::gTol) const
 
virtual int isPeriodic (double &, int) const
 
virtual int isPlanar (AcGeImpPlanarEnt &, AcGeTol const &=AcGeContext::gTol) const
 
virtual int unboundedOverlap (AcGeImpCurve3d const &, int &, AcGeTol const &=AcGeContext::gTol) const
 
virtual voidgetExternalEntity (void) const
 
virtual void getClosestPointTo (AcGeImpCurve3d const &, AcGeImpPointOnCurve3d &, AcGeImpPointOnCurve3d &, AcGeTol const &=AcGeContext::gTol) const
 
virtual void getClosestPointTo (AcGePoint3d const &, AcGeImpPointOnCurve3d &, AcGeTol const &=AcGeContext::gTol) const
 
virtual void getInterval (AcGeImpInterval &, AcGePoint3d &, AcGePoint3d &) const
 
virtual void getInterval (AcGeImpInterval &, int, int) const
 
virtual void getSamplePoints (double, double, double, AcGeImpPointOnCurve3d &, AcArray< AcGePoint3d, AcArrayMemCopyReallocator< AcGePoint3d > > &, AcGeDoubleArray &, AcArray< AcGeVector3d, AcArrayMemCopyReallocator< AcGeVector3d > > *, AcArray< AcGeVector3d, AcArrayMemCopyReallocator< AcGeVector3d > > *) const
 
virtual void getSplitCurves (double, AcGeImpCurve3d *&, AcGeImpCurve3d *&) const
 
void getClosestPointToArc (AcGeImpEllipArc3d const &, AcGeImpPointOnCurve3d &, AcGeImpPointOnCurve3d &, AcGeTol const &=AcGeContext::gTol) const
 
void getClosestPointToLine (AcGeImpLinearEnt3d const &, AcGeImpPointOnCurve3d &, AcGeImpPointOnCurve3d &, AcGeTol const &=AcGeContext::gTol) const
 
void getPlane (AcGeImpPlanarEnt &) const
 

Detailed Description

Definition at line 37 of file AcGeImpEllipArc3d.h.

Constructor & Destructor Documentation

◆ AcGeImpEllipArc3d() [1/8]

AcGeImpEllipArc3d::AcGeImpEllipArc3d ( AcGeImpCurve3d const & ,
AcGeImpCurve3d const & ,
AcGeImpCurve3d const & ,
double & ,
double & ,
double & ,
int &  )

◆ AcGeImpEllipArc3d() [2/8]

AcGeImpEllipArc3d::AcGeImpEllipArc3d ( AcGeImpCurve3d const & ,
AcGeImpCurve3d const & ,
double ,
double & ,
double & ,
int &  )

◆ AcGeImpEllipArc3d() [3/8]

AcGeImpEllipArc3d::AcGeImpEllipArc3d ( AcGeImpEllipArc3d const & )

◆ AcGeImpEllipArc3d() [4/8]

AcGeImpEllipArc3d::AcGeImpEllipArc3d ( AcGePoint3d const & ,
AcGePoint3d const & ,
AcGePoint3d const &  )

◆ AcGeImpEllipArc3d() [5/8]

AcGeImpEllipArc3d::AcGeImpEllipArc3d ( AcGePoint3d const & ,
AcGeVector3d const & ,
AcGeVector3d const & ,
double ,
double  )

◆ AcGeImpEllipArc3d() [6/8]

AcGeImpEllipArc3d::AcGeImpEllipArc3d ( AcGePoint3d const & ,
AcGeVector3d const & ,
AcGeVector3d const & ,
double ,
double ,
double ,
double  )

◆ AcGeImpEllipArc3d() [7/8]

AcGeImpEllipArc3d::AcGeImpEllipArc3d ( AcGePoint3d const & ,
AcGeVector3d const & ,
double  )

◆ AcGeImpEllipArc3d() [8/8]

AcGeImpEllipArc3d::AcGeImpEllipArc3d ( void )

◆ ~AcGeImpEllipArc3d()

virtual AcGeImpEllipArc3d::~AcGeImpEllipArc3d ( void )
virtual

Member Function Documentation

◆ area()

virtual int AcGeImpEllipArc3d::area ( double ,
double ,
double & ,
AcGeTol const & = AcGeContext::gTol ) const
virtual

◆ boundBlock()

virtual AcGeImpBoundBlock3d AcGeImpEllipArc3d::boundBlock ( int ,
AcGeImpInterval const & ,
int  ) const
virtual

◆ center()

AcGePoint3d AcGeImpEllipArc3d::center ( void ) const

◆ closestPointTo()

virtual AcGePoint3d AcGeImpEllipArc3d::closestPointTo ( AcGePoint3d const & ,
AcGeTol const & = AcGeContext::gTol ) const
virtual

◆ copy()

virtual AcGeImpObject * AcGeImpEllipArc3d::copy ( void ) const
virtual

◆ endAngle()

double AcGeImpEllipArc3d::endAngle ( void ) const

◆ endPoint()

AcGePoint3d AcGeImpEllipArc3d::endPoint ( void ) const

◆ evalPoint() [1/2]

virtual AcGePoint3d AcGeImpEllipArc3d::evalPoint ( double ) const
virtual

◆ evalPoint() [2/2]

virtual AcGePoint3d AcGeImpEllipArc3d::evalPoint ( double ,
int ,
AcArray< AcGeVector3d, AcArrayMemCopyReallocator< AcGeVector3d > > &  ) const
virtual

◆ exactOffset()

virtual AcGeImpEntity3d * AcGeImpEllipArc3d::exactOffset ( double ,
AcGeVector3d const & ,
AcGeDoubleArray * ,
AcGeDoubleArray * ,
AcGe::OffsetCrvExtType ,
AcGeTol const & = AcGeContext::gTol ) const
virtual

◆ getClosestPointTo() [1/2]

virtual void AcGeImpEllipArc3d::getClosestPointTo ( AcGeImpCurve3d const & ,
AcGeImpPointOnCurve3d & ,
AcGeImpPointOnCurve3d & ,
AcGeTol const & = AcGeContext::gTol ) const
virtual

◆ getClosestPointTo() [2/2]

virtual void AcGeImpEllipArc3d::getClosestPointTo ( AcGePoint3d const & ,
AcGeImpPointOnCurve3d & ,
AcGeTol const & = AcGeContext::gTol ) const
virtual

◆ getClosestPointToArc()

void AcGeImpEllipArc3d::getClosestPointToArc ( AcGeImpEllipArc3d const & ,
AcGeImpPointOnCurve3d & ,
AcGeImpPointOnCurve3d & ,
AcGeTol const & = AcGeContext::gTol ) const

◆ getClosestPointToLine()

void AcGeImpEllipArc3d::getClosestPointToLine ( AcGeImpLinearEnt3d const & ,
AcGeImpPointOnCurve3d & ,
AcGeImpPointOnCurve3d & ,
AcGeTol const & = AcGeContext::gTol ) const

◆ getExternalEntity()

virtual void * AcGeImpEllipArc3d::getExternalEntity ( void ) const
virtual

◆ getInterval() [1/2]

virtual void AcGeImpEllipArc3d::getInterval ( AcGeImpInterval & ,
AcGePoint3d & ,
AcGePoint3d &  ) const
virtual

◆ getInterval() [2/2]

virtual void AcGeImpEllipArc3d::getInterval ( AcGeImpInterval & ,
int ,
int  ) const
virtual

◆ getNormalPoint()

virtual int AcGeImpEllipArc3d::getNormalPoint ( AcGePoint3d const & ,
AcGeImpPointOnCurve3d & ,
AcGeTol const & = AcGeContext::gTol ) const
virtual

◆ getPlane()

void AcGeImpEllipArc3d::getPlane ( AcGeImpPlanarEnt & ) const

◆ getSamplePoints()

◆ getSplitCurves()

virtual void AcGeImpEllipArc3d::getSplitCurves ( double ,
AcGeImpCurve3d *& ,
AcGeImpCurve3d *&  ) const
virtual

◆ intersectSelf()

virtual int AcGeImpEllipArc3d::intersectSelf ( AcGeCurveIntData & ,
AcGeVector3d const & ,
double ,
AcGeTol const & = AcGeContext::gTol ) const
virtual

◆ intersectWith() [1/2]

virtual int AcGeImpEllipArc3d::intersectWith ( AcGeImpCurve3d const & ,
AcGeVector3d const & ,
AcGeCurveIntData & ,
AcGeTol const & = AcGeContext::gTol ) const
virtual

◆ intersectWith() [2/2]

virtual int AcGeImpEllipArc3d::intersectWith ( AcGeImpInterval const & ,
AcGeImpInterval const & ,
AcGeVector3d const & ,
AcGeCurveIntData & ,
AcGeTol const & = AcGeContext::gTol ) const
virtual

◆ intersectWithArc()

int AcGeImpEllipArc3d::intersectWithArc ( AcGeImpEllipArc3d const & ,
int & ,
AcGePoint3d & ,
AcGePoint3d & ,
int & ,
AcGeTol const & = AcGeContext::gTol ) const

◆ intersectWithLine()

int AcGeImpEllipArc3d::intersectWithLine ( AcGeImpLinearEnt3d const & ,
int & ,
AcGePoint3d & ,
AcGePoint3d & ,
int & ,
AcGeTol const & = AcGeContext::gTol ) const

◆ intersectWithPlane()

int AcGeImpEllipArc3d::intersectWithPlane ( AcGeImpPlanarEnt const & ,
int & ,
AcGePoint3d & ,
AcGePoint3d & ,
int & ,
AcGeTol const & = AcGeContext::gTol ) const

◆ isCircular()

int AcGeImpEllipArc3d::isCircular ( AcGeTol const & = AcGeContext::gTol) const

◆ isClosed()

virtual int AcGeImpEllipArc3d::isClosed ( AcGeTol const & = AcGeContext::gTol) const
virtual

◆ isDegenerate() [1/2]

virtual int AcGeImpEllipArc3d::isDegenerate ( AcGe::EntityId & ,
AcGeTol const & = AcGeContext::gTol ) const
virtual

◆ isDegenerate() [2/2]

virtual int AcGeImpEllipArc3d::isDegenerate ( AcGeImpEntity3d *& ,
AcGeTol const & = AcGeContext::gTol ) const
virtual

◆ isEqualTo()

virtual int AcGeImpEllipArc3d::isEqualTo ( AcGeImpEntity3d const & ,
AcGeTol const & = AcGeContext::gTol ) const
virtual

◆ isInside()

int AcGeImpEllipArc3d::isInside ( AcGePoint3d const & ,
AcGeTol const & = AcGeContext::gTol ) const

◆ isLinear()

virtual int AcGeImpEllipArc3d::isLinear ( AcGeImpLinearEnt3d & ,
AcGeTol const & = AcGeContext::gTol ) const
virtual

◆ isOn() [1/3]

virtual int AcGeImpEllipArc3d::isOn ( AcGePoint3d const & ,
AcGeTol const & = AcGeContext::gTol ) const
virtual

◆ isOn() [2/3]

virtual int AcGeImpEllipArc3d::isOn ( AcGePoint3d const & ,
double & ,
AcGeTol const & = AcGeContext::gTol ) const
virtual

◆ isOn() [3/3]

virtual int AcGeImpEllipArc3d::isOn ( double ,
AcGeTol const & = AcGeContext::gTol ) const
virtual

◆ isPeriodic()

virtual int AcGeImpEllipArc3d::isPeriodic ( double & ,
int  ) const
virtual

◆ isPlanar() [1/2]

virtual int AcGeImpEllipArc3d::isPlanar ( AcGeImpPlanarEnt & ,
AcGeTol const & = AcGeContext::gTol ) const
virtual

◆ isPlanar() [2/2]

int AcGeImpEllipArc3d::isPlanar ( AcGeTol const & = AcGeContext::gTol) const

◆ length()

virtual double AcGeImpEllipArc3d::length ( double ,
double ,
double  ) const
virtual

◆ majorAxis()

AcGeVector3d AcGeImpEllipArc3d::majorAxis ( void ) const

◆ majorRadius()

double AcGeImpEllipArc3d::majorRadius ( void ) const

◆ minorAxis()

AcGeVector3d AcGeImpEllipArc3d::minorAxis ( void ) const

◆ minorRadius()

double AcGeImpEllipArc3d::minorRadius ( void ) const

◆ normal()

AcGeVector3d AcGeImpEllipArc3d::normal ( void ) const

◆ operator=()

AcGeImpEllipArc3d & AcGeImpEllipArc3d::operator= ( AcGeImpEllipArc3d const & )

◆ paramAtLength()

virtual double AcGeImpEllipArc3d::paramAtLength ( double ,
double ,
int ,
double  ) const
virtual

◆ paramOf()

virtual double AcGeImpEllipArc3d::paramOf ( AcGePoint3d const & ,
AcGeTol const & = AcGeContext::gTol ) const
virtual

◆ project()

virtual AcGeImpEntity3d * AcGeImpEllipArc3d::project ( AcGeImpPlanarEnt const & ,
AcGeVector3d const & ,
AcGeTol const & = AcGeContext::gTol ) const
virtual

◆ projIntersectWith()

int AcGeImpEllipArc3d::projIntersectWith ( AcGeImpLinearEnt3d const & ,
AcGeVector3d const & ,
int & ,
AcGePoint3d & ,
AcGePoint3d & ,
AcGePoint3d & ,
AcGePoint3d & ,
AcGeTol const & = AcGeContext::gTol ) const

◆ reverseParam()

virtual AcGeImpCurve3d & AcGeImpEllipArc3d::reverseParam ( void )
virtual

◆ scaleBy()

virtual AcGeImpEntity3d & AcGeImpEllipArc3d::scaleBy ( double ,
AcGePoint3d const &  )
virtual

◆ set() [1/6]

AcGeImpEllipArc3d & AcGeImpEllipArc3d::set ( AcGeImpCurve3d const & ,
AcGeImpCurve3d const & ,
AcGeImpCurve3d const & ,
double & ,
double & ,
double & ,
int &  )

◆ set() [2/6]

AcGeImpEllipArc3d & AcGeImpEllipArc3d::set ( AcGeImpCurve3d const & ,
AcGeImpCurve3d const & ,
double ,
double & ,
double & ,
int &  )

◆ set() [3/6]

AcGeImpEllipArc3d & AcGeImpEllipArc3d::set ( AcGePoint3d const & ,
AcGePoint3d const & ,
AcGePoint3d const &  )

◆ set() [4/6]

AcGeImpEllipArc3d & AcGeImpEllipArc3d::set ( AcGePoint3d const & ,
AcGeVector3d const & ,
AcGeVector3d const & ,
double ,
double  )

◆ set() [5/6]

AcGeImpEllipArc3d & AcGeImpEllipArc3d::set ( AcGePoint3d const & ,
AcGeVector3d const & ,
AcGeVector3d const & ,
double ,
double ,
double ,
double  )

◆ set() [6/6]

AcGeImpEllipArc3d & AcGeImpEllipArc3d::set ( AcGePoint3d const & ,
AcGeVector3d const & ,
double  )

◆ setAngles()

AcGeImpEllipArc3d & AcGeImpEllipArc3d::setAngles ( double ,
double ,
int  )

◆ setAxes()

AcGeImpEllipArc3d & AcGeImpEllipArc3d::setAxes ( AcGeVector3d const & ,
AcGeVector3d const &  )

◆ setCenter()

AcGeImpEllipArc3d & AcGeImpEllipArc3d::setCenter ( AcGePoint3d const & )

◆ setInterval() [1/3]

virtual AcGeImpCurve3d & AcGeImpEllipArc3d::setInterval ( AcGeImpInterval const & ,
int  )
virtual

◆ setInterval() [2/3]

AcGeImpCurve3d & AcGeImpEllipArc3d::setInterval ( AcGePoint3d const & ,
AcGePoint3d const & ,
int ,
AcGeTol const & = AcGeContext::gTol )

◆ setInterval() [3/3]

virtual AcGeImpCurve3d & AcGeImpEllipArc3d::setInterval ( void )
virtual

◆ setRadii()

AcGeImpEllipArc3d & AcGeImpEllipArc3d::setRadii ( double ,
double  )

◆ startAngle()

double AcGeImpEllipArc3d::startAngle ( void ) const

◆ startPoint()

AcGePoint3d AcGeImpEllipArc3d::startPoint ( void ) const

◆ tangent() [1/2]

int AcGeImpEllipArc3d::tangent ( AcGePoint3d const & ,
AcGeImpLinearEnt3d & ,
AcGeTol const & = AcGeContext::gTol ) const

◆ tangent() [2/2]

int AcGeImpEllipArc3d::tangent ( AcGePoint3d const & ,
AcGeImpPointOnCurve3d & ,
AcGeImpPointOnCurve3d & ,
AcGeTol const & = AcGeContext::gTol ) const

◆ transformBy()

virtual AcGeImpEntity3d & AcGeImpEllipArc3d::transformBy ( AcGeMatrix3d const & )
virtual

◆ translateBy()

virtual AcGeImpEntity3d & AcGeImpEllipArc3d::translateBy ( AcGeVector3d const & )
virtual

◆ type()

virtual AcGe::EntityId AcGeImpEllipArc3d::type ( int ) const
virtual

◆ unboundedOverlap()

virtual int AcGeImpEllipArc3d::unboundedOverlap ( AcGeImpCurve3d const & ,
int & ,
AcGeTol const & = AcGeContext::gTol ) const
virtual

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