SHAPER  9.12.0
ModelHighAPI_Folder Class Reference

Class for filling ModelAPI_Folder. More...

Inheritance diagram for ModelHighAPI_Folder:
Inheritance graph

Public Member Functions

 ModelHighAPI_Folder (const std::shared_ptr< ModelAPI_Folder > &theFolder)
 Constructor for a folder. More...
 
virtual ~ModelHighAPI_Folder ()
 Destructor. More...
 
virtual std::string getID ()
 
const std::shared_ptr< ModelAPI_Folder > & folder () const
 
std::shared_ptr< ModelAPI_AttributeReferencefirstFeature () const
 First feature reference. More...
 
std::shared_ptr< ModelAPI_AttributeReferencelastFeature () const
 Last feature reference. More...
 
void setName (const std::wstring &theName)
 Shortcut for data()->setName() More...
 
std::wstring name () const
 Shortcut for data()->name() More...
 
virtual void dump (ModelHighAPI_Dumper &theDumper) const
 To update the folder state. More...
 
std::shared_ptr< ModelAPI_Featurefeature () const
 Return ModelAPI_Feature. More...
 
std::shared_ptr< ModelHighAPI_InterfacesubFeature (const int theIndex) const
 If feature is composite return intefrace for sub-feature by zero-based index, or empty pointer if feature not composite or does not have sub-feature with such index. More...
 
const std::string & getKind () const
 Shortcut for feature()->getKind() More...
 
void execute (bool isForce=false)
 Shortcut for feature()->execute() More...
 
virtual ModelHighAPI_Selection result () const
 Return firts object of the feature. More...
 
virtual std::list< ModelHighAPI_Selectionresults () const
 Return all objects of the feature. More...
 
virtual std::shared_ptr< ModelAPI_ResultdefaultResult () const
 Return default result. Default implementation feature()->lastResult() More...
 
void throwException (const std::string &theDescription)
 Throw exception to event loop. More...
 
const std::string & attributeGetter (const std::string &theAttrName)
 Return name of getter for specified attribute. More...
 

Static Public Member Functions

static std::string ID ()
 

Protected Member Functions

bool initialize ()
 

Protected Attributes

std::shared_ptr< ModelAPI_FeaturemyFeature
 feature of this interface More...
 
std::map< std::string, std::string > myAttrGetter
 names of attributes and their getters More...
 

Detailed Description

Class for filling ModelAPI_Folder.

Constructor & Destructor Documentation

◆ ModelHighAPI_Folder()

ModelHighAPI_Folder::ModelHighAPI_Folder ( const std::shared_ptr< ModelAPI_Folder > &  theFolder)
explicit

Constructor for a folder.

◆ ~ModelHighAPI_Folder()

ModelHighAPI_Folder::~ModelHighAPI_Folder ( )
virtual

Destructor.

Member Function Documentation

◆ firstFeature()

std::shared_ptr<ModelAPI_AttributeReference> ModelHighAPI_Folder::firstFeature ( ) const
inline

First feature reference.

◆ lastFeature()

std::shared_ptr<ModelAPI_AttributeReference> ModelHighAPI_Folder::lastFeature ( ) const
inline

Last feature reference.

◆ setName()

void ModelHighAPI_Folder::setName ( const std::wstring &  theName)

Shortcut for data()->setName()

◆ name()

std::wstring ModelHighAPI_Folder::name ( ) const

Shortcut for data()->name()

◆ dump()

void ModelHighAPI_Folder::dump ( ModelHighAPI_Dumper theDumper) const
virtual

To update the folder state.

Parameters
isForcestart execution of feature instead of sending events Dump wrapped feature

Reimplemented from ModelHighAPI_Interface.

◆ feature()

std::shared_ptr< ModelAPI_Feature > ModelHighAPI_Interface::feature ( ) const
inherited

◆ subFeature()

std::shared_ptr< ModelHighAPI_Interface > ModelHighAPI_Interface::subFeature ( const int  theIndex) const
inherited

If feature is composite return intefrace for sub-feature by zero-based index, or empty pointer if feature not composite or does not have sub-feature with such index.

◆ getKind()

const std::string & ModelHighAPI_Interface::getKind ( ) const
inherited

Shortcut for feature()->getKind()

◆ execute()

void ModelHighAPI_Interface::execute ( bool  isForce = false)
inherited

Shortcut for feature()->execute()

Parameters
isForcestart execution of feature instead of sending events

◆ result()

ModelHighAPI_Selection ModelHighAPI_Interface::result ( ) const
virtualinherited

Return firts object of the feature.

◆ results()

std::list< ModelHighAPI_Selection > ModelHighAPI_Interface::results ( ) const
virtualinherited

Return all objects of the feature.

◆ defaultResult()

std::shared_ptr< ModelAPI_Result > ModelHighAPI_Interface::defaultResult ( ) const
virtualinherited

Return default result. Default implementation feature()->lastResult()

◆ throwException()

void ModelHighAPI_Interface::throwException ( const std::string &  theDescription)
inherited

Throw exception to event loop.

◆ attributeGetter()

const std::string & ModelHighAPI_Interface::attributeGetter ( const std::string &  theAttrName)
inherited

Return name of getter for specified attribute.

Field Documentation

◆ myFeature

std::shared_ptr<ModelAPI_Feature> ModelHighAPI_Interface::myFeature
protectedinherited

feature of this interface

◆ myAttrGetter

std::map<std::string, std::string> ModelHighAPI_Interface::myAttrGetter
protectedinherited

names of attributes and their getters