Version: 9.12.0
Classes | Public Member Functions | Private Slots | Private Member Functions | Private Attributes | List of all members
RepairGUI_InspectObjectDlg Class Reference

#include <RepairGUI_InspectObjectDlg.h>

Inheritance diagram for RepairGUI_InspectObjectDlg:
Inheritance graph

Classes

class  Delegate
 
class  TreeWidgetItem
 

Public Member Functions

 RepairGUI_InspectObjectDlg (GeometryGUI *, SUIT_Desktop *)
 
 ~RepairGUI_InspectObjectDlg ()
 
- Public Member Functions inherited from GEOMBase_Helper
 GEOMBase_Helper (SUIT_Desktop *, SUIT_ViewWindow *aVW=0)
 
virtual ~GEOMBase_Helper ()
 

Private Slots

void onEditMainShape ()
 
void onItemClicked (QTreeWidgetItem *, int)
 
void onItemChanged (QTreeWidgetItem *, int)
 
void onItemSelectionChanged ()
 
void onItemExpanded (QTreeWidgetItem *)
 
void onHeaderClicked (int)
 
void onViewSelectionChanged ()
 
void onWindowActivated (SUIT_ViewWindow *)
 
void onCloseView (SUIT_ViewWindow *)
 
void clickOnShow ()
 
void clickOnShowOnly ()
 
void clickOnHide ()
 
void clickOnPublish ()
 
void clickOnHelp ()
 
void clickOnResetToMin ()
 
void clickOnResetToMax ()
 
void clickOnShowAll ()
 
void clickOnHideAll ()
 
void DeactivateActiveDialog ()
 
void ActivateThisDialog ()
 
void onFilterToggled (bool)
 
void onInitFilteredData ()
 
void onFilterData ()
 

Private Member Functions

void createTreeWidget (QTreeWidget *&theTreeObjects)
 
void init ()
 
void initSpinBox (SalomeApp_DoubleSpinBox *spinBox, double min, double max, double step, const char *quantity)
 
void initTreeWidget (QTreeWidget *theTopLevelItem)
 
void enterEvent (QEvent *)
 
void checkVisibleIcon ()
 
void addSubObjects (TreeWidgetItem *, const TopTools_IndexedMapOfShape &)
 
void displayItem (TreeWidgetItem *)
 
void setItemDisplayStatus (TreeWidgetItem *theItem, bool theIsVisible)
 
void setMainObjectTransparency (double)
 
void restoreParam ()
 
void updateViewer (const bool theIsHideOtherTree)
 

Private Attributes

QPointer< SUIT_ViewWindow > myViewWindow
 
GeometryGUI * myGeomGUI
 
QIcon myVisible
 
QIcon myInvisible
 
QTreeWidget * myTreeObjects
 
QTreeWidget * myFilteredTreeObjects
 
QTreeWidget * myCurrentTreeObjects
 
QLineEdit * myEditMainShape
 
QGroupBox * myTolFilterGrp
 
QButtonGroup * myShapeTypeBtnGrp
 
QComboBox * myComparisonCompo
 
SalomeApp_DoubleSpinBox * myTolEdit
 
QLabel * myMinTolValLabel
 
QLabel * myMaxTolValLabel
 
QStackedLayout * myTreesLayout
 
QPushButton * myMinTolResetBtn
 
QPushButton * myMaxTolResetBtn
 
double myMaxTol
 
double myMinTol
 
bool myIsSelectAll
 
double myTransparency
 

Additional Inherited Members

- Static Public Member Functions inherited from GEOMBase_Helper
static SUIT_ViewWindow * getActiveView ()
 
- Protected Types inherited from GEOMBase_Helper
typedef std::list< SALOME_Prs * > PrsList
 
- Protected Member Functions inherited from GEOMBase_Helper
void display (const ObjectList &, const bool=true)
 
void display (GEOM::GEOM_Object_ptr, const bool=true)
 
void erase (const ObjectList &, const bool=true)
 
void erase (GEOM::GEOM_Object_ptr, const bool=true)
 
void redisplay (const ObjectList &, const bool=true, const bool=true)
 
void redisplay (GEOM::GEOM_Object_ptr, const bool=true, const bool=true)
 
