Interface for Interpolation feature. More...

Inheritance diagram for BuildAPI_Interpolation:

Public Member Functions
	BuildAPI_Interpolation (const FeaturePtr &theFeature)
	Constructor without values. More...

	BuildAPI_Interpolation (const FeaturePtr &theFeature, const std::list< ModelHighAPI_Selection > &theBaseObjects, const ModelHighAPI_Selection &theStartTangent, const ModelHighAPI_Selection &theEndTangent, const bool theIsClosed, const bool theIsToReorder)
	Constructor with values. More...

	BuildAPI_Interpolation (const FeaturePtr &theFeature, const std::list< ModelHighAPI_Selection > &theBaseObjects, const bool theIsClosed, const bool theIsToReorder)
	Constructor with base objects, closed and reorder parameters. More...

	BuildAPI_Interpolation (const FeaturePtr &theFeature, const std::string &theXTexpression, const std::string &theYTexpression, const std::string &theZTexpression, const ModelHighAPI_Double &theMinT, const ModelHighAPI_Double &theMaxT, const ModelHighAPI_Integer &theNbStep)
	Constructor with expression analytical of X,Y andZ. More...

virtual	~BuildAPI_Interpolation ()
	Destructor. More...

virtual std::string	getID ()

virtual std::shared_ptr< ModelAPI_AttributeSelectionList >	baseObjects () const
	Base objects. More...

virtual std::shared_ptr< ModelAPI_AttributeBoolean >	closed () const
	Closed flag. More...

virtual std::shared_ptr< ModelAPI_AttributeBoolean >	reorder () const
	Reorder flag. More...

virtual std::shared_ptr< ModelAPI_AttributeString >	useTangents () const
	Use tangents flag. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	startTangent () const
	Start point tangent. More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	endTangent () const
	End point tangent. More...

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

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

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

virtual std::shared_ptr< ModelAPI_AttributeDouble >	mint () const
	Min. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	maxt () const
	Max. More...

virtual std::shared_ptr< ModelAPI_AttributeInteger >	numstep () const
	Number of steps. More...

virtual std::shared_ptr< ModelAPI_AttributeString >	creationmethod () const
	Creation method. More...

void	setBase (const std::list< ModelHighAPI_Selection > &theBaseObjects)
	Modify base attribute of the feature. More...

void	setClosed (const bool theIsClosed)
	Set closed flag. More...

void	setReorder (const bool theIsToReorder)
	Set reorder flag. More...

void	setUseTangents (const bool theIsToUseTangents)
	Set use tangents flag. More...

void	setTangents (const ModelHighAPI_Selection &theStartTangent, const ModelHighAPI_Selection &theEndTangent)
	Set start and end tangents. 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...

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_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...

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

Protected Member Functions
bool	initialize ()

Protected Attributes
std::shared_ptr< ModelAPI_AttributeSelectionList >	mybaseObjects

std::shared_ptr< ModelAPI_AttributeBoolean >	myclosed

std::shared_ptr< ModelAPI_AttributeBoolean >	myreorder

std::shared_ptr< ModelAPI_AttributeString >	myuseTangents

std::shared_ptr< ModelAPI_AttributeSelection >	mystartTangent

std::shared_ptr< ModelAPI_AttributeSelection >	myendTangent

std::shared_ptr< ModelAPI_AttributeString >	myxt

std::shared_ptr< ModelAPI_AttributeString >	myyt

std::shared_ptr< ModelAPI_AttributeString >	myzt

std::shared_ptr< ModelAPI_AttributeDouble >	mymint

std::shared_ptr< ModelAPI_AttributeDouble >	mymaxt

std::shared_ptr< ModelAPI_AttributeInteger >	mynumstep

std::shared_ptr< ModelAPI_AttributeString >	mycreationmethod

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 Interpolation feature.

Constructor & Destructor Documentation

◆ BuildAPI_Interpolation() [1/4]

BuildAPI_Interpolation::BuildAPI_Interpolation ( const FeaturePtr & theFeature )

explicit

Constructor without values.

◆ BuildAPI_Interpolation() [2/4]

BuildAPI_Interpolation::BuildAPI_Interpolation	(	const FeaturePtr &	theFeature,
		const std::list< ModelHighAPI_Selection > &	theBaseObjects,
		const ModelHighAPI_Selection &	theStartTangent,
		const ModelHighAPI_Selection &	theEndTangent,
		const bool	theIsClosed,
		const bool	theIsToReorder
	)

explicit

Constructor with values.

◆ BuildAPI_Interpolation() [3/4]

BuildAPI_Interpolation::BuildAPI_Interpolation	(	const FeaturePtr &	theFeature,
		const std::list< ModelHighAPI_Selection > &	theBaseObjects,
		const bool	theIsClosed,
		const bool	theIsToReorder
	)

