The SuggestResult struct is a container for output information of AttachEngine mode suggesting routine. More...
#include <Attacher.h>
Public Types | |
| enum | eSuggestResult { srOK, srLinkBroken, srUnexpectedError, srNoModesFit, srIncompatibleGeometry } |
| message contains overall verdict of suggestor on current reference set More... | |
Public Attributes | |
| std::vector< eMapMode > | allApplicableModes |
| allApplicableModes. More... | |
| eMapMode | bestFitMode |
| bestFitMode is the mode that is the most specific to current references. More... | |
| Base::RuntimeError | error |
| eSuggestResult | message |
| std::set< eRefType > | nextRefTypeHint |
| nextRefTypeHint: a hint of what can be added to references to achieve other modes. More... | |
| std::map< eMapMode, refTypeStringList > | reachableModes |
| reachableModes. More... | |
| refTypeString | references_Types |
| references_Types: list of types of references, as queried when running suggesting routine. More... | |
Detailed Description
The SuggestResult struct is a container for output information of AttachEngine mode suggesting routine.
Member Enumeration Documentation
◆ eSuggestResult
Member Data Documentation
◆ allApplicableModes
| std::vector<eMapMode> Attacher::SuggestResult::allApplicableModes |
allApplicableModes.
Vector array that will receive the list of all modes that are applicable to current set of references. It doesn't guarantee that all modes will work, it only checks that subelemnts are of right type.
Referenced by SketcherGui::SuggestAutoMapMode(), and Attacher::AttachEnginePy::suggestModes().
◆ bestFitMode
| eMapMode Attacher::SuggestResult::bestFitMode |
bestFitMode is the mode that is the most specific to current references.
Note that the mode may not be valid for current references; check if it's listed in allApplicableModes, or test if message == srOK.
Referenced by PartGui::TaskAttacher::getActiveMapMode(), SketcherGui::SuggestAutoMapMode(), and Attacher::AttachEnginePy::suggestModes().
◆ error
| Base::RuntimeError Attacher::SuggestResult::error |
Referenced by FreeCADInit.FCADLogger::report(), and Attacher::AttachEnginePy::suggestModes().
◆ message
| eSuggestResult Attacher::SuggestResult::message |
◆ nextRefTypeHint
| std::set<eRefType> Attacher::SuggestResult::nextRefTypeHint |
nextRefTypeHint: a hint of what can be added to references to achieve other modes.
Referenced by Attacher::AttachEnginePy::suggestModes().
◆ reachableModes
| std::map<eMapMode, refTypeStringList> Attacher::SuggestResult::reachableModes |
reachableModes.
List of modes that can be reached by selecting more references. Is a map, where key is the mode that can be reached, and value is a list of reference sequences that can be added to reach the mode (stuff already linked is omitted from these lists; only extra links needed are listed)
Referenced by Attacher::AttachEnginePy::suggestModes().
◆ references_Types
| refTypeString Attacher::SuggestResult::references_Types |
references_Types: list of types of references, as queried when running suggesting routine.
Referenced by Attacher::AttachEnginePy::suggestModes().
The documentation for this struct was generated from the following file:
- src/Mod/Part/App/Attacher.h