virtual void displayPreview (const bool display, const bool activate=false, const bool update=true, const bool toRemoveFromEngine=true, const double lineWidth=-1, const int displayMode=-1, const int color=-1, const bool append=false)
 
virtual void displayPreview (GEOM::GEOM_Object_ptr obj, const bool append=false, const bool activate=false, const bool update=true, const double lineWidth=-1, const int displayMode=-1, const int color=-1)
 
void displayPreview (const SALOME_Prs *prs, const bool append=false, const bool=true)
 
void erasePreview (const bool=true)
 
const PrsList & getPreview () const
 
void localSelection (const ObjectList &, const std::list< int >)
 
void localSelection (const ObjectList &, const int)
 
void localSelection (GEOM::GEOM_Object_ptr, const std::list< int >)
 
void localSelection (GEOM::GEOM_Object_ptr, const int)
 
void localSelection (const std::string &, const std::string &, const std::list< int >)
 
void localSelection (const std::list< int >)
 
void localSelection (const int)
 
void activate (const int)
 
void globalSelection (const int=GEOM_ALLOBJECTS, const bool=false)
 
void globalSelection (const TColStd_MapOfInteger &, const bool=false)
 
void globalSelection (const TColStd_MapOfInteger &, const QList< int > &, const bool=false)
 
void updateViewer ()
 
void prepareSelection (const ObjectList &, const int)
 
void prepareSelection (GEOM::GEOM_Object_ptr, const int)
 
QString addInStudy (GEOM::GEOM_Object_ptr, const char *theName)
 
bool openCommand ()
 
bool abortCommand ()
 
bool commitCommand (const char *=0)
 
bool hasCommand () const
 
void updateObjBrowser () const
 
SalomeApp_Study * getStudy () const
 
bool checkViewWindow ()
 
bool onAccept (const bool publish=true, const bool useTransaction=true, bool erasePreviewFlag=true)
 
void showError ()
 
void showError (const QString &msg)
 
GEOM::GEOM_IOperations_ptr getOperation ()
 
void setPrefix (const QString &prefix)
 
QString getPrefix (GEOM::GEOM_Object_ptr=GEOM::GEOM_Object::_nil()) const
 
bool selectObjects (ObjectList &objects)
 
virtual GEOM::GEOM_IOperations_ptr createOperation ()
 
virtual bool isValid (QString &msg)
 
virtual bool execute (ObjectList &objects)
 
virtual void restoreSubShapes (SALOMEDS::SObject_ptr theSObject)
 
virtual GEOM::GEOM_Object_ptr getFather (GEOM::GEOM_Object_ptr theObj)
 
virtual QString getNewObjectName (int CurrObj=-1) const
 
virtual QString getObjectName (GEOM::GEOM_Object_ptr object) const
 
virtual bool extractPrefix () const
 
virtual void addSubshapesToStudy ()
 
virtual QList< GEOM::GeomObjPtr > getSourceObjects ()
 
GEOM::GEOM_Object_ptr findObjectInFather (GEOM::GEOM_Object_ptr theFather, const QString &theName)
 
GEOM::GEOM_Object_ptr findObjectInFather (GEOM::GEOM_Object_ptr theFather, int theIndex)
 
GEOM::GeomObjPtr getSelected (TopAbs_ShapeEnum type)
 
GEOM::GeomObjPtr getSelected (const QList< TopAbs_ShapeEnum > &types)
 
QList< GEOM::GeomObjPtr > getSelected (TopAbs_ShapeEnum type, int count, bool strict=true)
 
QList< GEOM::GeomObjPtr > getSelected (const QList< TopAbs_ShapeEnum > &types, int count, bool strict=true)
 
void hideSourceObjects (QList< GEOM::GeomObjPtr > theObjectList)
 
void SetIsPreview (const bool thePreview)
 
bool IsPreview ()
 
GEOM_Displayer * getDisplayer ()
 
SUIT_Desktop * getDesktop () const
 
virtual void setIsApplyAndClose (const bool theFlag)
 
virtual bool isApplyAndClose () const
 
virtual void setIsOptimizedBrowsing (const bool theFlag)
 
virtual bool isOptimizedBrowsing () const
 
virtual void setIsWaitCursorEnabled (const bool theFlag)
 
virtual bool isWaitCursorEnabled () const
 
virtual void setIsDisableBrowsing (const bool theFlag)
 
virtual bool isDisableBrowsing () const
 
