Interface for Pipe feature. More...

Inheritance diagram for FeaturesAPI_Pipe:

Public Member Functions
	FeaturesAPI_Pipe (const std::shared_ptr< ModelAPI_Feature > &theFeature)
	Constructor without values. More...

	FeaturesAPI_Pipe (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::list< ModelHighAPI_Selection > &theBaseObjects, const ModelHighAPI_Selection &thePath)
	Constructor with values. More...

	FeaturesAPI_Pipe (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::list< ModelHighAPI_Selection > &theBaseObjects, const ModelHighAPI_Selection &thePath, const ModelHighAPI_Selection &theBiNoramal)
	Constructor with values. More...

	FeaturesAPI_Pipe (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::list< ModelHighAPI_Selection > &theBaseObjects, const ModelHighAPI_Selection &thePath, const std::list< ModelHighAPI_Selection > &theLocations)
	Constructor with values. More...

virtual	~FeaturesAPI_Pipe ()
	Destructor. More...

virtual std::string	getID ()

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

virtual std::shared_ptr< ModelAPI_AttributeSelection >	path () const
	Path. More...

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

virtual std::shared_ptr< ModelAPI_AttributeSelection >	biNormal () const
	Bi-Normal. More...

virtual std::shared_ptr< ModelAPI_AttributeSelectionList >	locations () const
	Locations. More...

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

void	setPath (const ModelHighAPI_Selection &thePath)
	Modify path attribute of the feature. More...

void	setByBasePath (const std::list< ModelHighAPI_Selection > &theBaseObjects, const ModelHighAPI_Selection &thePath)
	Modify creation method, base and path. More...

void	setByBasePathBiNormal (const std::list< ModelHighAPI_Selection > &theBaseObjects, const ModelHighAPI_Selection &thePath, const ModelHighAPI_Selection &theBiNoramal)
	Modify creation method, base, path and bi-normal. More...

void	setByBasePathLocations (const std::list< ModelHighAPI_Selection > &theBaseObjects, const ModelHighAPI_Selection &thePath, const std::list< ModelHighAPI_Selection > &theLocations)
	Modify creation method, base, path and locations. 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...

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_AttributeSelectionList >	mybaseObjects

std::shared_ptr< ModelAPI_AttributeSelection >	mypath

std::shared_ptr< ModelAPI_AttributeString >	mycreationMethod

std::shared_ptr< ModelAPI_AttributeSelection >	mybiNormal

std::shared_ptr< ModelAPI_AttributeSelectionList >	mylocations

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

Constructor & Destructor Documentation

◆ FeaturesAPI_Pipe() [1/4]

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

explicit

Constructor without values.

◆ FeaturesAPI_Pipe() [2/4]

FeaturesAPI_Pipe::FeaturesAPI_Pipe	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const std::list< ModelHighAPI_Selection > &	theBaseObjects,
		const ModelHighAPI_Selection &	thePath
	)

explicit

Constructor with values.

◆ FeaturesAPI_Pipe() [3/4]

FeaturesAPI_Pipe::FeaturesAPI_Pipe	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const std::list< ModelHighAPI_Selection > &	theBaseObjects,
		const ModelHighAPI_Selection &	thePath,
		const ModelHighAPI_Selection &	theBiNoramal
	)

explicit

Constructor with values.

◆ FeaturesAPI_Pipe() [4/4]

FeaturesAPI_Pipe::FeaturesAPI_Pipe	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const std::list< ModelHighAPI_Selection > &	theBaseObjects,
		const ModelHighAPI_Selection &	thePath,
		const std::list< ModelHighAPI_Selection > &	theLocations
	)

explicit

Constructor with values.

◆ ~FeaturesAPI_Pipe()

FeaturesAPI_Pipe::~FeaturesAPI_Pipe ( )

virtual

Destructor.

Member Function Documentation

◆ baseObjects()

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

inlinevirtual

Base objects.

◆ path()

virtual std::shared_ptr< ModelAPI_AttributeSelection > FeaturesAPI_Pipe::path ( ) const

inlinevirtual

Path.

◆ creationMethod()

virtual std::shared_ptr< ModelAPI_AttributeString > FeaturesAPI_Pipe::creationMethod ( ) const

inlinevirtual

Creation method.

◆ biNormal()

virtual std::shared_ptr< ModelAPI_AttributeSelection > FeaturesAPI_Pipe::biNormal ( ) const

inlinevirtual

Bi-Normal.

◆ locations()

virtual std::shared_ptr< ModelAPI_AttributeSelectionList > FeaturesAPI_Pipe::locations ( ) const

inlinevirtual

Locations.

◆ setBase()

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

Modify base attribute of the feature.

◆ setPath()

void FeaturesAPI_Pipe::setPath ( const ModelHighAPI_Selection & thePath )

Modify path attribute of the feature.

◆ setByBasePath()

void FeaturesAPI_Pipe::setByBasePath	(	const std::list< ModelHighAPI_Selection > &	theBaseObjects,
		const ModelHighAPI_Selection &	thePath
	)

Modify creation method, base and path.

◆ setByBasePathBiNormal()

void FeaturesAPI_Pipe::setByBasePathBiNormal	(	const std::list< ModelHighAPI_Selection > &	theBaseObjects,
		const ModelHighAPI_Selection &	thePath,
		const ModelHighAPI_Selection &	theBiNoramal
	)

Modify creation method, base, path and bi-normal.

◆ setByBasePathLocations()

void FeaturesAPI_Pipe::setByBasePathLocations	(	const std::list< ModelHighAPI_Selection > &	theBaseObjects,
		const ModelHighAPI_Selection &	thePath,
		const std::list< ModelHighAPI_Selection > &	theLocations
	)

Modify creation method, base, path and locations.

◆ dump()

void FeaturesAPI_Pipe::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.

◆ 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

◆ FeaturesAPI_Pipe() [1/4]

◆ FeaturesAPI_Pipe() [2/4]

◆ FeaturesAPI_Pipe() [3/4]

◆ FeaturesAPI_Pipe() [4/4]

◆ ~FeaturesAPI_Pipe()

Member Function Documentation

◆ baseObjects()

◆ path()

◆ creationMethod()

◆ biNormal()

◆ locations()

◆ setBase()

◆ setPath()

◆ setByBasePath()

◆ setByBasePathBiNormal()

◆ setByBasePathLocations()

◆ dump()

◆ feature()

◆ subFeature()

◆ getKind()

◆ execute()

◆ setName()

◆ name()

◆ result()

◆ results()

◆ defaultResult()

◆ throwException()

◆ attributeGetter()

◆ vertices()

◆ edges()

◆ wires()

◆ faces()

◆ shells()

◆ solids()

Field Documentation

◆ myFeature

◆ myAttrGetter