FeaturesAPI_Intersection Class Reference

Interface for Intersection feature. More...

Inheritance diagram for FeaturesAPI_Intersection:

Public Member Functions
	FeaturesAPI_Intersection (const std::shared_ptr< ModelAPI_Feature > &theFeature)
	Constructor without values. More...
	FeaturesAPI_Intersection (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::list< ModelHighAPI_Selection > &theObjects, const ModelHighAPI_Double &aFuzzy=ModelHighAPI_Double(-1))
	Constructor with values. More...
virtual	~FeaturesAPI_Intersection ()
	Destructor. More...
virtual std::string	getID ()
virtual std::shared_ptr< ModelAPI_AttributeSelectionList >	objects () const
	Objects. More...
virtual std::shared_ptr< ModelAPI_AttributeBoolean >	useFuzzy () const
	Use Fuzzy parameter. More...
virtual std::shared_ptr< ModelAPI_AttributeDouble >	fuzzyParam () const
	Fuzzy parameter. More...
void	setObjects (const std::list< ModelHighAPI_Selection > &theObjects)
	Modify objects attribute of the feature. More...
void	setUseFuzzy (bool theUseFuzzy)
	Set use fuzzy parameter. More...
void	setFuzzyValue (const ModelHighAPI_Double &theFuzzy)
	Set fuzzy parameter. 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 >	myobjects
std::shared_ptr< ModelAPI_AttributeBoolean >	myuseFuzzy
std::shared_ptr< ModelAPI_AttributeDouble >	myfuzzyParam
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 Intersection feature.

Constructor & Destructor Documentation

FeaturesAPI_Intersection() [1/2]

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

explicit

Constructor without values.

FeaturesAPI_Intersection() [2/2]

FeaturesAPI_Intersection::FeaturesAPI_Intersection ( const std::shared_ptr< ModelAPI_Feature > &  theFeature, const std::list< ModelHighAPI_Selection > &  theObjects, const ModelHighAPI_Double &  aFuzzy = ModelHighAPI_Double(-1)  )

explicit

Constructor with values.

~FeaturesAPI_Intersection()

FeaturesAPI_Intersection::~FeaturesAPI_Intersection ( )

virtual

Destructor.

Member Function Documentation

objects()

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

inlinevirtual

Objects.

useFuzzy()

virtual std::shared_ptr< ModelAPI_AttributeBoolean > FeaturesAPI_Intersection::useFuzzy ( ) const

inlinevirtual

Use Fuzzy parameter.

fuzzyParam()

virtual std::shared_ptr< ModelAPI_AttributeDouble > FeaturesAPI_Intersection::fuzzyParam ( ) const

inlinevirtual

Fuzzy parameter.

setObjects()

void FeaturesAPI_Intersection::setObjects

(

const std::list< ModelHighAPI_Selection > &

theObjects

)

Modify objects attribute of the feature.

setUseFuzzy()

void FeaturesAPI_Intersection::setUseFuzzy

(

bool

theUseFuzzy

)

Set use fuzzy parameter.

setFuzzyValue()

void FeaturesAPI_Intersection::setFuzzyValue

(

const ModelHighAPI_Double &

theFuzzy

)

Set fuzzy parameter.

dump()

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