virtual void setIsDisplayResult (const bool theFlag)
 
virtual bool isDisplayResult () const
 
- Static Protected Member Functions inherited from GEOMBase_Helper
static GEOM::GEOM_Gen_ptr getGeomEngine ()
 

Constructor & Destructor Documentation

◆ RepairGUI_InspectObjectDlg()

RepairGUI_InspectObjectDlg::RepairGUI_InspectObjectDlg ( GeometryGUI *  theGeomGUI,
SUIT_Desktop *  parent 
)

References clickOnHelp(), clickOnHide(), clickOnHideAll(), clickOnPublish(), clickOnShow(), clickOnShowAll(), clickOnShowOnly(), createTreeWidget(), init(), myComparisonCompo, myEditMainShape, myFilteredTreeObjects, myGeomGUI, myInvisible, myMaxTolResetBtn, myMaxTolValLabel, myMinTolResetBtn, myMinTolValLabel, myShapeTypeBtnGrp, myTolEdit, myTolFilterGrp, myTreeObjects, myTreesLayout, myViewWindow, myVisible, onEditMainShape(), TYPE_EDGE, TYPE_FACE, and TYPE_VERTEX.

◆ ~RepairGUI_InspectObjectDlg()

RepairGUI_InspectObjectDlg::~RepairGUI_InspectObjectDlg ( )

References GEOMBase_Helper::getDisplayer(), myViewWindow, onEditMainShape(), GEOM_Displayer::UnsetColor(), and GEOM_Displayer::UnsetWidth().

Member Function Documentation

◆ ActivateThisDialog

void RepairGUI_InspectObjectDlg::ActivateThisDialog ( )
privateslot

References GeometryGUI::EmitSignalDeactivateDialog(), myGeomGUI, onViewSelectionChanged(), GeometryGUI::SetActiveDialogBox(), and GEOMBase_Helper::updateViewer().

◆ addSubObjects()

void RepairGUI_InspectObjectDlg::addSubObjects ( TreeWidgetItem *  theParentItem,
const TopTools_IndexedMapOfShape &  theIndices 
)
private

References RepairGUI_InspectObjectDlg::TreeWidgetItem::getShape(), myInvisible, myTreeObjects, RepairGUI_InspectObjectDlg::TreeWidgetItem::setVisible(), and theIndices.

◆ checkVisibleIcon()

void RepairGUI_InspectObjectDlg::checkVisibleIcon ( )
private

References RepairGUI_InspectObjectDlg::TreeWidgetItem::isVisible(), myCurrentTreeObjects, myInvisible, myIsSelectAll, and myVisible.

◆ clickOnHelp

void RepairGUI_InspectObjectDlg::clickOnHelp ( )
privateslot

References myGeomGUI.

◆ clickOnHide

void RepairGUI_InspectObjectDlg::clickOnHide ( )
privateslot

References checkVisibleIcon(), GEOM_Displayer::Erase(), GEOMBase_Helper::getDisplayer(), RepairGUI_InspectObjectDlg::TreeWidgetItem::isVisible(), myCurrentTreeObjects, myViewWindow, and setItemDisplayStatus().

◆ clickOnHideAll

void RepairGUI_InspectObjectDlg::clickOnHideAll ( )
privateslot

References myIsSelectAll, and onHeaderClicked().

◆ clickOnPublish

void RepairGUI_InspectObjectDlg::clickOnPublish ( )
privateslot

References GEOMBase::ConvertIOinGEOMObject(), GEOMBase_Helper::getGeomEngine(), GeometryGUI::GetGeomGen(), GEOMBase::GetIndex(), RepairGUI_InspectObjectDlg::TreeWidgetItem::getShape(), myCurrentTreeObjects, and GEOMBase_Helper::updateObjBrowser().

◆ clickOnResetToMax

void RepairGUI_InspectObjectDlg::clickOnResetToMax ( )
privateslot

References myMaxTol, and myTolEdit.

◆ clickOnResetToMin

void RepairGUI_InspectObjectDlg::clickOnResetToMin ( )
privateslot

References myMinTol, and myTolEdit.

◆ clickOnShow

void RepairGUI_InspectObjectDlg::clickOnShow ( )
privateslot

