SHAPER  9.12.0
FeaturesAPI_RevolutionBoolean Class Reference

Interface for RevolutionBoolean feature. More...

Inheritance diagram for FeaturesAPI_RevolutionBoolean:
Inheritance graph

Public Member Functions

virtual ~FeaturesAPI_RevolutionBoolean ()
 Destructor. More...
 
virtual std::string getID ()
 
virtual std::shared_ptr< ModelAPI_AttributeReferencesketch () const
 Sketch launcher. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionListbaseObjects () const
 Base objects. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionaxis () const
 Axis. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringcreationMethod () const
 Creation method. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoubletoAngle () const
 To angle. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoublefromAngle () const
 From angle. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectiontoObject () const
 To object. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoubletoOffset () const
 To offset. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionfromObject () const
 From object. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoublefromOffset () const
 From offset. More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionListbooleanObjects () const
 Boolean objects. More...
 
void setNestedSketch (const ModelHighAPI_Reference &theSketch)
 Modify base attribute of the feature. More...
 
void setBase (const std::list< ModelHighAPI_Selection > &theBaseObjects)
 Modify base attribute of the feature. More...
 
void setAxis (const ModelHighAPI_Selection &theAxis)
 Modify axis_object attribute of the feature. More...
 
void setAngles (const ModelHighAPI_Double &theToAngle, const ModelHighAPI_Double &theFromAngle)
 Modify CreationMethod, to_angle, from_angle attributes of the feature. More...
 
void setAngle (const ModelHighAPI_Double &theAngle)
 Modify creation_method, to_angle, from_angle attributes of the feature. More...
 
void setPlanesAndOffsets (const ModelHighAPI_Selection &theToObject, const ModelHighAPI_Double &theToOffset, const ModelHighAPI_Selection &theFromObject, const ModelHighAPI_Double &theFromOffset)
 Modify creation_method, to_object, to_offset, from_object, from_offset attributes of the feature. More...
 
void setBooleanObjects (const std::list< ModelHighAPI_Selection > &theBooleanObjects)
 Modiyfy main_objects 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 ()
 
 FeaturesAPI_RevolutionBoolean (const std::shared_ptr< ModelAPI_Feature > &theFeature)
 Constructor without values. More...
 

Protected Attributes

std::shared_ptr< ModelAPI_AttributeReferencemysketch
 
std::shared_ptr< ModelAPI_AttributeSelectionListmybaseObjects
 
std::shared_ptr< ModelAPI_AttributeSelectionmyaxis
 
std::shared_ptr< ModelAPI_AttributeStringmycreationMethod
 
std::shared_ptr< ModelAPI_AttributeDoublemytoAngle
 
std::shared_ptr< ModelAPI_AttributeDoublemyfromAngle
 
std::shared_ptr< ModelAPI_AttributeSelectionmytoObject
 
std::shared_ptr< ModelAPI_AttributeDoublemytoOffset
 
std::shared_ptr< ModelAPI_AttributeSelectionmyfromObject
 
std::shared_ptr< ModelAPI_AttributeDoublemyfromOffset
 
std::shared_ptr< ModelAPI_AttributeSelectionListmybooleanObjects
 
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 RevolutionBoolean feature.

Constructor & Destructor Documentation

◆ ~FeaturesAPI_RevolutionBoolean()

FeaturesAPI_RevolutionBoolean::~FeaturesAPI_RevolutionBoolean ( )
virtual

Destructor.

◆ FeaturesAPI_RevolutionBoolean()

FeaturesAPI_RevolutionBoolean::FeaturesAPI_RevolutionBoolean ( const std::shared_ptr< ModelAPI_Feature > &  theFeature)
explicitprotected

Constructor without values.

Member Function Documentation

◆ sketch()

virtual std::shared_ptr< ModelAPI_AttributeReference > FeaturesAPI_RevolutionBoolean::sketch ( ) const
inlinevirtual

Sketch launcher.

◆ baseObjects()

virtual std::shared_ptr< ModelAPI_AttributeSelectionList > FeaturesAPI_RevolutionBoolean::baseObjects ( ) const
inlinevirtual

Base objects.

◆ axis()

virtual std::shared_ptr< ModelAPI_AttributeSelection > FeaturesAPI_RevolutionBoolean::axis ( ) const
inlinevirtual

Axis.

◆ creationMethod()

virtual std::shared_ptr< ModelAPI_AttributeString > FeaturesAPI_RevolutionBoolean::creationMethod ( ) const
inlinevirtual

Creation method.

◆ toAngle()

virtual std::shared_ptr< ModelAPI_AttributeDouble > FeaturesAPI_RevolutionBoolean::toAngle ( ) const
inlinevirtual

To angle.

◆ fromAngle()

virtual std::shared_ptr< ModelAPI_AttributeDouble > FeaturesAPI_RevolutionBoolean::fromAngle ( ) const
inlinevirtual

From angle.

◆ toObject()

virtual std::shared_ptr< ModelAPI_AttributeSelection > FeaturesAPI_RevolutionBoolean::toObject ( ) const
inlinevirtual

To object.

◆ toOffset()

virtual std::shared_ptr< ModelAPI_AttributeDouble > FeaturesAPI_RevolutionBoolean::toOffset ( ) const
inlinevirtual

To offset.

◆ fromObject()

virtual std::shared_ptr< ModelAPI_AttributeSelection > FeaturesAPI_RevolutionBoolean::fromObject ( ) const
inlinevirtual

From object.

◆ fromOffset()

virtual std::shared_ptr< ModelAPI_AttributeDouble > FeaturesAPI_RevolutionBoolean::fromOffset ( ) const
inlinevirtual

From offset.

◆ booleanObjects()

virtual std::shared_ptr< ModelAPI_AttributeSelectionList > FeaturesAPI_RevolutionBoolean::booleanObjects ( ) const
inlinevirtual

Boolean objects.

◆ setNestedSketch()

void FeaturesAPI_RevolutionBoolean::setNestedSketch ( const ModelHighAPI_Reference theSketch)

Modify base attribute of the feature.

◆ setBase()

void FeaturesAPI_RevolutionBoolean::setBase ( const std::list< ModelHighAPI_Selection > &  theBaseObjects)

Modify base attribute of the feature.

◆ setAxis()

void FeaturesAPI_RevolutionBoolean::setAxis ( const ModelHighAPI_Selection theAxis)

Modify axis_object attribute of the feature.

◆ setAngles()

void FeaturesAPI_RevolutionBoolean::setAngles ( const ModelHighAPI_Double theToAngle,
const ModelHighAPI_Double theFromAngle 
)

Modify CreationMethod, to_angle, from_angle attributes of the feature.

◆ setAngle()

void FeaturesAPI_RevolutionBoolean::setAngle ( const ModelHighAPI_Double theAngle)

Modify creation_method, to_angle, from_angle attributes of the feature.

◆ setPlanesAndOffsets()

void FeaturesAPI_RevolutionBoolean::setPlanesAndOffsets ( const ModelHighAPI_Selection theToObject,
const ModelHighAPI_Double theToOffset,
const ModelHighAPI_Selection theFromObject,
const ModelHighAPI_Double theFromOffset 
)

Modify creation_method, to_object, to_offset, from_object, from_offset attributes of the feature.

◆ setBooleanObjects()

void FeaturesAPI_RevolutionBoolean::setBooleanObjects ( const std::list< ModelHighAPI_Selection > &  theBooleanObjects)

Modiyfy main_objects attribute of the feature.

◆ dump()

void FeaturesAPI_RevolutionBoolean::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