SHAPER  9.12.0
FeaturesAPI_MultiTranslation Class Reference

Interface for Translation feature. More...

Inheritance diagram for FeaturesAPI_MultiTranslation:
Inheritance graph

Public Member Functions

 FeaturesAPI_MultiTranslation (const std::shared_ptr< ModelAPI_Feature > &theFeature)
 Constructor without values. More...
 
 FeaturesAPI_MultiTranslation (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::list< ModelHighAPI_Selection > &theMainObjects, const ModelHighAPI_Selection &theAxisObject, const ModelHighAPI_Double &theStep, const ModelHighAPI_Integer &theNumber)
 Constructor with values. More...
 
 FeaturesAPI_MultiTranslation (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::list< ModelHighAPI_Selection > &theMainObjects, const ModelHighAPI_Selection &theFirstAxisObject, const ModelHighAPI_Double &theFirstStep, const ModelHighAPI_Integer &theFirstNumber, const ModelHighAPI_Selection &theSecondAxisObject, const ModelHighAPI_Double &theSecondStep, const ModelHighAPI_Integer &theSecondNumber)
 Constructor with values. More...
 
virtual ~FeaturesAPI_MultiTranslation ()
 Destructor. More...
 
virtual std::string getID ()
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionListmainObjects () const
 Main objects. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionfirstAxisObject () const
 First axis object. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoublefirstStep () const
 First step. More...
 
virtual std::shared_ptr< ModelAPI_AttributeIntegerfirstNumber () const
 First number of copies. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringuseSecondDir () const
 Use the second dir. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionsecondAxisObject () const
 Second axis object. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoublesecondStep () const
 Second step. More...
 
virtual std::shared_ptr< ModelAPI_AttributeIntegersecondNumber () const
 Second number of copies. More...
 
void setMainObjects (const std::list< ModelHighAPI_Selection > &theMainObjects)
 Set main objects. More...
 
void setFirstAxisAndDistance (const ModelHighAPI_Selection &theAxisObject, const ModelHighAPI_Double &theDistance)
 Modify CreationMethod, axis_first_dir, step_first_dir attributes of the feature. More...
 
void setSecondAxisAndDistance (const ModelHighAPI_Selection &theAxisObject, const ModelHighAPI_Double &theDistance)
 Modify CreationMethod, axis_second_dir, step_second_dir attributes of the feature. More...
 
void setFirstNumber (const ModelHighAPI_Integer &theFirstNumber)
 Modify CreationMethod, nb_first_dir attribute of the feature. More...
 
void setSecondNumber (const ModelHighAPI_Integer &theSecondNumber)
 Modify CreationMethod, nb_second_dir attribute of the feature. More...
 
virtual void dump (ModelHighAPI_Dumper &theDumper) const
 Dump wrapped feature. 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...
 
void setName (const std::wstring &theName)
 Shortcut for feature()->data()->setName() More...
 
std::wstring name () const
 Shortcut for feature()->data()->name() 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_AttributeSelectionListmymainObjects
 
std::shared_ptr< ModelAPI_AttributeSelectionmyfirstAxisObject
 
std::shared_ptr< ModelAPI_AttributeDoublemyfirstStep
 
std::shared_ptr< ModelAPI_AttributeIntegermyfirstNumber
 
std::shared_ptr< ModelAPI_AttributeStringmyuseSecondDir
 
std::shared_ptr< ModelAPI_AttributeSelectionmysecondAxisObject
 
std::shared_ptr< ModelAPI_AttributeDoublemysecondStep
 
std::shared_ptr< ModelAPI_AttributeIntegermysecondNumber
 
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

Interface for Translation feature.

Constructor & Destructor Documentation

◆ FeaturesAPI_MultiTranslation() [1/3]

FeaturesAPI_MultiTranslation::FeaturesAPI_MultiTranslation ( const std::shared_ptr< ModelAPI_Feature > &  theFeature)
explicit

Constructor without values.

◆ FeaturesAPI_MultiTranslation() [2/3]

FeaturesAPI_MultiTranslation::FeaturesAPI_MultiTranslation ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const std::list< ModelHighAPI_Selection > &  theMainObjects,
const ModelHighAPI_Selection theAxisObject,
const ModelHighAPI_Double theStep,
const ModelHighAPI_Integer theNumber 
)
explicit