References checkVisibleIcon(), displayItem(), GEOMBase_Helper::getDisplayer(), RepairGUI_InspectObjectDlg::TreeWidgetItem::isVisible(), myCurrentTreeObjects, myViewWindow, and setItemDisplayStatus().

◆ clickOnShowAll

void RepairGUI_InspectObjectDlg::clickOnShowAll ( )
privateslot

References myIsSelectAll, and onHeaderClicked().

◆ clickOnShowOnly

void RepairGUI_InspectObjectDlg::clickOnShowOnly ( )
privateslot

References clickOnShow(), GEOM_Displayer::Erase(), GEOMBase_Helper::getDisplayer(), RepairGUI_InspectObjectDlg::TreeWidgetItem::isVisible(), myCurrentTreeObjects, myInvisible, myViewWindow, and RepairGUI_InspectObjectDlg::TreeWidgetItem::setVisible().

◆ createTreeWidget()

void RepairGUI_InspectObjectDlg::createTreeWidget ( QTreeWidget *&  theTreeObjects)
private

References myInvisible.

◆ DeactivateActiveDialog

void RepairGUI_InspectObjectDlg::DeactivateActiveDialog ( )
privateslot

References GEOMBase_Helper::erasePreview(), GEOMBase_Helper::globalSelection(), myGeomGUI, and GeometryGUI::SetActiveDialogBox().

◆ displayItem()

void RepairGUI_InspectObjectDlg::displayItem ( TreeWidgetItem *  theItem)
private

References GEOM_Displayer::buildSubshapePresentation(), GEOMBase_Helper::displayPreview(), GEOM_Displayer::GetColor(), GEOMBase_Helper::getDisplayer(), RepairGUI_InspectObjectDlg::TreeWidgetItem::getShape(), GEOM_Displayer::GetWidth(), myCurrentTreeObjects, GEOM_Displayer::SetColor(), GEOM_Displayer::SetWidth(), GEOM_Displayer::UnsetColor(), and GEOM_Displayer::UnsetWidth().

◆ enterEvent()

void RepairGUI_InspectObjectDlg::enterEvent ( QEvent *  )
private

References ActivateThisDialog(), and myTolFilterGrp.

◆ init()

void RepairGUI_InspectObjectDlg::init ( )
private

References GEOMUtils::CC_GE, GEOMUtils::CC_GT, GEOMUtils::CC_LE, GEOMUtils::CC_LT, clickOnResetToMax(), clickOnResetToMin(), DeactivateActiveDialog(), DEFAULT_TOLERANCE_VALUE, initSpinBox(), initTreeWidget(), myComparisonCompo, myCurrentTreeObjects, myFilteredTreeObjects, myGeomGUI, myMaxTolResetBtn, myMinTolResetBtn, myShapeTypeBtnGrp, myTolEdit, myTolFilterGrp, myTreeObjects, myViewWindow, onCloseView(), onFilterData(), onFilterToggled(), onInitFilteredData(), onViewSelectionChanged(), and onWindowActivated().

◆ initSpinBox()

void RepairGUI_InspectObjectDlg::initSpinBox ( SalomeApp_DoubleSpinBox *  spinBox,
double  min,
double  max,
double  step,
const char *  quantity 
)
private

◆ initTreeWidget()

void RepairGUI_InspectObjectDlg::initTreeWidget ( QTreeWidget *  theTopLevelItem)
private

References onHeaderClicked(), onItemChanged(), onItemClicked(), onItemExpanded(), and onItemSelectionChanged().

◆ onCloseView

void RepairGUI_InspectObjectDlg::onCloseView ( SUIT_ViewWindow *  )
privateslot

References myGeomGUI, myViewWindow, restoreParam(), and GeometryGUI::windows().

◆ onEditMainShape

void RepairGUI_InspectObjectDlg::onEditMainShape ( )
privateslot

References myEditMainShape, myFilteredTreeObjects, myTreeObjects, myViewWindow, and restoreParam().

◆ onFilterData

void RepairGUI_InspectObjectDlg::onFilterData ( )
privateslot

References checkVisibleIcon(), GEOM_Displayer::Erase(), GEOMBase_Helper::getDisplayer(), RepairGUI_InspectObjectDlg::TreeWidgetItem::getTolerance(), GEOMUtils::IsFitCondition(), RepairGUI_InspectObjectDlg::TreeWidgetItem::isVisible(), myComparisonCompo, myFilteredTreeObjects, myInvisible, myTolEdit, and RepairGUI_InspectObjectDlg::TreeWidgetItem::setVisible().

