FreeCAD C++
Public Types | Public Attributes | List of all members
Attacher::SuggestResult Struct Reference

#include <Mod/Part/App/Attacher.h>

Detailed Description

The SuggestResult struct is a container for output information of AttachEngine mode suggesting routine.

Public Types

enum  eSuggestResult
 message contains overall verdict of suggestor on current reference set
 

Public Attributes

std::vector< eMapMode > 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.
 
eMapMode 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.
 
std::set< eRefTypenextRefTypeHint
 nextRefTypeHint: a hint of what can be added to references to achieve other modes.
 
std::map< eMapMode, refTypeStringList > 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)
 
refTypeString references_Types
 references_Types: list of types of references, as queried when running suggesting routine.