Interface for Export feature. More...

#include <ExchangeAPI_Export.h>

Inheritance diagram for ExchangeAPI_Export:

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

	ExchangeAPI_Export (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::string &theFilePath, const std::string &theAuthor=std::string(), const std::string &theGeometryName=std::string(), const std::string &theShapeFilePath=std::string())
	Constructor with values for XAO export. More...

	ExchangeAPI_Export (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::string &theFilePath, const ModelHighAPI_Selection &theSelectedShape, const ModelHighAPI_Double &theDeflectionRelative, const ModelHighAPI_Double &theDeflectionAbsolute, const bool theIsRelative, const bool theIsASCII)
	Constructor with values for STL of selected result export. More...

	ExchangeAPI_Export (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::string &theFilePath, const ModelHighAPI_Selection &theResult, const std::string &theAuthor, const std::string &theGeometryName=std::string(), const std::string &theShapeFilePath=std::string())
	Constructor with values for XAO of selected result export. More...

	ExchangeAPI_Export (const std::shared_ptr< ModelAPI_Feature > &theFeature, const ModelHighAPI_Selection &theResult, const std::string &theAuthor, const std::string &theGeometryName=std::string())
	Constructor with values for XAO of selected result export to memory buffer. More...

	ExchangeAPI_Export (const std::shared_ptr< ModelAPI_Feature > &theFeature, const std::string &theFilePath, const std::list< ModelHighAPI_Selection > &theSelectionList, const std::string &theFileFormat=std::string())
	Constructor with values for export in other formats than XAO. More...

virtual	~ExchangeAPI_Export ()
	Destructor. More...

virtual std::string	getID ()

virtual std::shared_ptr< ModelAPI_AttributeString >	exportType () const
	ExportType. More...

virtual std::shared_ptr< ModelAPI_AttributeString >	filePath () const
	file path More...

virtual std::shared_ptr< ModelAPI_AttributeString >	xaoFilePath () const
	xao_file_path More...

virtual std::shared_ptr< ModelAPI_AttributeString >	fileFormat () const
	file format More...

virtual std::shared_ptr< ModelAPI_AttributeString >	selectionList () const
	selection list More...

virtual std::shared_ptr< ModelAPI_AttributeString >	xaoAuthor () const
	xao author More...

virtual std::shared_ptr< ModelAPI_AttributeString >	xaoGeometryName () const
	xao geometry name More...

virtual std::shared_ptr< ModelAPI_AttributeString >	stlFilePath () const
	stl_file_path More...

virtual std::shared_ptr< ModelAPI_AttributeSelection >	stlobjectselected () const
	Object selected to export in stl file. More...

virtual std::shared_ptr< ModelAPI_AttributeString >	stldeflectionType () const
	Type of the defelection. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	stlrelative () const
	Relative. More...

virtual std::shared_ptr< ModelAPI_AttributeDouble >	stlabsolute () const
	Absolute. More...

virtual std::shared_ptr< ModelAPI_AttributeString >	stlfileType () const
	Type of the stl file. More...

virtual std::shared_ptr< ModelAPI_AttributeString >	stldeflectionTypeabsolute () const
	Type of the defelection. More...

virtual std::shared_ptr< ModelAPI_AttributeString >	stldeflectionTyperelative () const
	Type of the defelection. More...

virtual std::shared_ptr< ModelAPI_AttributeString >	memoryBuff () const
	Bytes. More...

virtual std::shared_ptr< ModelAPI_AttributeString >	xaoShapeFilePath () const
	xao shape file path 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_AttributeString >	myexportType

std::shared_ptr< ModelAPI_AttributeString >	myfilePath

std::shared_ptr< ModelAPI_AttributeString >	myxaoFilePath

std::shared_ptr< ModelAPI_AttributeString >	myfileFormat

std::shared_ptr< ModelAPI_AttributeString >	myselectionList

std::shared_ptr< ModelAPI_AttributeString >	myxaoAuthor