◆ onFilterToggled

void RepairGUI_InspectObjectDlg::onFilterToggled ( bool  isOn)
privateslot

References myCurrentTreeObjects, myFilteredTreeObjects, myTreeObjects, myTreesLayout, and GEOMBase_Helper::updateViewer().

◆ onHeaderClicked

void RepairGUI_InspectObjectDlg::onHeaderClicked ( int  theColumn)
privateslot

References displayItem(), GEOM_Displayer::Erase(), GEOMBase_Helper::getDisplayer(), RepairGUI_InspectObjectDlg::TreeWidgetItem::isVisible(), myCurrentTreeObjects, myInvisible, myIsSelectAll, myViewWindow, myVisible, and RepairGUI_InspectObjectDlg::TreeWidgetItem::setVisible().

◆ onInitFilteredData

void RepairGUI_InspectObjectDlg::onInitFilteredData ( )
privateslot

References clickOnResetToMax(), clickOnResetToMin(), GEOMUtils::CompareToleranceValues(), DEFAULT_TOLERANCE_VALUE, GEOM_Displayer::Erase(), GEOMBase_Helper::getDisplayer(), RepairGUI_InspectObjectDlg::TreeWidgetItem::getShape(), RepairGUI_InspectObjectDlg::TreeWidgetItem::isVisible(), myFilteredTreeObjects, myInvisible, myMaxTol, myMaxTolResetBtn, myMaxTolValLabel, myMinTol, myMinTolResetBtn, myMinTolValLabel, myShapeTypeBtnGrp, myTolEdit, onFilterData(), onItemExpanded(), RepairGUI_InspectObjectDlg::TreeWidgetItem::setVisible(), TYPE_EDGE, TYPE_FACE, and TYPE_VERTEX.

◆ onItemChanged

void RepairGUI_InspectObjectDlg::onItemChanged ( QTreeWidgetItem *  theItem,
int  theColumn 
)
privateslot

References RepairGUI_InspectObjectDlg::TreeWidgetItem::getShape(), and myCurrentTreeObjects.

◆ onItemClicked

void RepairGUI_InspectObjectDlg::onItemClicked ( QTreeWidgetItem *  theItem,
int  theColumn 
)
privateslot

References checkVisibleIcon(), displayItem(), GEOM_Displayer::Erase(), GEOMBase_Helper::getDisplayer(), RepairGUI_InspectObjectDlg::TreeWidgetItem::isVisible(), myViewWindow, and setItemDisplayStatus().

◆ onItemExpanded

void RepairGUI_InspectObjectDlg::onItemExpanded ( QTreeWidgetItem *  theItem)
privateslot

References GEOMBase::ConvertIOinGEOMObject(), GEOMBase::GetIndex(), RepairGUI_InspectObjectDlg::TreeWidgetItem::getShape(), myCurrentTreeObjects, and GEOMBase::TypeName().

◆ onItemSelectionChanged

void RepairGUI_InspectObjectDlg::onItemSelectionChanged ( )
privateslot

References myCurrentTreeObjects, myGeomGUI, and myViewWindow.

◆ onViewSelectionChanged

void RepairGUI_InspectObjectDlg::onViewSelectionChanged ( )
privateslot

References addSubObjects(), checkVisibleIcon(), GEOMBase::ConvertIOinGEOMObject(), GEOMBase_Helper::getDisplayer(), GEOMBase::GetTopoFromSelection(), Handle(), myEditMainShape, myFilteredTreeObjects, myGeomGUI, myInvisible, myTransparency, myTreeObjects, myViewWindow, myVisible, onCloseView(), onInitFilteredData(), GEOM::propertyName(), setMainObjectTransparency(), RepairGUI_InspectObjectDlg::TreeWidgetItem::setVisible(), GEOM::Transparency, and GEOMBase_Helper::updateViewer().

◆ onWindowActivated

void RepairGUI_InspectObjectDlg::onWindowActivated ( SUIT_ViewWindow *  theViewWindow)
privateslot

References checkVisibleIcon(), GEOMBase_Helper::getDisplayer(), myCurrentTreeObjects, myInvisible, myViewWindow, myVisible, onCloseView(), restoreParam(), setMainObjectTransparency(), and RepairGUI_InspectObjectDlg::TreeWidgetItem::setVisible().

