SHAPER  9.12.0
ParametersAPI_Parameter Class Reference

Interface for Parameter feature. More...

Inheritance diagram for ParametersAPI_Parameter:
Inheritance graph

Public Member Functions

 ParametersAPI_Parameter (const std::shared_ptr< ModelAPI_Feature > &theFeature)
 Constructor without values. More...
 
 ParametersAPI_Parameter (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::string &theName, const std::string &theExpression, const std::wstring &theComment=std::wstring())
 Constructor with values. More...
 
virtual ~ParametersAPI_Parameter ()
 Destructor. More...
 
virtual std::string getID ()
 
virtual std::shared_ptr< ModelAPI_AttributeStringname () const
 Name. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringexpression () const
 Expression. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringcomment () const
 Comment. More...
 
void setValue (const double theValue)
 Just sets the numeric value to the parameter (it resets the previous expression) More...
 
double value ()
 Returns the current value of the parameter: the expression result. 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...
 
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_AttributeStringmyname
 
std::shared_ptr< ModelAPI_AttributeStringmyexpression
 
std::shared_ptr< ModelAPI_AttributeStringmycomment
 
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 Parameter feature.

Constructor & Destructor Documentation

◆ ParametersAPI_Parameter() [1/2]

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

Constructor without values.

◆ ParametersAPI_Parameter() [2/2]

ParametersAPI_Parameter::ParametersAPI_Parameter ( const std::shared_ptr< ModelAPI_Feature > &  theFeature,
const std::string &  theName,
const std::string &  theExpression,
const std::wstring &  theComment = std::wstring() 
)
explicit

Constructor with values.

◆ ~ParametersAPI_Parameter()

ParametersAPI_Parameter::~ParametersAPI_Parameter ( )
virtual

Destructor.

Member Function Documentation

◆ name()

virtual std::shared_ptr< ModelAPI_AttributeString > ParametersAPI_Parameter::name ( ) const
inlinevirtual

Name.

◆ expression()

virtual std::shared_ptr< ModelAPI_AttributeString > ParametersAPI_Parameter::expression ( ) const
inlinevirtual

Expression.

◆ comment()

virtual std::shared_ptr< ModelAPI_AttributeString > ParametersAPI_Parameter::comment ( ) const
inlinevirtual

Comment.

◆ setValue()

void ParametersAPI_Parameter::setValue ( const double  theValue)

Just sets the numeric value to the parameter (it resets the previous expression)

◆ value()

double ParametersAPI_Parameter::value ( )

Returns the current value of the parameter: the expression result.

◆ dump()

void ParametersAPI_Parameter::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()

◆ 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