explicit

Constructor with base objects, closed and reorder parameters.

◆ BuildAPI_Interpolation() [4/4]

BuildAPI_Interpolation::BuildAPI_Interpolation	(	const FeaturePtr &	theFeature,
		const std::string &	theXTexpression,
		const std::string &	theYTexpression,
		const std::string &	theZTexpression,
		const ModelHighAPI_Double &	theMinT,
		const ModelHighAPI_Double &	theMaxT,
		const ModelHighAPI_Integer &	theNbStep
	)

explicit

Constructor with expression analytical of X,Y andZ.

◆ ~BuildAPI_Interpolation()

BuildAPI_Interpolation::~BuildAPI_Interpolation ( )

virtual

Destructor.

Member Function Documentation

◆ baseObjects()

virtual std::shared_ptr< ModelAPI_AttributeSelectionList > BuildAPI_Interpolation::baseObjects ( ) const

inlinevirtual

Base objects.

◆ closed()

virtual std::shared_ptr< ModelAPI_AttributeBoolean > BuildAPI_Interpolation::closed ( ) const

inlinevirtual

Closed flag.

◆ reorder()

virtual std::shared_ptr< ModelAPI_AttributeBoolean > BuildAPI_Interpolation::reorder ( ) const

inlinevirtual

Reorder flag.

◆ useTangents()

virtual std::shared_ptr< ModelAPI_AttributeString > BuildAPI_Interpolation::useTangents ( ) const

inlinevirtual

Use tangents flag.

◆ startTangent()

virtual std::shared_ptr< ModelAPI_AttributeSelection > BuildAPI_Interpolation::startTangent ( ) const

inlinevirtual

Start point tangent.

◆ endTangent()

virtual std::shared_ptr< ModelAPI_AttributeSelection > BuildAPI_Interpolation::endTangent ( ) const

inlinevirtual

End point tangent.

◆ xt()

virtual std::shared_ptr< ModelAPI_AttributeString > BuildAPI_Interpolation::xt ( ) const

inlinevirtual

xt expression

◆ yt()

virtual std::shared_ptr< ModelAPI_AttributeString > BuildAPI_Interpolation::yt ( ) const

inlinevirtual

yt expression

◆ zt()

virtual std::shared_ptr< ModelAPI_AttributeString > BuildAPI_Interpolation::zt ( ) const

inlinevirtual

zt expression

◆ mint()

virtual std::shared_ptr< ModelAPI_AttributeDouble > BuildAPI_Interpolation::mint ( ) const

inlinevirtual

Min.

◆ maxt()

virtual std::shared_ptr< ModelAPI_AttributeDouble > BuildAPI_Interpolation::maxt ( ) const

inlinevirtual

Max.

◆ numstep()

virtual std::shared_ptr< ModelAPI_AttributeInteger > BuildAPI_Interpolation::numstep ( ) const

inlinevirtual

Number of steps.

◆ creationmethod()

virtual std::shared_ptr< ModelAPI_AttributeString > BuildAPI_Interpolation::creationmethod ( ) const

inlinevirtual

Creation method.

◆ setBase()

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

Modify base attribute of the feature.

◆ setClosed()

void BuildAPI_Interpolation::setClosed ( const bool theIsClosed )

Set closed flag.

◆ setReorder()

void BuildAPI_Interpolation::setReorder ( const bool theIsToReorder )

Set reorder flag.

◆ setUseTangents()

void BuildAPI_Interpolation::setUseTangents ( const bool theIsToUseTangents )

Set use tangents flag.

◆ setTangents()

void BuildAPI_Interpolation::setTangents	(	const ModelHighAPI_Selection &	theStartTangent,
		const ModelHighAPI_Selection &	theEndTangent
	)

Set start and end tangents.

◆ dump()

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

◆ 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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BuildAPI_Interpolation() [1/4]

◆ BuildAPI_Interpolation() [2/4]

◆ BuildAPI_Interpolation() [3/4]

◆ BuildAPI_Interpolation() [4/4]

◆ ~BuildAPI_Interpolation()

Member Function Documentation

◆ baseObjects()

◆ closed()

◆ reorder()

◆ useTangents()

◆ startTangent()

◆ endTangent()

◆ xt()

◆ yt()

◆ zt()

◆ mint()

◆ maxt()

◆ numstep()

◆ creationmethod()

◆ setBase()

◆ setClosed()

◆ setReorder()

◆ setUseTangents()

◆ setTangents()

◆ dump()

◆ feature()

◆ subFeature()

◆ getKind()

◆ execute()

◆ setName()

◆ name()

◆ result()

◆ results()

◆ defaultResult()

◆ throwException()

◆ attributeGetter()

Field Documentation

◆ myFeature

◆ myAttrGetter