Constructor with values.

◆ FeaturesAPI_MultiTranslation() [3/3]

FeaturesAPI_MultiTranslation::FeaturesAPI_MultiTranslation ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const std::list< ModelHighAPI_Selection > &  theMainObjects,
const ModelHighAPI_Selection theFirstAxisObject,
const ModelHighAPI_Double theFirstStep,
const ModelHighAPI_Integer theFirstNumber,
const ModelHighAPI_Selection theSecondAxisObject,
const ModelHighAPI_Double theSecondStep,
const ModelHighAPI_Integer theSecondNumber 
)
explicit

Constructor with values.

◆ ~FeaturesAPI_MultiTranslation()

FeaturesAPI_MultiTranslation::~FeaturesAPI_MultiTranslation ( )
virtual

Destructor.

Member Function Documentation

◆ mainObjects()

virtual std::shared_ptr< ModelAPI_AttributeSelectionList > FeaturesAPI_MultiTranslation::mainObjects ( ) const
inlinevirtual

Main objects.

◆ firstAxisObject()

virtual std::shared_ptr< ModelAPI_AttributeSelection > FeaturesAPI_MultiTranslation::firstAxisObject ( ) const
inlinevirtual

First axis object.

◆ firstStep()

virtual std::shared_ptr< ModelAPI_AttributeDouble > FeaturesAPI_MultiTranslation::firstStep ( ) const
inlinevirtual

First step.

◆ firstNumber()

virtual std::shared_ptr< ModelAPI_AttributeInteger > FeaturesAPI_MultiTranslation::firstNumber ( ) const
inlinevirtual

First number of copies.

◆ useSecondDir()

virtual std::shared_ptr< ModelAPI_AttributeString > FeaturesAPI_MultiTranslation::useSecondDir ( ) const
inlinevirtual

Use the second dir.

◆ secondAxisObject()

virtual std::shared_ptr< ModelAPI_AttributeSelection > FeaturesAPI_MultiTranslation::secondAxisObject ( ) const
inlinevirtual

Second axis object.

◆ secondStep()

virtual std::shared_ptr< ModelAPI_AttributeDouble > FeaturesAPI_MultiTranslation::secondStep ( ) const
inlinevirtual

Second step.

◆ secondNumber()

virtual std::shared_ptr< ModelAPI_AttributeInteger > FeaturesAPI_MultiTranslation::secondNumber ( ) const
inlinevirtual

Second number of copies.

◆ setMainObjects()

void FeaturesAPI_MultiTranslation::setMainObjects ( const std::list< ModelHighAPI_Selection > &  theMainObjects)

Set main objects.

◆ setFirstAxisAndDistance()

void FeaturesAPI_MultiTranslation::setFirstAxisAndDistance ( const ModelHighAPI_Selection theAxisObject,
const ModelHighAPI_Double theDistance 
)

Modify CreationMethod, axis_first_dir, step_first_dir attributes of the feature.

◆ setSecondAxisAndDistance()

void FeaturesAPI_MultiTranslation::setSecondAxisAndDistance ( const ModelHighAPI_Selection theAxisObject,
const ModelHighAPI_Double theDistance 
)

Modify CreationMethod, axis_second_dir, step_second_dir attributes of the feature.

◆ setFirstNumber()

void FeaturesAPI_MultiTranslation::setFirstNumber ( const ModelHighAPI_Integer theFirstNumber)

Modify CreationMethod, nb_first_dir attribute of the feature.

◆ setSecondNumber()

void FeaturesAPI_MultiTranslation::setSecondNumber ( const ModelHighAPI_Integer theSecondNumber)

Modify CreationMethod, nb_second_dir attribute of the feature.

◆ dump()

void FeaturesAPI_MultiTranslation::dump ( ModelHighAPI_Dumper theDumper) const
virtual

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

◆ setName()

void ModelHighAPI_Interface::setName ( const std::wstring &  theName)
inherited

Shortcut for feature()->data()->setName()

◆ name()

std::wstring ModelHighAPI_Interface::name ( ) const
inherited

Shortcut for feature()->data()->name()

◆ 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