◆ restoreParam()

void RepairGUI_InspectObjectDlg::restoreParam ( )
private

References GEOM_Displayer::Erase(), GEOMBase_Helper::getDisplayer(), myCurrentTreeObjects, myInvisible, myTransparency, myViewWindow, setMainObjectTransparency(), RepairGUI_InspectObjectDlg::TreeWidgetItem::setVisible(), GEOM_Displayer::UnsetColor(), and GEOM_Displayer::UnsetWidth().

◆ setItemDisplayStatus()

void RepairGUI_InspectObjectDlg::setItemDisplayStatus ( TreeWidgetItem *  theItem,
bool  theIsVisible 
)
private

References RepairGUI_InspectObjectDlg::TreeWidgetItem::getShape(), myCurrentTreeObjects, myInvisible, myVisible, and RepairGUI_InspectObjectDlg::TreeWidgetItem::setVisible().

◆ setMainObjectTransparency()

void RepairGUI_InspectObjectDlg::setMainObjectTransparency ( double  theTransparency)
private

References GEOMBase_Helper::getDisplayer(), myCurrentTreeObjects, myGeomGUI, myViewWindow, GEOM::propertyName(), GEOM_Displayer::Redisplay(), and GEOM::Transparency.

◆ updateViewer()

void RepairGUI_InspectObjectDlg::updateViewer ( const bool  theIsHideOtherTree)
private

References displayItem(), GEOM_Displayer::Erase(), GEOMBase_Helper::getDisplayer(), RepairGUI_InspectObjectDlg::TreeWidgetItem::isVisible(), myCurrentTreeObjects, myFilteredTreeObjects, and myTreeObjects.

Member Data Documentation

◆ myComparisonCompo

QComboBox* RepairGUI_InspectObjectDlg::myComparisonCompo
private

◆ myCurrentTreeObjects

QTreeWidget* RepairGUI_InspectObjectDlg::myCurrentTreeObjects
private

◆ myEditMainShape

QLineEdit* RepairGUI_InspectObjectDlg::myEditMainShape
private

◆ myFilteredTreeObjects

QTreeWidget* RepairGUI_InspectObjectDlg::myFilteredTreeObjects
private

◆ myGeomGUI

GeometryGUI* RepairGUI_InspectObjectDlg::myGeomGUI
private

◆ myInvisible

QIcon RepairGUI_InspectObjectDlg::myInvisible
private

◆ myIsSelectAll

bool RepairGUI_InspectObjectDlg::myIsSelectAll
private

◆ myMaxTol

double RepairGUI_InspectObjectDlg::myMaxTol
private

◆ myMaxTolResetBtn

QPushButton* RepairGUI_InspectObjectDlg::myMaxTolResetBtn
private

◆ myMaxTolValLabel

QLabel* RepairGUI_InspectObjectDlg::myMaxTolValLabel
private

◆ myMinTol

double RepairGUI_InspectObjectDlg::myMinTol
private

◆ myMinTolResetBtn

QPushButton* RepairGUI_InspectObjectDlg::myMinTolResetBtn
private

◆ myMinTolValLabel

QLabel* RepairGUI_InspectObjectDlg::myMinTolValLabel
private

◆ myShapeTypeBtnGrp

QButtonGroup* RepairGUI_InspectObjectDlg::myShapeTypeBtnGrp
private

◆ myTolEdit

SalomeApp_DoubleSpinBox* RepairGUI_InspectObjectDlg::myTolEdit
private

◆ myTolFilterGrp

QGroupBox* RepairGUI_InspectObjectDlg::myTolFilterGrp
private

◆ myTransparency

double RepairGUI_InspectObjectDlg::myTransparency
private

◆ myTreeObjects

QTreeWidget* RepairGUI_InspectObjectDlg::myTreeObjects
private

◆ myTreesLayout

QStackedLayout* RepairGUI_InspectObjectDlg::myTreesLayout
private

◆ myViewWindow

QPointer<SUIT_ViewWindow> RepairGUI_InspectObjectDlg::myViewWindow
private

◆ myVisible

QIcon RepairGUI_InspectObjectDlg::myVisible
private
The documentation for this class was generated from the following files: