DiscussionsIssue archiveOCCT:Documentation

Archived issue #0026331

Documentation of compgraph parameter of STEPControl_Writer::Transfer () is missing

CommunityOCCT:Documentationnew1 public note

Search issues

Description

The code documentation as well as the STEP User's guide does not explain the third parameter of the function STEPControl_Writer::Transfer().

As stated on the forum [https://dev.opencascade.org/content/tip-how-improve-performance-when-stepcontrolwritertransfer-called-often], when STEPControl_Writer::Transfer () is called multiple times in order to export a list of shapes to a common STEP file, the performance might be bad because the third parameter "compgraph" of the Transfer function is true by default. It means after every translation of a shape the graph is rebuilt.

Instead this parameter can be set to false and only after all shapes are translated the graph can be built once only by:

  writer.WS()->ComputeGraph(Standard_True );

The documentation should explain the meaning of the parameter and possibly hint at better performance, when it is set to false and the graph is explicitly built after all translations.

IFSelect_WorkSession::ComputeGraph contains some documentation which might be used in part.

Public activity

1 archived note

Participants are labeled by their role within this record.

01Commenter 1
This request is out of my competence. Please, provide a description.