std::shared_ptr< ModelAPI_AttributeString >	myxaoGeometryName

std::shared_ptr< ModelAPI_AttributeString >	mystlFilePath

std::shared_ptr< ModelAPI_AttributeSelection >	mystlobjectselected

std::shared_ptr< ModelAPI_AttributeString >	mystldeflectionType

std::shared_ptr< ModelAPI_AttributeDouble >	mystlrelative

std::shared_ptr< ModelAPI_AttributeDouble >	mystlabsolute

std::shared_ptr< ModelAPI_AttributeString >	mystlfileType

std::shared_ptr< ModelAPI_AttributeString >	mystldeflectionTypeabsolute

std::shared_ptr< ModelAPI_AttributeString >	mystldeflectionTyperelative

std::shared_ptr< ModelAPI_AttributeString >	mymemoryBuff

std::shared_ptr< ModelAPI_AttributeString >	myxaoShapeFilePath

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

Constructor & Destructor Documentation

◆ ExchangeAPI_Export() [1/6]

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

explicit

Constructor without values.

◆ ExchangeAPI_Export() [2/6]

ExchangeAPI_Export::ExchangeAPI_Export	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const std::string &	theFilePath,
		const std::string &	theAuthor = `std::string()`,
		const std::string &	theGeometryName = `std::string()`,
		const std::string &	theShapeFilePath = `std::string()`
	)

explicit

Constructor with values for XAO export.

◆ ExchangeAPI_Export() [3/6]

ExchangeAPI_Export::ExchangeAPI_Export	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const std::string &	theFilePath,
		const ModelHighAPI_Selection &	theSelectedShape,
		const ModelHighAPI_Double &	theDeflectionRelative,
		const ModelHighAPI_Double &	theDeflectionAbsolute,
		const bool	theIsRelative,
		const bool	theIsASCII
	)

explicit

Constructor with values for STL of selected result export.

◆ ExchangeAPI_Export() [4/6]

ExchangeAPI_Export::ExchangeAPI_Export	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const std::string &	theFilePath,
		const ModelHighAPI_Selection &	theResult,
		const std::string &	theAuthor,
		const std::string &	theGeometryName = `std::string()`,
		const std::string &	theShapeFilePath = `std::string()`
	)

explicit

Constructor with values for XAO of selected result export.

◆ ExchangeAPI_Export() [5/6]

ExchangeAPI_Export::ExchangeAPI_Export	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const ModelHighAPI_Selection &	theResult,
		const std::string &	theAuthor,
		const std::string &	theGeometryName = `std::string()`
	)

explicit

Constructor with values for XAO of selected result export to memory buffer.

◆ ExchangeAPI_Export() [6/6]

ExchangeAPI_Export::ExchangeAPI_Export	(	const std::shared_ptr< ModelAPI_Feature > &	theFeature,
		const std::string &	theFilePath,
		const std::list< ModelHighAPI_Selection > &	theSelectionList,
		const std::string &	theFileFormat = `std::string()`
	)

explicit

Constructor with values for export in other formats than XAO.

◆ ~ExchangeAPI_Export()

ExchangeAPI_Export::~ExchangeAPI_Export ( )

virtual

Destructor.

Member Function Documentation

◆ exportType()

virtual std::shared_ptr< ModelAPI_AttributeString > ExchangeAPI_Export::exportType ( ) const

inlinevirtual

ExportType.

◆ filePath()

virtual std::shared_ptr< ModelAPI_AttributeString > ExchangeAPI_Export::filePath ( ) const

inlinevirtual

file path

◆ xaoFilePath()

virtual std::shared_ptr< ModelAPI_AttributeString > ExchangeAPI_Export::xaoFilePath ( ) const

inlinevirtual

xao_file_path

◆ fileFormat()

virtual std::shared_ptr< ModelAPI_AttributeString > ExchangeAPI_Export::fileFormat ( ) const

