SHAPER  9.12.0
FeaturesAPI_Placement Class Reference

Interface for Placement feature. More...

Inheritance diagram for FeaturesAPI_Placement:
Inheritance graph

Public Member Functions

 FeaturesAPI_Placement (const std::shared_ptr< ModelAPI_Feature > &theFeature)
 Constructor without values. More...
 FeaturesAPI_Placement (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::list< ModelHighAPI_Selection > &theObjects, const ModelHighAPI_Selection &theStartShape, const ModelHighAPI_Selection &theEndShape, const bool theReverseDirection=false, const bool theCentering=false)
 Constructor with values. More...
virtual ~FeaturesAPI_Placement ()
 Destructor. More...
virtual std::string getID ()
virtual std::shared_ptr< ModelAPI_AttributeSelectionListobjects () const
 Main objects. More...
virtual std::shared_ptr< ModelAPI_AttributeSelectionstartShape () const
 Start shape. More...
virtual std::shared_ptr< ModelAPI_AttributeSelectionendShape () const
 End shape. More...
virtual std::shared_ptr< ModelAPI_AttributeBooleanreverseDirection () const
 Reverse direction flag. More...
virtual std::shared_ptr< ModelAPI_AttributeBooleancentering () const
 Centering flag. More...
void setObjects (const std::list< ModelHighAPI_Selection > &theObjects)
 Set objects. More...
void setStartShape (const ModelHighAPI_Selection &theStartShape)
 Set start shape. More...
void setEndShape (const ModelHighAPI_Selection &theEndShape)
 Set end shape. More...
void setReverseDirection (const bool theReverseDirection)
 Set reverse direction flag. More...
void setCentering (const bool theCentering)
 Set centering flag. 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_AttributeSelectionListmyobjects
std::shared_ptr< ModelAPI_AttributeSelectionmystartShape
std::shared_ptr< ModelAPI_AttributeSelectionmyendShape
std::shared_ptr< ModelAPI_AttributeBooleanmyreverseDirection
std::shared_ptr< ModelAPI_AttributeBooleanmycentering
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 Placement feature.

Constructor & Destructor Documentation

◆ FeaturesAPI_Placement() [1/2]

FeaturesAPI_Placement::FeaturesAPI_Placement ( const std::shared_ptr< ModelAPI_Feature > &  theFeature)

Constructor without values.

◆ FeaturesAPI_Placement() [2/2]

FeaturesAPI_Placement::FeaturesAPI_Placement ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const std::list< ModelHighAPI_Selection > &  theObjects,
const ModelHighAPI_Selection theStartShape,
const ModelHighAPI_Selection theEndShape,
const bool  theReverseDirection = false,
const bool  theCentering = false 

Constructor with values.

◆ ~FeaturesAPI_Placement()

FeaturesAPI_Placement::~FeaturesAPI_Placement ( )


Member Function Documentation

◆ objects()

virtual std::shared_ptr< ModelAPI_AttributeSelectionList > FeaturesAPI_Placement::objects ( ) const

Main objects.

◆ startShape()

virtual std::shared_ptr< ModelAPI_AttributeSelection > FeaturesAPI_Placement::startShape ( ) const

Start shape.

◆ endShape()

virtual std::shared_ptr< ModelAPI_AttributeSelection > FeaturesAPI_Placement::endShape ( ) const

End shape.

◆ reverseDirection()

virtual std::shared_ptr< ModelAPI_AttributeBoolean > FeaturesAPI_Placement::reverseDirection ( ) const

Reverse direction flag.

◆ centering()

virtual std::shared_ptr< ModelAPI_AttributeBoolean > FeaturesAPI_Placement::centering ( ) const

Centering flag.

◆ setObjects()

void FeaturesAPI_Placement::setObjects ( const std::list< ModelHighAPI_Selection > &  theObjects)

Set objects.

◆ setStartShape()

void FeaturesAPI_Placement::setStartShape ( const ModelHighAPI_Selection theStartShape)

Set start shape.

◆ setEndShape()

void FeaturesAPI_Placement::setEndShape ( const ModelHighAPI_Selection theEndShape)

Set end shape.

◆ setReverseDirection()

void FeaturesAPI_Placement::setReverseDirection ( const bool  theReverseDirection)

Set reverse direction flag.

◆ setCentering()

void FeaturesAPI_Placement::setCentering ( const bool  theCentering)

Set centering flag.

◆ dump()

void FeaturesAPI_Placement::dump ( ModelHighAPI_Dumper theDumper) const

Dump wrapped feature.

Reimplemented from ModelHighAPI_Interface.

◆ feature()

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

◆ subFeature()

std::shared_ptr< ModelHighAPI_Interface > ModelHighAPI_Interface::subFeature ( 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.

◆ getKind()

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

Shortcut for feature()->getKind()

◆ execute()

void ModelHighAPI_Interface::execute ( bool  isForce = false)

Shortcut for feature()->execute()

isForcestart execution of feature instead of sending events

◆ setName()

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

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

◆ name()

std::wstring ModelHighAPI_Interface::name ( ) const

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

◆ result()

ModelHighAPI_Selection ModelHighAPI_Interface::result ( ) const

Return firts object of the feature.

◆ results()

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

Return all objects of the feature.

◆ defaultResult()

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

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

◆ throwException()

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

Throw exception to event loop.

◆ attributeGetter()

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

Return name of getter for specified attribute.

Field Documentation

◆ myFeature

std::shared_ptr<ModelAPI_Feature> ModelHighAPI_Interface::myFeature

feature of this interface

◆ myAttrGetter

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

names of attributes and their getters