Provides a tool to write DECAF document to the STEP file. Besides transfer of shapes (including assemblies) provided by STEPControl, supports also colors and part names. More...

#include <STEPCAFControl_Writer.hxx>

Public Member Functions
	STEPCAFControl_Writer ()
	Creates a writer with an empty STEP model and sets ColorMode, LayerMode, NameMode and PropsMode to true.

	STEPCAFControl_Writer (const occ::handle< XSControl_WorkSession > &theWS, const bool theScratch=true)
	Creates a reader tool and attaches it to an already existing Session Clears the session if it was not yet set for STEP Clears the internal data structures.

void	Init (const occ::handle< XSControl_WorkSession > &theWS, const bool theScratch=true)
	Clears the internal data structures and attaches to a new session Clears the session if it was not yet set for STEP.

IFSelect_ReturnStatus	Write (const char *const theFileName)
	Writes all the produced models into file In case of multimodel with extern references, filename will be a name of root file, all other files have names of corresponding parts Provided for use like single-file writer.

IFSelect_ReturnStatus	WriteStream (std::ostream &theStream)
	Writes all the produced models into the stream. Provided for use like single-file writer.

bool	Transfer (const occ::handle< TDocStd_Document > &theDoc, const STEPControl_StepModelType theMode=STEPControl_AsIs, const char *const theIsMulti=nullptr, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Transfers a document (or single label) to a STEP model The mode of translation of shape is AsIs If multi is not null pointer, it switches to multifile mode (with external refs), and string pointed by <multi> gives prefix for names of extern files (can be empty string) Returns True if translation is OK.

bool	Transfer (const occ::handle< TDocStd_Document > &theDoc, const DESTEP_Parameters &theParams, const STEPControl_StepModelType theMode=STEPControl_AsIs, const char *const theIsMulti=nullptr, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Transfers a document (or single label) to a STEP model This method uses if need to set parameters avoiding initialization from Interface_Static.

bool	Transfer (const TDF_Label &theLabel, const STEPControl_StepModelType theMode=STEPControl_AsIs, const char *const theIsMulti=nullptr, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Method to transfer part of the document specified by label.

bool	Transfer (const TDF_Label &theLabel, const DESTEP_Parameters &theParams, const STEPControl_StepModelType theMode=STEPControl_AsIs, const char *const theIsMulti=nullptr, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Method to transfer part of the document specified by label This method uses if need to set parameters avoiding initialization from Interface_Static.

bool	Transfer (const NCollection_Sequence< TDF_Label > &theLabelSeq, const STEPControl_StepModelType theMode=STEPControl_AsIs, const char *const theIsMulti=nullptr, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Method to writing sequence of root assemblies or part of the file specified by use by one label.

bool	Transfer (const NCollection_Sequence< TDF_Label > &theLabelSeq, const DESTEP_Parameters &theParams, const STEPControl_StepModelType theMode=STEPControl_AsIs, const char *const theIsMulti=nullptr, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Method to writing sequence of root assemblies or part of the file specified by use by one label. This method is utilized if there's a need to set parameters avoiding initialization from Interface_Static.

bool	Perform (const occ::handle< TDocStd_Document > &theDoc, const TCollection_AsciiString &theFileName, const Message_ProgressRange &theProgress=Message_ProgressRange())

bool	Perform (const occ::handle< TDocStd_Document > &theDoc, const char *const theFileName, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Transfers a document and writes it to a STEP file Returns True if translation is OK.

bool	Perform (const occ::handle< TDocStd_Document > &theDoc, const char *const theFileName, const DESTEP_Parameters &theParams, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Transfers a document and writes it to a STEP file This method is utilized if there's a need to set parameters avoiding initialization from Interface_Static Returns True if translation is OK.

const NCollection_DataMap< TCollection_AsciiString, occ::handle< STEPCAFControl_ExternFile > > &	ExternFiles () const
	Returns data on external files Returns Null handle if no external files are read.

bool	ExternFile (const TDF_Label &theLabel, occ::handle< STEPCAFControl_ExternFile > &theExtFile) const
	Returns data on external file by its original label Returns False if no external file with given name is read.

bool	ExternFile (const char *const theName, occ::handle< STEPCAFControl_ExternFile > &theExtFile) const
	Returns data on external file by its name Returns False if no external file with given name is read.

STEPControl_Writer &	ChangeWriter ()
	Returns basic reader for root file.

const STEPControl_Writer &	Writer () const
	Returns basic reader as const.

void	SetColorMode (const bool theColorMode)
	Set ColorMode for indicate write Colors or not.

bool	GetColorMode () const

void	SetNameMode (const bool theNameMode)
	Set NameMode for indicate write Name or not.

bool	GetNameMode () const

void	SetLayerMode (const bool theLayerMode)
	Set LayerMode for indicate write Layers or not.

bool	GetLayerMode () const

void	SetPropsMode (const bool thePropsMode)
	PropsMode for indicate write Validation properties or not.

bool	GetPropsMode () const

void	SetMetadataMode (const bool theMetadataMode)
	Set MetadataMode for indicate write metadata or not.

bool	GetMetadataMode () const

void	SetSHUOMode (const bool theSHUOMode)
	Set SHUO mode for indicate write SHUO or not.

bool	GetSHUOMode () const

void	SetDimTolMode (const bool theDimTolMode)
	Set dimtolmode for indicate write D&GTs or not.

bool	GetDimTolMode () const

void	SetMaterialMode (const bool theMaterialMode)
	Set flag for indicate write material or not.

bool	GetMaterialMode () const

void	SetVisualMaterialMode (const bool theVisualMaterialMode)
	Set flag for indicate write visual material or not.

bool	GetVisualMaterialMode () const

void	SetCleanDuplicates (const bool theCleanDuplicates)
	Set clean duplicates flag. If set to True, duplicates will be removed from the model.

bool	GetCleanDuplicates () const
	Returns the flag indicating whether duplicates should be removed from the model.

void	SetShapeFixParameters (const XSAlgo_ShapeProcessor::ParameterMap &theParameters)
	Sets parameters for shape processing.

void	SetShapeFixParameters (XSAlgo_ShapeProcessor::ParameterMap &&theParameters)
	Sets parameters for shape processing. Parameters are moved from the input map.

void	SetShapeFixParameters (const DE_ShapeFixParameters &theParameters, const XSAlgo_ShapeProcessor::ParameterMap &theAdditionalParameters={})
	Sets parameters for shape processing. Parameters from `theParameters` are copied to the internal map. Parameters from `theAdditionalParameters` are copied to the internal map if they are not present in `theParameters`.

const XSAlgo_ShapeProcessor::ParameterMap &	GetShapeFixParameters () const
	Returns parameters for shape processing that was set by SetParameters() method.

void	SetShapeProcessFlags (const ShapeProcess::OperationsFlags &theFlags)
	Sets flags defining operations to be performed on shapes.

const XSAlgo_ShapeProcessor::ProcessingFlags &	GetShapeProcessFlags () const
	Returns flags defining operations to be performed on shapes.

Protected Member Functions
bool	transfer (STEPControl_Writer &theWriter, const NCollection_Sequence< TDF_Label > &theLabels, const STEPControl_StepModelType theMode=STEPControl_AsIs, const char *const theIsMulti=nullptr, const bool isExternFile=false, const Message_ProgressRange &theProgress=Message_ProgressRange())
	Transfers labels to a STEP model Returns True if translation is OK isExternFile setting from transferExternFiles method.

TopoDS_Shape	transferExternFiles (const TDF_Label &theLabel, const STEPControl_StepModelType theMode, NCollection_Sequence< TDF_Label > &theLabelSeq, const StepData_Factors &theLocalFactors=StepData_Factors(), const char *const thePrefix="", const Message_ProgressRange &theProgress=Message_ProgressRange())
	Parses assembly structure of label L, writes all the simple shapes each to its own file named by name of its label plus prefix Returns shape representing that assembly structure in the form of nested empty compounds (and a sequence of labels which are newly written nodes of this assembly)

bool	writeExternRefs (const occ::handle< XSControl_WorkSession > &theWS, const NCollection_Sequence< TDF_Label > &theLabels) const
	Write external references to STEP.

bool	writeColors (const occ::handle< XSControl_WorkSession > &theWS, const NCollection_Sequence< TDF_Label > &theLabels)
	Write colors assigned to specified labels, to STEP model.

bool	writeNames (const occ::handle< XSControl_WorkSession > &theWS, const NCollection_Sequence< TDF_Label > &theLabels) const
	Write names assigned to specified labels, to STEP model.

bool	writeMetadata (const occ::handle< XSControl_WorkSession > &theWS, const NCollection_Sequence< TDF_Label > &theLabels) const
	Write metadata assigned to specified labels, to STEP model.

bool	writeMetadataForLabel (const occ::handle< XSControl_WorkSession > &theWS, const TDF_Label &theLabel) const
	Write metadata assigned to specified label, to STEP model.

void	writeMetadataRepresentationItem (const TCollection_AsciiString &theKey, const occ::handle< StepData_StepModel > &theModel, const occ::handle< StepShape_ShapeDefinitionRepresentation > &theShapeDefRep, const occ::handle< StepBasic_ProductDefinition > &theProdDef, const occ::handle< StepRepr_RepresentationItem > &theItem) const
	Write metadata representation item to STEP model.

bool	writeDGTs (const occ::handle< XSControl_WorkSession > &theWS, const NCollection_Sequence< TDF_Label > &theLabels) const
	Write D&GTs assigned to specified labels, to STEP model.

bool	writeDGTsAP242 (const occ::handle< XSControl_WorkSession > &theWS, const NCollection_Sequence< TDF_Label > &theLabels, const StepData_Factors &theLocalFactors=StepData_Factors())
	Write D&GTs assigned to specified labels, to STEP model, according AP242.

bool	writeMaterials (const occ::handle< XSControl_WorkSession > &theWS, const NCollection_Sequence< TDF_Label > &theLabels) const
	Write materials assigned to specified labels, to STEP model.

bool	writeValProps (const occ::handle< XSControl_WorkSession > &theWS, const NCollection_Sequence< TDF_Label > &theLabels, const char *const theIsMulti) const
	Write validation properties assigned to specified labels, to STEP model.

bool	writeLayers (const occ::handle< XSControl_WorkSession > &theWS, const NCollection_Sequence< TDF_Label > &theLabels) const
	Write layers assigned to specified labels, to STEP model.

bool	writeSHUOs (const occ::handle< XSControl_WorkSession > &theWS, const NCollection_Sequence< TDF_Label > &theLabels)
	Write SHUO assigned to specified component, to STEP model.

void	prepareUnit (const TDF_Label &theLabel, const occ::handle< StepData_StepModel > &theModel, StepData_Factors &theLocalFactors)
	Finds length units located in root of label If it exists, initializes local length unit from it Else initializes according to Cascade length unit.

occ::handle< StepRepr_ShapeAspect >	writeShapeAspect (const occ::handle< XSControl_WorkSession > &theWS, const TDF_Label theLabel, const TopoDS_Shape &theShape, occ::handle< StepRepr_RepresentationContext > &theRC, occ::handle< StepAP242_GeometricItemSpecificUsage > &theGISU)

void	writePresentation (const occ::handle< XSControl_WorkSession > &theWS, const TopoDS_Shape &thePresentation, const occ::handle< TCollection_HAsciiString > &thePrsName, const bool theHasSemantic, const bool theHasPlane, const gp_Ax2 &theAnnotationPlane, const gp_Pnt &theTextPosition, const occ::handle< Standard_Transient > &theDimension, const StepData_Factors &theLocalFactors=StepData_Factors())

occ::handle< StepDimTol_Datum >	writeDatumAP242 (const occ::handle< XSControl_WorkSession > &theWS, const NCollection_Sequence< TDF_Label > &theShapeL, const TDF_Label &theDatumL, const bool isFirstDTarget, const occ::handle< StepDimTol_Datum > &theWrittenDatum, const StepData_Factors &theLocalFactors=StepData_Factors())

void	writeToleranceZone (const occ::handle< XSControl_WorkSession > &theWS, const occ::handle< XCAFDimTolObjects_GeomToleranceObject > &theObject, const occ::handle< StepDimTol_GeometricTolerance > &theEntity, const occ::handle< StepRepr_RepresentationContext > &theRC)

void	writeGeomTolerance (const occ::handle< XSControl_WorkSession > &theWS, const NCollection_Sequence< TDF_Label > &theShapeSeqL, const TDF_Label &theGeomTolL, const occ::handle< NCollection_HArray1< StepDimTol_DatumSystemOrReference > > &theDatumSystem, const occ::handle< StepRepr_RepresentationContext > &theRC, const StepData_Factors &theLocalFactors=StepData_Factors())

Detailed Description

Provides a tool to write DECAF document to the STEP file. Besides transfer of shapes (including assemblies) provided by STEPControl, supports also colors and part names.

Also supports multifile writing

Constructor & Destructor Documentation

◆ STEPCAFControl_Writer() [1/2]

STEPCAFControl_Writer::STEPCAFControl_Writer ( )

Creates a writer with an empty STEP model and sets ColorMode, LayerMode, NameMode and PropsMode to true.

◆ STEPCAFControl_Writer() [2/2]

STEPCAFControl_Writer::STEPCAFControl_Writer	(	const occ::handle< XSControl_WorkSession > &	theWS,
		const bool	theScratch = true )

Creates a reader tool and attaches it to an already existing Session Clears the session if it was not yet set for STEP Clears the internal data structures.

Member Function Documentation

◆ ChangeWriter()

STEPControl_Writer & STEPCAFControl_Writer::ChangeWriter ( )

inline

Returns basic reader for root file.

◆ ExternFile() [1/2]

bool STEPCAFControl_Writer::ExternFile	(	const char *const	theName,
		occ::handle< STEPCAFControl_ExternFile > &	theExtFile ) const

Returns data on external file by its name Returns False if no external file with given name is read.

◆ ExternFile() [2/2]

bool STEPCAFControl_Writer::ExternFile	(	const TDF_Label &	theLabel,
		occ::handle< STEPCAFControl_ExternFile > &	theExtFile ) const

Returns data on external file by its original label Returns False if no external file with given name is read.

◆ ExternFiles()

const NCollection_DataMap< TCollection_AsciiString, occ::handle< STEPCAFControl_ExternFile > > & STEPCAFControl_Writer::ExternFiles ( ) const

inline

Returns data on external files Returns Null handle if no external files are read.

◆ GetCleanDuplicates()

bool STEPCAFControl_Writer::GetCleanDuplicates ( ) const

inline

Returns the flag indicating whether duplicates should be removed from the model.

Returns: the flag indicating whether duplicates should be removed from the model.

◆ GetColorMode()

bool STEPCAFControl_Writer::GetColorMode ( ) const

inline

◆ GetDimTolMode()

bool STEPCAFControl_Writer::GetDimTolMode ( ) const

inline

◆ GetLayerMode()

bool STEPCAFControl_Writer::GetLayerMode ( ) const

inline

◆ GetMaterialMode()

bool STEPCAFControl_Writer::GetMaterialMode ( ) const

inline

◆ GetMetadataMode()

bool STEPCAFControl_Writer::GetMetadataMode ( ) const

inline

◆ GetNameMode()

bool STEPCAFControl_Writer::GetNameMode ( ) const

inline

◆ GetPropsMode()

bool STEPCAFControl_Writer::GetPropsMode ( ) const

inline

◆ GetShapeFixParameters()

const XSAlgo_ShapeProcessor::ParameterMap & STEPCAFControl_Writer::GetShapeFixParameters ( ) const

Returns parameters for shape processing that was set by SetParameters() method.

Returns: the parameters for shape processing. Empty map if no parameters were set.

◆ GetShapeProcessFlags()

const XSAlgo_ShapeProcessor::ProcessingFlags & STEPCAFControl_Writer::GetShapeProcessFlags ( ) const

Returns flags defining operations to be performed on shapes.

Returns: Pair of values defining operations to be performed on shapes and a boolean value that indicates whether the flags were set.

◆ GetSHUOMode()

bool STEPCAFControl_Writer::GetSHUOMode ( ) const

inline

◆ GetVisualMaterialMode()

bool STEPCAFControl_Writer::GetVisualMaterialMode ( ) const

inline

◆ Init()

void STEPCAFControl_Writer::Init	(	const occ::handle< XSControl_WorkSession > &	theWS,
		const bool	theScratch = true )

Clears the internal data structures and attaches to a new session Clears the session if it was not yet set for STEP.

◆ Perform() [1/3]

bool STEPCAFControl_Writer::Perform	(	const occ::handle< TDocStd_Document > &	theDoc,
		const char *const	theFileName,
		const DESTEP_Parameters &	theParams,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

Transfers a document and writes it to a STEP file This method is utilized if there's a need to set parameters avoiding initialization from Interface_Static Returns True if translation is OK.

◆ Perform() [2/3]

bool STEPCAFControl_Writer::Perform	(	const occ::handle< TDocStd_Document > &	theDoc,
		const char *const	theFileName,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

Transfers a document and writes it to a STEP file Returns True if translation is OK.

◆ Perform() [3/3]

bool STEPCAFControl_Writer::Perform	(	const occ::handle< TDocStd_Document > &	theDoc,
		const TCollection_AsciiString &	theFileName,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

◆ prepareUnit()

void STEPCAFControl_Writer::prepareUnit	(	const TDF_Label &	theLabel,
		const occ::handle< StepData_StepModel > &	theModel,
		StepData_Factors &	theLocalFactors )

protected

Finds length units located in root of label If it exists, initializes local length unit from it Else initializes according to Cascade length unit.

◆ SetCleanDuplicates()

void STEPCAFControl_Writer::SetCleanDuplicates ( const bool theCleanDuplicates )

inline

Set clean duplicates flag. If set to True, duplicates will be removed from the model.

Parameters

theCleanDuplicates the flag to set.

◆ SetColorMode()

void STEPCAFControl_Writer::SetColorMode ( const bool theColorMode )

inline

Set ColorMode for indicate write Colors or not.

◆ SetDimTolMode()

void STEPCAFControl_Writer::SetDimTolMode ( const bool theDimTolMode )

inline

Set dimtolmode for indicate write D&GTs or not.

◆ SetLayerMode()

void STEPCAFControl_Writer::SetLayerMode ( const bool theLayerMode )

inline

Set LayerMode for indicate write Layers or not.

◆ SetMaterialMode()

void STEPCAFControl_Writer::SetMaterialMode ( const bool theMaterialMode )

inline

Set flag for indicate write material or not.

◆ SetMetadataMode()

void STEPCAFControl_Writer::SetMetadataMode ( const bool theMetadataMode )

inline

Set MetadataMode for indicate write metadata or not.

◆ SetNameMode()

void STEPCAFControl_Writer::SetNameMode ( const bool theNameMode )

inline

Set NameMode for indicate write Name or not.

◆ SetPropsMode()

void STEPCAFControl_Writer::SetPropsMode ( const bool thePropsMode )

inline

PropsMode for indicate write Validation properties or not.

◆ SetShapeFixParameters() [1/3]

void STEPCAFControl_Writer::SetShapeFixParameters	(	const DE_ShapeFixParameters &	theParameters,
		const XSAlgo_ShapeProcessor::ParameterMap &	theAdditionalParameters = {} )

Sets parameters for shape processing. Parameters from theParameters are copied to the internal map. Parameters from theAdditionalParameters are copied to the internal map if they are not present in theParameters.

Parameters

theParameters	the parameters for shape processing.
theAdditionalParameters	the additional parameters for shape processing.

◆ SetShapeFixParameters() [2/3]

void STEPCAFControl_Writer::SetShapeFixParameters ( const XSAlgo_ShapeProcessor::ParameterMap & theParameters )

Sets parameters for shape processing.

Parameters

theParameters the parameters for shape processing.

◆ SetShapeFixParameters() [3/3]

void STEPCAFControl_Writer::SetShapeFixParameters ( XSAlgo_ShapeProcessor::ParameterMap && theParameters )

Sets parameters for shape processing. Parameters are moved from the input map.

Parameters

theParameters the parameters for shape processing.

◆ SetShapeProcessFlags()

void STEPCAFControl_Writer::SetShapeProcessFlags ( const ShapeProcess::OperationsFlags & theFlags )

Sets flags defining operations to be performed on shapes.

Parameters

theFlags The flags defining operations to be performed on shapes.

◆ SetSHUOMode()

void STEPCAFControl_Writer::SetSHUOMode ( const bool theSHUOMode )

inline

Set SHUO mode for indicate write SHUO or not.

◆ SetVisualMaterialMode()

void STEPCAFControl_Writer::SetVisualMaterialMode ( const bool theVisualMaterialMode )

inline

Set flag for indicate write visual material or not.

◆ Transfer() [1/6]

bool STEPCAFControl_Writer::Transfer	(	const NCollection_Sequence< TDF_Label > &	theLabelSeq,
		const DESTEP_Parameters &	theParams,
		const STEPControl_StepModelType	theMode = STEPControl_AsIs,
		const char *const	theIsMulti = nullptr,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

Method to writing sequence of root assemblies or part of the file specified by use by one label. This method is utilized if there's a need to set parameters avoiding initialization from Interface_Static.

◆ Transfer() [2/6]

bool STEPCAFControl_Writer::Transfer	(	const NCollection_Sequence< TDF_Label > &	theLabelSeq,
		const STEPControl_StepModelType	theMode = STEPControl_AsIs,
		const char *const	theIsMulti = nullptr,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

Method to writing sequence of root assemblies or part of the file specified by use by one label.

◆ Transfer() [3/6]

bool STEPCAFControl_Writer::Transfer	(	const occ::handle< TDocStd_Document > &	theDoc,
		const DESTEP_Parameters &	theParams,
		const STEPControl_StepModelType	theMode = STEPControl_AsIs,
		const char *const	theIsMulti = nullptr,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

Transfers a document (or single label) to a STEP model This method uses if need to set parameters avoiding initialization from Interface_Static.

Parameters

theParams	configuration parameters
theMode	mode of translation of shape is AsIs
theIsMulti	if multi is not null pointer, it switches to multifile mode (with external refs), and string pointed by <multi> gives prefix for names of extern files (can be empty string)
theProgress	progress indicator Returns True if translation is OK

◆ Transfer() [4/6]

bool STEPCAFControl_Writer::Transfer	(	const occ::handle< TDocStd_Document > &	theDoc,
		const STEPControl_StepModelType	theMode = STEPControl_AsIs,
		const char *const	theIsMulti = nullptr,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

Transfers a document (or single label) to a STEP model The mode of translation of shape is AsIs If multi is not null pointer, it switches to multifile mode (with external refs), and string pointed by <multi> gives prefix for names of extern files (can be empty string) Returns True if translation is OK.

◆ Transfer() [5/6]

bool STEPCAFControl_Writer::Transfer	(	const TDF_Label &	theLabel,
		const DESTEP_Parameters &	theParams,
		const STEPControl_StepModelType	theMode = STEPControl_AsIs,
		const char *const	theIsMulti = nullptr,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

Method to transfer part of the document specified by label This method uses if need to set parameters avoiding initialization from Interface_Static.

◆ Transfer() [6/6]

bool STEPCAFControl_Writer::Transfer	(	const TDF_Label &	theLabel,
		const STEPControl_StepModelType	theMode = STEPControl_AsIs,
		const char *const	theIsMulti = nullptr,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

Method to transfer part of the document specified by label.

◆ transfer()

bool STEPCAFControl_Writer::transfer	(	STEPControl_Writer &	theWriter,
		const NCollection_Sequence< TDF_Label > &	theLabels,
		const STEPControl_StepModelType	theMode = STEPControl_AsIs,
		const char *const	theIsMulti = nullptr,
		const bool	isExternFile = false,
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

protected

Transfers labels to a STEP model Returns True if translation is OK isExternFile setting from transferExternFiles method.

◆ transferExternFiles()

TopoDS_Shape STEPCAFControl_Writer::transferExternFiles	(	const TDF_Label &	theLabel,
		const STEPControl_StepModelType	theMode,
		NCollection_Sequence< TDF_Label > &	theLabelSeq,
		const StepData_Factors &	theLocalFactors = StepData_Factors(),
		const char *const	thePrefix = "",
		const Message_ProgressRange &	theProgress = Message_ProgressRange() )

protected

Parses assembly structure of label L, writes all the simple shapes each to its own file named by name of its label plus prefix Returns shape representing that assembly structure in the form of nested empty compounds (and a sequence of labels which are newly written nodes of this assembly)

◆ Write()

IFSelect_ReturnStatus STEPCAFControl_Writer::Write ( const char *const theFileName )

Writes all the produced models into file In case of multimodel with extern references, filename will be a name of root file, all other files have names of corresponding parts Provided for use like single-file writer.

◆ writeColors()

bool STEPCAFControl_Writer::writeColors	(	const occ::handle< XSControl_WorkSession > &	theWS,
		const NCollection_Sequence< TDF_Label > &	theLabels )

protected

Write colors assigned to specified labels, to STEP model.

◆ writeDatumAP242()

occ::handle< StepDimTol_Datum > STEPCAFControl_Writer::writeDatumAP242	(	const occ::handle< XSControl_WorkSession > &	theWS,
		const NCollection_Sequence< TDF_Label > &	theShapeL,
		const TDF_Label &	theDatumL,
		const bool	isFirstDTarget,
		const occ::handle< StepDimTol_Datum > &	theWrittenDatum,
		const StepData_Factors &	theLocalFactors = StepData_Factors() )

protected

◆ writeDGTs()

bool STEPCAFControl_Writer::writeDGTs	(	const occ::handle< XSControl_WorkSession > &	theWS,
		const NCollection_Sequence< TDF_Label > &	theLabels ) const

protected

Write D&GTs assigned to specified labels, to STEP model.

◆ writeDGTsAP242()

bool STEPCAFControl_Writer::writeDGTsAP242	(	const occ::handle< XSControl_WorkSession > &	theWS,
		const NCollection_Sequence< TDF_Label > &	theLabels,
		const StepData_Factors &	theLocalFactors = StepData_Factors() )

protected

Write D&GTs assigned to specified labels, to STEP model, according AP242.

◆ writeExternRefs()

bool STEPCAFControl_Writer::writeExternRefs	(	const occ::handle< XSControl_WorkSession > &	theWS,
		const NCollection_Sequence< TDF_Label > &	theLabels ) const

protected

Write external references to STEP.

◆ writeGeomTolerance()

void STEPCAFControl_Writer::writeGeomTolerance	(	const occ::handle< XSControl_WorkSession > &	theWS,
		const NCollection_Sequence< TDF_Label > &	theShapeSeqL,
		const TDF_Label &	theGeomTolL,
		const occ::handle< NCollection_HArray1< StepDimTol_DatumSystemOrReference > > &	theDatumSystem,
		const occ::handle< StepRepr_RepresentationContext > &	theRC,
		const StepData_Factors &	theLocalFactors = StepData_Factors() )

protected

◆ writeLayers()

bool STEPCAFControl_Writer::writeLayers	(	const occ::handle< XSControl_WorkSession > &	theWS,
		const NCollection_Sequence< TDF_Label > &	theLabels ) const

protected

Write layers assigned to specified labels, to STEP model.

◆ writeMaterials()

bool STEPCAFControl_Writer::writeMaterials	(	const occ::handle< XSControl_WorkSession > &	theWS,
		const NCollection_Sequence< TDF_Label > &	theLabels ) const

protected

Write materials assigned to specified labels, to STEP model.

◆ writeMetadata()

bool STEPCAFControl_Writer::writeMetadata	(	const occ::handle< XSControl_WorkSession > &	theWS,
		const NCollection_Sequence< TDF_Label > &	theLabels ) const

protected

Write metadata assigned to specified labels, to STEP model.

◆ writeMetadataForLabel()

bool STEPCAFControl_Writer::writeMetadataForLabel	(	const occ::handle< XSControl_WorkSession > &	theWS,
		const TDF_Label &	theLabel ) const

protected

Write metadata assigned to specified label, to STEP model.

◆ writeMetadataRepresentationItem()

void STEPCAFControl_Writer::writeMetadataRepresentationItem	(	const TCollection_AsciiString &	theKey,
		const occ::handle< StepData_StepModel > &	theModel,
		const occ::handle< StepShape_ShapeDefinitionRepresentation > &	theShapeDefRep,
		const occ::handle< StepBasic_ProductDefinition > &	theProdDef,
		const occ::handle< StepRepr_RepresentationItem > &	theItem ) const

protected

Write metadata representation item to STEP model.

Parameters

theKey	The key for metadata item.
theModel	The STEP model to write to.
theShapeDefRep	The shape definition representation.
theProdDef	The product definition.
theItem	The representation item to write.

◆ writeNames()

bool STEPCAFControl_Writer::writeNames	(	const occ::handle< XSControl_WorkSession > &	theWS,
		const NCollection_Sequence< TDF_Label > &	theLabels ) const

protected

Write names assigned to specified labels, to STEP model.

◆ writePresentation()

void STEPCAFControl_Writer::writePresentation	(	const occ::handle< XSControl_WorkSession > &	theWS,
		const TopoDS_Shape &	thePresentation,
		const occ::handle< TCollection_HAsciiString > &	thePrsName,
		const bool	theHasSemantic,
		const bool	theHasPlane,
		const gp_Ax2 &	theAnnotationPlane,
		const gp_Pnt &	theTextPosition,
		const occ::handle< Standard_Transient > &	theDimension,
		const StepData_Factors &	theLocalFactors = StepData_Factors() )

protected

◆ Writer()

const STEPControl_Writer & STEPCAFControl_Writer::Writer ( ) const

inline

Returns basic reader as const.

◆ writeShapeAspect()

occ::handle< StepRepr_ShapeAspect > STEPCAFControl_Writer::writeShapeAspect	(	const occ::handle< XSControl_WorkSession > &	theWS,
		const TDF_Label	theLabel,
		const TopoDS_Shape &	theShape,
		occ::handle< StepRepr_RepresentationContext > &	theRC,
		occ::handle< StepAP242_GeometricItemSpecificUsage > &	theGISU )

protected

◆ writeSHUOs()

bool STEPCAFControl_Writer::writeSHUOs	(	const occ::handle< XSControl_WorkSession > &	theWS,
		const NCollection_Sequence< TDF_Label > &	theLabels )

protected

Write SHUO assigned to specified component, to STEP model.

◆ WriteStream()

IFSelect_ReturnStatus STEPCAFControl_Writer::WriteStream ( std::ostream & theStream )

Writes all the produced models into the stream. Provided for use like single-file writer.

◆ writeToleranceZone()

void STEPCAFControl_Writer::writeToleranceZone	(	const occ::handle< XSControl_WorkSession > &	theWS,
		const occ::handle< XCAFDimTolObjects_GeomToleranceObject > &	theObject,
		const occ::handle< StepDimTol_GeometricTolerance > &	theEntity,
		const occ::handle< StepRepr_RepresentationContext > &	theRC )

protected

◆ writeValProps()

bool STEPCAFControl_Writer::writeValProps	(	const occ::handle< XSControl_WorkSession > &	theWS,
		const NCollection_Sequence< TDF_Label > &	theLabels,
		const char *const	theIsMulti ) const

protected

Write validation properties assigned to specified labels, to STEP model.

The documentation for this class was generated from the following file:

STEPCAFControl_Writer.hxx

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ STEPCAFControl_Writer() [1/2]

◆ STEPCAFControl_Writer() [2/2]

Member Function Documentation

◆ ChangeWriter()

◆ ExternFile() [1/2]

◆ ExternFile() [2/2]

◆ ExternFiles()

◆ GetCleanDuplicates()

◆ GetColorMode()

◆ GetDimTolMode()

◆ GetLayerMode()

◆ GetMaterialMode()

◆ GetMetadataMode()

◆ GetNameMode()

◆ GetPropsMode()

◆ GetShapeFixParameters()

◆ GetShapeProcessFlags()

◆ GetSHUOMode()

◆ GetVisualMaterialMode()

◆ Init()

◆ Perform() [1/3]

◆ Perform() [2/3]

◆ Perform() [3/3]

◆ prepareUnit()

◆ SetCleanDuplicates()

◆ SetColorMode()

◆ SetDimTolMode()

◆ SetLayerMode()

◆ SetMaterialMode()

◆ SetMetadataMode()

◆ SetNameMode()

◆ SetPropsMode()

◆ SetShapeFixParameters() [1/3]

◆ SetShapeFixParameters() [2/3]

◆ SetShapeFixParameters() [3/3]

◆ SetShapeProcessFlags()

◆ SetSHUOMode()

◆ SetVisualMaterialMode()

◆ Transfer() [1/6]

◆ Transfer() [2/6]

◆ Transfer() [3/6]

◆ Transfer() [4/6]

◆ Transfer() [5/6]

◆ Transfer() [6/6]

◆ transfer()

◆ transferExternFiles()

◆ Write()

◆ writeColors()

◆ writeDatumAP242()

◆ writeDGTs()

◆ writeDGTsAP242()

◆ writeExternRefs()

◆ writeGeomTolerance()

◆ writeLayers()

◆ writeMaterials()

◆ writeMetadata()

◆ writeMetadataForLabel()

◆ writeMetadataRepresentationItem()

◆ writeNames()

◆ writePresentation()

◆ Writer()

◆ writeShapeAspect()

◆ writeSHUOs()

◆ WriteStream()

◆ writeToleranceZone()

◆ writeValProps()