SHAPER  9.12.0
ExchangeAPI_Export Class Reference

Interface for Export feature. More...

Inheritance diagram for ExchangeAPI_Export:
Inheritance graph

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())
 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())
 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_AttributeStringexportType () const
 ExportType. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringfilePath () const
 file path More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringxaoFilePath () const
 xao_file_path More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringfileFormat () const
 file format More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringselectionList () const
 selection list More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringxaoAuthor () const
 xao author More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringxaoGeometryName () const
 xao geometry name More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringstlFilePath () const
 stl_file_path More...
 
virtual std::shared_ptr< ModelAPI_AttributeSelectionstlobjectselected () const
 Object selected to export in stl file. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringstldeflectionType () const
 Type of the defelection. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoublestlrelative () const
 Relative. More...
 
virtual std::shared_ptr< ModelAPI_AttributeDoublestlabsolute () const
 Absolute. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringstlfileType () const
 Type of the stl file. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringstldeflectionTypeabsolute () const
 Type of the defelection. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringstldeflectionTyperelative () const
 Type of the defelection. More...
 
virtual std::shared_ptr< ModelAPI_AttributeStringmemoryBuff () const
 Bytes. More...
 
virtual void dump (ModelHighAPI_Dumper &theDumper) const
 Dump wrapped feature. More...
 
std::shared_ptr< ModelAPI_Featurefeature () const
 Return ModelAPI_Feature. More...
 
std::shared_ptr< ModelHighAPI_InterfacesubFeature (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_Selectionresults () const
 Return all objects of the feature. More...
 
virtual std::shared_ptr< ModelAPI_ResultdefaultResult () 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_AttributeStringmyexportType
 
std::shared_ptr< ModelAPI_AttributeStringmyfilePath
 
std::shared_ptr< ModelAPI_AttributeStringmyxaoFilePath
 
std::shared_ptr< ModelAPI_AttributeStringmyfileFormat
 
std::shared_ptr< ModelAPI_AttributeStringmyselectionList
 
std::shared_ptr< ModelAPI_AttributeStringmyxaoAuthor
 
std::shared_ptr< ModelAPI_AttributeStringmyxaoGeometryName
 
std::shared_ptr< ModelAPI_AttributeStringmystlFilePath
 
std::shared_ptr< ModelAPI_AttributeSelectionmystlobjectselected
 
std::shared_ptr< ModelAPI_AttributeStringmystldeflectionType
 
std::shared_ptr< ModelAPI_AttributeDoublemystlrelative
 
std::shared_ptr< ModelAPI_AttributeDoublemystlabsolute
 
std::shared_ptr< ModelAPI_AttributeStringmystlfileType
 
std::shared_ptr< ModelAPI_AttributeStringmystldeflectionTypeabsolute
 
std::shared_ptr< ModelAPI_AttributeStringmystldeflectionTyperelative
 
std::shared_ptr< ModelAPI_AttributeStringmymemoryBuff
 
std::shared_ptr< ModelAPI_FeaturemyFeature
 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() 
)
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() 
)
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.

◆ 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

◆ 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
isForcestart 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