OCC.Core.STEPCAFControl module

STEPCAFControl module, see official documentation at https://www.opencascade.com/doc/occt-7.4.0/refman/html/package_stepcafcontrol.html

class STEPCAFControl_ActorWrite(*args)

Bases: OCC.Core.STEPControl.STEPControl_ActorWrite

Return type

None

ClearMap()

• Clears map of shapes registered as assemblies

  rtype

  None

static DownCast(t)

RegisterAssembly()

• Registers shape to be written as assembly The shape should be TopoDS_Compound (else does nothing)

  param S

  type S

  TopoDS_Shape &

  rtype

  None

SetStdMode()

• Set standard mode of work In standard mode Actor (default) behaves exactly as its ancestor, also map is cleared

  param stdmode

  default value is Standard_True

  type stdmode

  bool

  rtype

  None

property thisown

The membership flag

class STEPCAFControl_Controller(*args)

Bases: OCC.Core.STEPControl.STEPControl_Controller

• Initializes the use of STEP Norm (the first time)

  rtype

  None

static DownCast(t)

static Init()

• Standard Initialisation. It creates a Controller for STEP-XCAF and records it to various names, available to select it later Returns True when done, False if could not be done

  rtype

  bool

property thisown

The membership flag

class STEPCAFControl_DataMapOfLabelExternFile(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class STEPCAFControl_DataMapOfLabelShape(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class STEPCAFControl_DataMapOfPDExternFile(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class STEPCAFControl_DataMapOfSDRExternFile(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class STEPCAFControl_DataMapOfShapePD(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class STEPCAFControl_DataMapOfShapeSDR(*args)

Bases: object

Assign()

Bind()

Bound()

ChangeFind()

ChangeSeek()

Clear()

Exchange()

Find()

IsBound()

ReSize()

Seek()

Set()

Size()

UnBind()

begin()

cbegin()

cend()

end()

property thisown

The membership flag

class STEPCAFControl_ExternFile(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates an empty structure

  rtype

  None

static DownCast(t)

GetLabel()

Return type

TDF_Label

GetLoadStatus()

Return type

IFSelect_ReturnStatus

GetName()

Return type

opencascade::handle<TCollection_HAsciiString>

GetTransferStatus()

Return type

bool

GetWS()

Return type

opencascade::handle<XSControl_WorkSession>

GetWriteStatus()

Return type

IFSelect_ReturnStatus

SetLabel()

Parameters

L –

type L

TDF_Label &

rtype

None

SetLoadStatus()

Parameters

stat –

type stat

IFSelect_ReturnStatus

rtype

None

SetName()

Parameters

name –

type name

opencascade::handle<TCollection_HAsciiString> &

rtype

None

SetTransferStatus()

Parameters

isok –

type isok

bool

rtype

None

SetWS()

Parameters

WS –

type WS

opencascade::handle<XSControl_WorkSession> &

rtype

None

SetWriteStatus()

Parameters

stat –

type stat

IFSelect_ReturnStatus

rtype

None

property thisown

The membership flag

class STEPCAFControl_GDTProperty(*args)

Bases: object

Return type

None

static GetDatumRefModifiers()

Parameters

theModifiers –

type theModifiers

XCAFDimTolObjects_DatumModifiersSequence

param theModifWithVal

type theModifWithVal

XCAFDimTolObjects_DatumModifWithValue

param theValue

type theValue

float

param theUnit

type theUnit

StepBasic_Unit

rtype

opencascade::handle<StepDimTol_HArray1OfDatumReferenceModifier>

static GetDatumTargetName()

Parameters

theDatumType –

type theDatumType

XCAFDimTolObjects_DatumTargetType

rtype

opencascade::handle<TCollection_HAsciiString>

static GetDatumTargetType()

Parameters

theDescription –

type theDescription

opencascade::handle<TCollection_HAsciiString> &

param theType

type theType

XCAFDimTolObjects_DatumTargetType &

rtype

bool

static GetDimClassOfTolerance()

Parameters

theLAF –

type theLAF

opencascade::handle<StepShape_LimitsAndFits> &

param theHolle

type theHolle

bool

param theFV

type theFV

XCAFDimTolObjects_DimensionFormVariance &

param theG

type theG

XCAFDimTolObjects_DimensionGrade &

rtype

void

static GetDimModifierName()

Parameters

theModifier –

type theModifier

XCAFDimTolObjects_DimensionModif

rtype

opencascade::handle<TCollection_HAsciiString>

static GetDimModifiers()

Parameters

theCRI –

type theCRI

opencascade::handle<StepRepr_CompoundRepresentationItem> &

param theModifiers

type theModifiers

XCAFDimTolObjects_DimensionModifiersSequence &

rtype

void

static GetDimQualifierName()

Parameters

theQualifier –

type theQualifier

XCAFDimTolObjects_DimensionQualifier

rtype

opencascade::handle<TCollection_HAsciiString>

static GetDimQualifierType()

Parameters

theDescription –

type theDescription

opencascade::handle<TCollection_HAsciiString> &

param theType

type theType

XCAFDimTolObjects_DimensionQualifier &

rtype

bool

static GetDimType()

Parameters

theName –

type theName

opencascade::handle<TCollection_HAsciiString> &

param theType

type theType

XCAFDimTolObjects_DimensionType &

rtype

bool

static GetDimTypeName()

Parameters

theType –

type theType

XCAFDimTolObjects_DimensionType

rtype

opencascade::handle<TCollection_HAsciiString>

static GetGeomTolerance()

Parameters

theType –

type theType

XCAFDimTolObjects_GeomToleranceType

rtype

opencascade::handle<StepDimTol_GeometricTolerance>

static GetGeomToleranceModifier()

Parameters

theModifier –

type theModifier

XCAFDimTolObjects_GeomToleranceModif

rtype

StepDimTol_GeometricToleranceModifier

static GetGeomToleranceType()

Parameters

theType –

type theType

XCAFDimTolObjects_GeomToleranceType

rtype

StepDimTol_GeometricToleranceType:param theType:

type theType

StepDimTol_GeometricToleranceType

rtype

XCAFDimTolObjects_GeomToleranceType

static GetLimitsAndFits()

Parameters

theHole –

type theHole

bool

param theFormVariance

type theFormVariance

XCAFDimTolObjects_DimensionFormVariance

param theGrade

type theGrade

XCAFDimTolObjects_DimensionGrade

rtype

opencascade::handle<StepShape_LimitsAndFits>

static GetTessellation()

Parameters

theShape –

type theShape

TopoDS_Shape

rtype

opencascade::handle<StepVisual_TessellatedGeometricSet>

static GetTolValueType()

Parameters

theDescription –

type theDescription

opencascade::handle<TCollection_HAsciiString> &

param theType

type theType

XCAFDimTolObjects_GeomToleranceTypeValue &

rtype

bool:param theType:

type theType

XCAFDimTolObjects_GeomToleranceTypeValue &

rtype

opencascade::handle<TCollection_HAsciiString>

static IsDimensionalLocation()

Parameters

theType –

type theType

XCAFDimTolObjects_DimensionType

rtype

bool

static IsDimensionalSize()

Parameters

theType –

type theType

XCAFDimTolObjects_DimensionType

rtype

bool

property thisown

The membership flag

class STEPCAFControl_Reader(*args)

Bases: object

• Creates a reader with an empty STEP model and sets ColorMode, LayerMode, NameMode and PropsMode to Standard_True.

  rtype

  None* Creates a reader tool and attaches it to an already existing Session Clears the session if it was not yet set for STEP

  param WS

  type WS

  opencascade::handle<XSControl_WorkSession> &

  param scratch

  default value is Standard_True

  type scratch

  bool

  rtype

  None

ChangeReader()

• Returns basic reader

  rtype

  STEPControl_Reader

ExternFile()

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

  param name

  type name

  char *

  param ef

  type ef

  opencascade::handle<STEPCAFControl_ExternFile> &

  rtype

  bool

ExternFiles()

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

  rtype

  NCollection_DataMap<TCollection_AsciiString, opencascade::handle<STEPCAFControl_ExternFile> >

static FindInstance()

• Returns label of instance of an assembly component corresponding to a given NAUO

  param NAUO

  type NAUO

  opencascade::handle<StepRepr_NextAssemblyUsageOccurrence> &

  param STool

  type STool

  opencascade::handle<XCAFDoc_ShapeTool> &

  param Tool

  type Tool

  STEPConstruct_Tool &

  param ShapeLabelMap

  type ShapeLabelMap

  XCAFDoc_DataMapOfShapeLabel &

  rtype

  TDF_Label

GetColorMode()

Return type

bool

GetGDTMode()

Return type

bool

GetLayerMode()

Return type

bool

GetMatMode()

Return type

bool

GetNameMode()

Return type

bool

GetPropsMode()

Return type

bool

GetSHUOMode()

Return type

bool

GetViewMode()

• Get View mode

  rtype

  bool

Init()

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

  param WS

  type WS

  opencascade::handle<XSControl_WorkSession> &

  param scratch

  default value is Standard_True

  type scratch

  bool

  rtype

  None

NbRootsForTransfer()

• Returns number of roots recognized for transfer Shortcut for Reader().NbRootsForTransfer()

  rtype

  int

Perform()

Parameters

filename –

type filename

TCollection_AsciiString &

param doc

type doc

opencascade::handle<TDocStd_Document> &

rtype

bool* Translate STEP file given by filename into the document Return True if succeeded, and False in case of fail

param filename

type filename

char *

param doc

type doc

opencascade::handle<TDocStd_Document> &

rtype

bool

ReadFile()

• Loads a file and returns the read status Provided for use like single-file reader

  param filename

  type filename

  char *

  rtype

  IFSelect_ReturnStatus

Reader()

• Returns basic reader as const

  rtype

  STEPControl_Reader

SetColorMode()

• Set ColorMode for indicate read Colors or not.

  param colormode

  type colormode

  bool

  rtype

  None

SetGDTMode()

• Set GDT mode for indicate write GDT or not.

  param gdtmode

  type gdtmode

  bool

  rtype

  None

SetLayerMode()

• Set LayerMode for indicate read Layers or not.

  param layermode

  type layermode

  bool

  rtype

  None

SetMatMode()

• Set Material mode

  param matmode

  type matmode

  bool

  rtype

  None

SetNameMode()

• Set NameMode for indicate read Name or not.

  param namemode

  type namemode

  bool

  rtype

  None

SetPropsMode()

• PropsMode for indicate read Validation properties or not.

  param propsmode

  type propsmode

  bool

  rtype

  None

SetSHUOMode()

• Set SHUO mode for indicate write SHUO or not.

  param shuomode

  type shuomode

  bool

  rtype

  None

SetSourceCodePage()

• Return the encoding of STEP file for converting names into UNICODE.

  param theCode

  type theCode

  Resource_FormatType

  rtype

  None

SetViewMode()

• Set View mode

  param viewmode

  type viewmode

  bool

  rtype

  None

SourceCodePage()

• Return the encoding of STEP file for converting names into UNICODE. Initialized from ‘read.stepcaf.codepage’ variable by constructor, which is Resource_UTF8 by default.

  rtype

  Resource_FormatType

Transfer()

• Translates currently loaded STEP file into the document Returns True if succeeded, and False in case of fail Provided for use like single-file reader

  param doc

  type doc

  opencascade::handle<TDocStd_Document> &

  rtype

  bool

TransferOneRoot()

• Translates currently loaded STEP file into the document Returns True if succeeded, and False in case of fail Provided for use like single-file reader

  param num

  type num

  int

  param doc

  type doc

  opencascade::handle<TDocStd_Document> &

  rtype

  bool

property thisown

The membership flag

class STEPCAFControl_Writer(*args)

Bases: object

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

  rtype

  None* 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

  param WS

  type WS

  opencascade::handle<XSControl_WorkSession> &

  param scratch

  default value is Standard_True

  type scratch

  bool

  rtype

  None

ChangeWriter()

• Returns basic reader for root file

  rtype

  STEPControl_Writer

ExternFile()

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

  param L

  type L

  TDF_Label &

  param ef

  type ef

  opencascade::handle<STEPCAFControl_ExternFile> &

  rtype

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

  param name

  type name

  char *

  param ef

  type ef

  opencascade::handle<STEPCAFControl_ExternFile> &

  rtype

  bool

ExternFiles()

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

  rtype

  NCollection_DataMap<TCollection_AsciiString, opencascade::handle<STEPCAFControl_ExternFile> >

GetColorMode()

Return type

bool

GetDimTolMode()

Return type

bool

GetLayerMode()

Return type

bool

GetMaterialMode()

Return type

bool

GetNameMode()

Return type

bool

GetPropsMode()

Return type

bool

GetSHUOMode()

Return type

bool

Init()

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

  param WS

  type WS

  opencascade::handle<XSControl_WorkSession> &

  param scratch

  default value is Standard_True

  type scratch

  bool

  rtype

  None

Perform()

Parameters

doc –

type doc

opencascade::handle<TDocStd_Document> &

param filename

type filename

TCollection_AsciiString &

rtype

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

param doc

type doc

opencascade::handle<TDocStd_Document> &

param filename

type filename

char *

rtype

bool

SetColorMode()

• Set ColorMode for indicate write Colors or not.

  param colormode

  type colormode

  bool

  rtype

  None

SetDimTolMode()

• Set dimtolmode for indicate write D&GTs or not.

  param dimtolmode

  type dimtolmode

  bool

  rtype

  None

SetLayerMode()

• Set LayerMode for indicate write Layers or not.

  param layermode

  type layermode

  bool

  rtype

  None

SetMaterialMode()

• Set dimtolmode for indicate write D&GTs or not.

  param matmode

  type matmode

  bool

  rtype

  None

SetNameMode()

• Set NameMode for indicate write Name or not.

  param namemode

  type namemode

  bool

  rtype

  None

SetPropsMode()

• PropsMode for indicate write Validation properties or not.

  param propsmode

  type propsmode

  bool

  rtype

  None

SetSHUOMode()

• Set SHUO mode for indicate write SHUO or not.

  param shuomode

  type shuomode

  bool

  rtype

  None

Transfer()

• 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

  param doc

  type doc

  opencascade::handle<TDocStd_Document> &

  param mode

  default value is STEPControl_AsIs

  type mode

  STEPControl_StepModelType

  param multi

  default value is 0

  type multi

  char *

  rtype

  bool* Method to transfer part of the document specified by label

  param L

  type L

  TDF_Label &

  param mode

  default value is STEPControl_AsIs

  type mode

  STEPControl_StepModelType

  param multi

  default value is 0

  type multi

  char *

  rtype

  bool

Write()

• 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

  param filename

  type filename

  char *

  rtype

  IFSelect_ReturnStatus

Writer()

• Returns basic reader as const

  rtype

  STEPControl_Writer

property thisown

The membership flag

class SwigPyIterator(*args, **kwargs)

Bases: object

advance()

copy()

decr()

distance()

equal()

incr()

next()

previous()

property thisown

The membership flag

value()