Interface for Parameter feature. More...

Inheritance diagram for ParametersAPI_Parameter:

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_AttributeString >	name () const
	Name. More...

virtual std::shared_ptr< ModelAPI_AttributeString >	expression () const
	Expression. More...

virtual std::shared_ptr< ModelAPI_AttributeString >	comment () 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_Feature >	feature () const
	Return ModelAPI_Feature. More...

std::shared_ptr< 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. 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_Selection >	results () const
	Return all objects of the feature. More...

virtual std::shared_ptr< ModelAPI_Result >	defaultResult () 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...

virtual ListOfShape	vertices (const bool theOnlyUnique=false)
	Returns all the vertices produced by this feature. More...

virtual ListOfShape	edges (const bool theOnlyUnique=false)
	Returns all the edges produced by this feature. More...

virtual ListOfShape	wires (const bool theOnlyUnique=false)
	Returns all the wires produced by this feature. More...

virtual ListOfShape	faces (const bool theOnlyUnique=false)
	Returns all the faces produced by this feature. More...

virtual ListOfShape	shells (const bool theOnlyUnique=false)
	Returns all the shells produced by this feature. More...

virtual ListOfShape	solids (const bool theOnlyUnique=false)
	Returns all the solids produced by this feature. More...

Static Public Member Functions
static std::string	ID ()

Protected Member Functions
bool	initialize ()

Protected Attributes
std::shared_ptr< ModelAPI_AttributeString >	myname

std::shared_ptr< ModelAPI_AttributeString >	myexpression

std::shared_ptr< ModelAPI_AttributeString >	mycomment

std::shared_ptr< ModelAPI_Feature >	myFeature
	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

Return ModelAPI_Feature.

◆ 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

isForce start 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.

◆ vertices()

ListOfShape ModelHighAPI_Interface::vertices ( const bool theOnlyUnique = false )

virtualinherited

Returns all the vertices produced by this feature.

◆ edges()

ListOfShape ModelHighAPI_Interface::edges ( const bool theOnlyUnique = false )

virtualinherited

Returns all the edges produced by this feature.

◆ wires()

ListOfShape ModelHighAPI_Interface::wires ( const bool theOnlyUnique = false )

virtualinherited

Returns all the wires produced by this feature.

◆ faces()

ListOfShape ModelHighAPI_Interface::faces ( const bool theOnlyUnique = false )

virtualinherited

Returns all the faces produced by this feature.

◆ shells()

ListOfShape ModelHighAPI_Interface::shells ( const bool theOnlyUnique = false )

virtualinherited

Returns all the shells produced by this feature.

◆ solids()

ListOfShape ModelHighAPI_Interface::solids ( const bool theOnlyUnique = false )

virtualinherited

Returns all the solids produced by this feature.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ParametersAPI_Parameter() [1/2]

◆ ParametersAPI_Parameter() [2/2]

◆ ~ParametersAPI_Parameter()

Member Function Documentation

◆ name()

◆ expression()

◆ comment()

◆ setValue()

◆ value()

◆ dump()

◆ feature()

◆ subFeature()

◆ getKind()

◆ execute()

◆ setName()

◆ result()

◆ results()

◆ defaultResult()

◆ throwException()

◆ attributeGetter()

◆ vertices()

◆ edges()

◆ wires()

◆ faces()

◆ shells()

◆ solids()

Field Documentation

◆ myFeature

◆ myAttrGetter