inlinevirtual

file format

◆ selectionList()

virtual std::shared_ptr< ModelAPI_AttributeString > ExchangeAPI_Export::selectionList ( ) const

inlinevirtual

selection list

◆ xaoAuthor()

virtual std::shared_ptr< ModelAPI_AttributeString > ExchangeAPI_Export::xaoAuthor ( ) const

inlinevirtual

xao author

◆ xaoGeometryName()

virtual std::shared_ptr< ModelAPI_AttributeString > ExchangeAPI_Export::xaoGeometryName ( ) const

inlinevirtual

xao geometry name

◆ stlFilePath()

virtual std::shared_ptr< ModelAPI_AttributeString > ExchangeAPI_Export::stlFilePath ( ) const

inlinevirtual

stl_file_path

◆ stlobjectselected()

virtual std::shared_ptr< ModelAPI_AttributeSelection > ExchangeAPI_Export::stlobjectselected ( ) const

inlinevirtual

Object selected to export in stl file.

◆ stldeflectionType()

virtual std::shared_ptr< ModelAPI_AttributeString > ExchangeAPI_Export::stldeflectionType ( ) const

inlinevirtual

Type of the defelection.

◆ stlrelative()

virtual std::shared_ptr< ModelAPI_AttributeDouble > ExchangeAPI_Export::stlrelative ( ) const

inlinevirtual

Relative.

◆ stlabsolute()

virtual std::shared_ptr< ModelAPI_AttributeDouble > ExchangeAPI_Export::stlabsolute ( ) const

inlinevirtual

Absolute.

◆ stlfileType()

virtual std::shared_ptr< ModelAPI_AttributeString > ExchangeAPI_Export::stlfileType ( ) const

inlinevirtual

Type of the stl file.

◆ stldeflectionTypeabsolute()

virtual std::shared_ptr< ModelAPI_AttributeString > ExchangeAPI_Export::stldeflectionTypeabsolute ( ) const

inlinevirtual

Type of the defelection.

◆ stldeflectionTyperelative()

virtual std::shared_ptr< ModelAPI_AttributeString > ExchangeAPI_Export::stldeflectionTyperelative ( ) const

inlinevirtual

Type of the defelection.

◆ memoryBuff()

virtual std::shared_ptr< ModelAPI_AttributeString > ExchangeAPI_Export::memoryBuff ( ) const

inlinevirtual

Bytes.

◆ xaoShapeFilePath()

virtual std::shared_ptr< ModelAPI_AttributeString > ExchangeAPI_Export::xaoShapeFilePath ( ) const

inlinevirtual

xao shape file path

◆ dump()

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

◆ ExchangeAPI_Export() [1/6]

◆ ExchangeAPI_Export() [2/6]

◆ ExchangeAPI_Export() [3/6]

◆ ExchangeAPI_Export() [4/6]

◆ ExchangeAPI_Export() [5/6]

◆ ExchangeAPI_Export() [6/6]

◆ ~ExchangeAPI_Export()

Member Function Documentation

◆ exportType()

◆ filePath()

◆ xaoFilePath()

◆ fileFormat()

◆ selectionList()

◆ xaoAuthor()

◆ xaoGeometryName()

◆ stlFilePath()

◆ stlobjectselected()

◆ stldeflectionType()

◆ stlrelative()

◆ stlabsolute()

◆ stlfileType()

◆ stldeflectionTypeabsolute()

◆ stldeflectionTyperelative()

◆ memoryBuff()

◆ xaoShapeFilePath()

◆ dump()

◆ feature()

◆ subFeature()

◆ getKind()

◆ execute()

◆ setName()

◆ name()

◆ result()

◆ results()

◆ defaultResult()

◆ throwException()

◆ attributeGetter()

◆ vertices()

◆ edges()

◆ wires()

◆ faces()

◆ shells()

◆ solids()

Field Documentation

◆ myFeature

◆ myAttrGetter