OCC.STEPCAFControl module

class Handle_STEPCAFControl_ActorWrite(*args)

Bases: OCC.STEPControl.Handle_STEPControl_ActorWrite

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_STEPCAFControl_Controller(*args)

Bases: OCC.STEPControl.Handle_STEPControl_Controller

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_STEPCAFControl_DataMapNodeOfDataMapOfLabelExternFile(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_STEPCAFControl_DataMapNodeOfDataMapOfLabelShape(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_STEPCAFControl_DataMapNodeOfDataMapOfPDExternFile(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_STEPCAFControl_DataMapNodeOfDataMapOfSDRExternFile(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_STEPCAFControl_DataMapNodeOfDataMapOfShapePD(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_STEPCAFControl_DataMapNodeOfDataMapOfShapeSDR(*args)

Bases: OCC.TCollection.Handle_TCollection_MapNode

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_STEPCAFControl_DictionaryOfExternFile(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_STEPCAFControl_ExternFile(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class Handle_STEPCAFControl_StackItemOfDictionaryOfExternFile(*args)

Bases: OCC.MMgt.Handle_MMgt_TShared

static DownCast()
GetObject()
IsNull()
Nullify()
thisown

The membership flag

class STEPCAFControl_ActorWrite(*args)

Bases: OCC.STEPControl.STEPControl_ActorWrite

Return type:None
ClearMap()
  • Clears map of shapes registered as assemblies
Return type:None
GetHandle()
RegisterAssembly()
  • Registers shape to be written as assembly The shape should be TopoDS_Compound (else does nothing)
Parameters:S (TopoDS_Shape &) –
Return type:None
SetStdMode()
  • Set standard mode of work In standard mode Actor (default) behaves exactly as its ancestor, also map is cleared
Parameters:stdmode (bool) – default value is Standard_True
Return type:None
thisown

The membership flag

class STEPCAFControl_Controller(*args)

Bases: OCC.STEPControl.STEPControl_Controller

  • Initializes the use of STEP Norm (the first time)
Return type:None
GetHandle()
static Init(*args)
  • 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
Return type:bool
thisown

The membership flag

STEPCAFControl_Controller_Init(*args)
  • 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
Return type:bool
class STEPCAFControl_DataMapIteratorOfDataMapOfLabelExternFile(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (STEPCAFControl_DataMapOfLabelExternFile &) –
Return type:None
Initialize()
Parameters:aMap (STEPCAFControl_DataMapOfLabelExternFile &) –
Return type:None
Key()
Return type:TDF_Label
Value()
Return type:Handle_STEPCAFControl_ExternFile
thisown

The membership flag

class STEPCAFControl_DataMapIteratorOfDataMapOfLabelShape(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (STEPCAFControl_DataMapOfLabelShape &) –
Return type:None
Initialize()
Parameters:aMap (STEPCAFControl_DataMapOfLabelShape &) –
Return type:None
Key()
Return type:TDF_Label
Value()
Return type:TopoDS_Shape
thisown

The membership flag

class STEPCAFControl_DataMapIteratorOfDataMapOfPDExternFile(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (STEPCAFControl_DataMapOfPDExternFile &) –
Return type:None
Initialize()
Parameters:aMap (STEPCAFControl_DataMapOfPDExternFile &) –
Return type:None
Key()
Return type:Handle_StepBasic_ProductDefinition
Value()
Return type:Handle_STEPCAFControl_ExternFile
thisown

The membership flag

class STEPCAFControl_DataMapIteratorOfDataMapOfSDRExternFile(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (STEPCAFControl_DataMapOfSDRExternFile &) –
Return type:None
Initialize()
Parameters:aMap (STEPCAFControl_DataMapOfSDRExternFile &) –
Return type:None
Key()
Return type:Handle_StepShape_ShapeDefinitionRepresentation
Value()
Return type:Handle_STEPCAFControl_ExternFile
thisown

The membership flag

class STEPCAFControl_DataMapIteratorOfDataMapOfShapePD(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (STEPCAFControl_DataMapOfShapePD &) –
Return type:None
Initialize()
Parameters:aMap (STEPCAFControl_DataMapOfShapePD &) –
Return type:None
Key()
Return type:TopoDS_Shape
Value()
Return type:Handle_StepBasic_ProductDefinition
thisown

The membership flag

class STEPCAFControl_DataMapIteratorOfDataMapOfShapeSDR(*args)

Bases: OCC.TCollection.TCollection_BasicMapIterator

Return type:None
Parameters:aMap (STEPCAFControl_DataMapOfShapeSDR &) –
Return type:None
Initialize()
Parameters:aMap (STEPCAFControl_DataMapOfShapeSDR &) –
Return type:None
Key()
Return type:TopoDS_Shape
Value()
Return type:Handle_StepShape_ShapeDefinitionRepresentation
thisown

The membership flag

class STEPCAFControl_DataMapNodeOfDataMapOfLabelExternFile(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K (TDF_Label &) –
  • I (Handle_STEPCAFControl_ExternFile &) –
  • n (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
Key()
Return type:TDF_Label
Value()
Return type:Handle_STEPCAFControl_ExternFile
thisown

The membership flag

class STEPCAFControl_DataMapNodeOfDataMapOfLabelShape(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K (TDF_Label &) –
  • I (TopoDS_Shape &) –
  • n (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
Key()
Return type:TDF_Label
Value()
Return type:TopoDS_Shape
thisown

The membership flag

class STEPCAFControl_DataMapNodeOfDataMapOfPDExternFile(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K (Handle_StepBasic_ProductDefinition &) –
  • I (Handle_STEPCAFControl_ExternFile &) –
  • n (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
Key()
Return type:Handle_StepBasic_ProductDefinition
Value()
Return type:Handle_STEPCAFControl_ExternFile
thisown

The membership flag

class STEPCAFControl_DataMapNodeOfDataMapOfSDRExternFile(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K (Handle_StepShape_ShapeDefinitionRepresentation &) –
  • I (Handle_STEPCAFControl_ExternFile &) –
  • n (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
Key()
Return type:Handle_StepShape_ShapeDefinitionRepresentation
Value()
Return type:Handle_STEPCAFControl_ExternFile
thisown

The membership flag

class STEPCAFControl_DataMapNodeOfDataMapOfShapePD(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K (TopoDS_Shape &) –
  • I (Handle_StepBasic_ProductDefinition &) –
  • n (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
Key()
Return type:TopoDS_Shape
Value()
Return type:Handle_StepBasic_ProductDefinition
thisown

The membership flag

class STEPCAFControl_DataMapNodeOfDataMapOfShapeSDR(*args)

Bases: OCC.TCollection.TCollection_MapNode

Parameters:
  • K (TopoDS_Shape &) –
  • I (Handle_StepShape_ShapeDefinitionRepresentation &) –
  • n (TCollection_MapNodePtr &) –
Return type:

None

GetHandle()
Key()
Return type:TopoDS_Shape
Value()
Return type:Handle_StepShape_ShapeDefinitionRepresentation
thisown

The membership flag

class STEPCAFControl_DataMapOfLabelExternFile(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:NbBuckets (int) – default value is 1
Return type:None
Assign()
Parameters:Other (STEPCAFControl_DataMapOfLabelExternFile &) –
Return type:STEPCAFControl_DataMapOfLabelExternFile
Bind()
Parameters:
  • K (TDF_Label &) –
  • I (Handle_STEPCAFControl_ExternFile &) –
Return type:

bool

ChangeFind()
Parameters:K (TDF_Label &) –
Return type:Handle_STEPCAFControl_ExternFile
ChangeFind1()
Parameters:K (TDF_Label &) –
Return type:Standard_Address
Clear()
Return type:None
Find()
Parameters:K (TDF_Label &) –
Return type:Handle_STEPCAFControl_ExternFile
Find1()
Parameters:K (TDF_Label &) –
Return type:Standard_Address
IsBound()
Parameters:K (TDF_Label &) –
Return type:bool
ReSize()
Parameters:NbBuckets (int) –
Return type:None
Set()
Parameters:Other (STEPCAFControl_DataMapOfLabelExternFile &) –
Return type:STEPCAFControl_DataMapOfLabelExternFile
UnBind()
Parameters:K (TDF_Label &) –
Return type:bool
thisown

The membership flag

class STEPCAFControl_DataMapOfLabelShape(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:NbBuckets (int) – default value is 1
Return type:None
Assign()
Parameters:Other (STEPCAFControl_DataMapOfLabelShape &) –
Return type:STEPCAFControl_DataMapOfLabelShape
Bind()
Parameters:
  • K (TDF_Label &) –
  • I (TopoDS_Shape &) –
Return type:

bool

ChangeFind()
Parameters:K (TDF_Label &) –
Return type:TopoDS_Shape
ChangeFind1()
Parameters:K (TDF_Label &) –
Return type:Standard_Address
Clear()
Return type:None
Find()
Parameters:K (TDF_Label &) –
Return type:TopoDS_Shape
Find1()
Parameters:K (TDF_Label &) –
Return type:Standard_Address
IsBound()
Parameters:K (TDF_Label &) –
Return type:bool
ReSize()
Parameters:NbBuckets (int) –
Return type:None
Set()
Parameters:Other (STEPCAFControl_DataMapOfLabelShape &) –
Return type:STEPCAFControl_DataMapOfLabelShape
UnBind()
Parameters:K (TDF_Label &) –
Return type:bool
thisown

The membership flag

class STEPCAFControl_DataMapOfPDExternFile(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:NbBuckets (int) – default value is 1
Return type:None
Assign()
Parameters:Other (STEPCAFControl_DataMapOfPDExternFile &) –
Return type:STEPCAFControl_DataMapOfPDExternFile
Bind()
Parameters:
  • K (Handle_StepBasic_ProductDefinition &) –
  • I (Handle_STEPCAFControl_ExternFile &) –
Return type:

bool

ChangeFind()
Parameters:K (Handle_StepBasic_ProductDefinition &) –
Return type:Handle_STEPCAFControl_ExternFile
ChangeFind1()
Parameters:K (Handle_StepBasic_ProductDefinition &) –
Return type:Standard_Address
Clear()
Return type:None
Find()
Parameters:K (Handle_StepBasic_ProductDefinition &) –
Return type:Handle_STEPCAFControl_ExternFile
Find1()
Parameters:K (Handle_StepBasic_ProductDefinition &) –
Return type:Standard_Address
IsBound()
Parameters:K (Handle_StepBasic_ProductDefinition &) –
Return type:bool
ReSize()
Parameters:NbBuckets (int) –
Return type:None
Set()
Parameters:Other (STEPCAFControl_DataMapOfPDExternFile &) –
Return type:STEPCAFControl_DataMapOfPDExternFile
UnBind()
Parameters:K (Handle_StepBasic_ProductDefinition &) –
Return type:bool
thisown

The membership flag

class STEPCAFControl_DataMapOfSDRExternFile(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:NbBuckets (int) – default value is 1
Return type:None
Assign()
Parameters:Other (STEPCAFControl_DataMapOfSDRExternFile &) –
Return type:STEPCAFControl_DataMapOfSDRExternFile
Bind()
Parameters:
  • K (Handle_StepShape_ShapeDefinitionRepresentation &) –
  • I (Handle_STEPCAFControl_ExternFile &) –
Return type:

bool

ChangeFind()
Parameters:K (Handle_StepShape_ShapeDefinitionRepresentation &) –
Return type:Handle_STEPCAFControl_ExternFile
ChangeFind1()
Parameters:K (Handle_StepShape_ShapeDefinitionRepresentation &) –
Return type:Standard_Address
Clear()
Return type:None
Find()
Parameters:K (Handle_StepShape_ShapeDefinitionRepresentation &) –
Return type:Handle_STEPCAFControl_ExternFile
Find1()
Parameters:K (Handle_StepShape_ShapeDefinitionRepresentation &) –
Return type:Standard_Address
IsBound()
Parameters:K (Handle_StepShape_ShapeDefinitionRepresentation &) –
Return type:bool
ReSize()
Parameters:NbBuckets (int) –
Return type:None
Set()
Parameters:Other (STEPCAFControl_DataMapOfSDRExternFile &) –
Return type:STEPCAFControl_DataMapOfSDRExternFile
UnBind()
Parameters:K (Handle_StepShape_ShapeDefinitionRepresentation &) –
Return type:bool
thisown

The membership flag

class STEPCAFControl_DataMapOfShapePD(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:NbBuckets (int) – default value is 1
Return type:None
Assign()
Parameters:Other (STEPCAFControl_DataMapOfShapePD &) –
Return type:STEPCAFControl_DataMapOfShapePD
Bind()
Parameters:
  • K (TopoDS_Shape &) –
  • I (Handle_StepBasic_ProductDefinition &) –
Return type:

bool

ChangeFind()
Parameters:K (TopoDS_Shape &) –
Return type:Handle_StepBasic_ProductDefinition
ChangeFind1()
Parameters:K (TopoDS_Shape &) –
Return type:Standard_Address
Clear()
Return type:None
Find()
Parameters:K (TopoDS_Shape &) –
Return type:Handle_StepBasic_ProductDefinition
Find1()
Parameters:K (TopoDS_Shape &) –
Return type:Standard_Address
IsBound()
Parameters:K (TopoDS_Shape &) –
Return type:bool
ReSize()
Parameters:NbBuckets (int) –
Return type:None
Set()
Parameters:Other (STEPCAFControl_DataMapOfShapePD &) –
Return type:STEPCAFControl_DataMapOfShapePD
UnBind()
Parameters:K (TopoDS_Shape &) –
Return type:bool
thisown

The membership flag

class STEPCAFControl_DataMapOfShapeSDR(*args)

Bases: OCC.TCollection.TCollection_BasicMap

Parameters:NbBuckets (int) – default value is 1
Return type:None
Assign()
Parameters:Other (STEPCAFControl_DataMapOfShapeSDR &) –
Return type:STEPCAFControl_DataMapOfShapeSDR
Bind()
Parameters:
  • K (TopoDS_Shape &) –
  • I (Handle_StepShape_ShapeDefinitionRepresentation &) –
Return type:

bool

ChangeFind()
Parameters:K (TopoDS_Shape &) –
Return type:Handle_StepShape_ShapeDefinitionRepresentation
ChangeFind1()
Parameters:K (TopoDS_Shape &) –
Return type:Standard_Address
Clear()
Return type:None
Find()
Parameters:K (TopoDS_Shape &) –
Return type:Handle_StepShape_ShapeDefinitionRepresentation
Find1()
Parameters:K (TopoDS_Shape &) –
Return type:Standard_Address
IsBound()
Parameters:K (TopoDS_Shape &) –
Return type:bool
ReSize()
Parameters:NbBuckets (int) –
Return type:None
Set()
Parameters:Other (STEPCAFControl_DataMapOfShapeSDR &) –
Return type:STEPCAFControl_DataMapOfShapeSDR
UnBind()
Parameters:K (TopoDS_Shape &) –
Return type:bool
thisown

The membership flag

class STEPCAFControl_DictionaryOfExternFile(*args)

Bases: OCC.MMgt.MMgt_TShared

Return type:None
Clean()
Return type:None
Clear()
Return type:None
Complete()
Parameters:acell (Handle_STEPCAFControl_DictionaryOfExternFile &) –
Return type:bool
Copy()
Return type:Handle_STEPCAFControl_DictionaryOfExternFile
GetHandle()
GetItem()
Parameters:
  • name (TCollection_AsciiString &) –
  • anitem (Handle_STEPCAFControl_ExternFile &) –
  • exact (bool) – default value is Standard_True
  • name
  • anitem
  • exact – default value is Standard_True
Return type:

bool

Return type:

bool

HasItem()
Parameters:
  • name (TCollection_AsciiString &) –
  • exact (bool) – default value is Standard_False
  • name
  • exact – default value is Standard_True
Return type:

bool

Return type:

bool

IsEmpty()
Return type:bool
Item()
Parameters:
  • name (TCollection_AsciiString &) –
  • exact (bool) – default value is Standard_True
  • name
  • exact – default value is Standard_True
Return type:

Handle_STEPCAFControl_ExternFile

Return type:

Handle_STEPCAFControl_ExternFile

NewItem()
Parameters:
  • name (TCollection_AsciiString &) –
  • isvalued (bool) –
  • exact (bool) – default value is Standard_True
  • name
  • isvalued
  • exact – default value is Standard_True
Return type:

Handle_STEPCAFControl_ExternFile

Return type:

Handle_STEPCAFControl_ExternFile

RemoveItem()
Parameters:
  • name (TCollection_AsciiString &) –
  • cln (bool) – default value is Standard_True
  • exact (bool) – default value is Standard_True
  • name
  • cln – default value is Standard_True
  • exact – default value is Standard_True
Return type:

bool

Return type:

bool

SetItem()
Parameters:
  • name (TCollection_AsciiString &) –
  • anitem (Handle_STEPCAFControl_ExternFile &) –
  • exact (bool) – default value is Standard_True
  • name
  • anitem
  • exact – default value is Standard_True
Return type:

None

Return type:

None

thisown

The membership flag

class STEPCAFControl_ExternFile(*args)

Bases: OCC.MMgt.MMgt_TShared

  • Creates an empty structure
Return type:None
GetHandle()
GetLabel()
Return type:TDF_Label
GetLoadStatus()
Return type:IFSelect_ReturnStatus
GetName()
Return type:Handle_TCollection_HAsciiString
GetTransferStatus()
Return type:bool
GetWS()
Return type:Handle_XSControl_WorkSession
GetWriteStatus()
Return type:IFSelect_ReturnStatus
SetLabel()
Parameters:L (TDF_Label &) –
Return type:None
SetLoadStatus()
Parameters:stat (IFSelect_ReturnStatus) –
Return type:None
SetName()
Parameters:name (Handle_TCollection_HAsciiString &) –
Return type:None
SetTransferStatus()
Parameters:isok (bool) –
Return type:None
SetWS()
Parameters:WS (Handle_XSControl_WorkSession &) –
Return type:None
SetWriteStatus()
Parameters:stat (IFSelect_ReturnStatus) –
Return type:None
thisown

The membership flag

class STEPCAFControl_IteratorOfDictionaryOfExternFile(*args)

Bases: object

Parameters:
  • acell (Handle_STEPCAFControl_DictionaryOfExternFile &) –
  • acell
  • basename (TCollection_AsciiString &) –
  • acell
  • basename
Return type:

None

Return type:

None

Return type:

None

More()
Return type:bool
Name()
Return type:TCollection_AsciiString
Next()
Return type:None
Start()
Return type:None
Value()
Return type:Handle_STEPCAFControl_ExternFile
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.
Return type:None
  • Creates a reader tool and attaches it to an already existing Session Clears the session if it was not yet set for STEP
Parameters:
  • WS (Handle_XSControl_WorkSession &) –
  • scratch (bool) – default value is Standard_True
Return type:

None

ChangeReader()
  • Returns basic reader
Return type:STEPControl_Reader
ExternFile()
  • Returns data on external file by its name Returns False if no external file with given name is read
Parameters:
  • name (char *) –
  • ef (Handle_STEPCAFControl_ExternFile &) –
Return type:

bool

ExternFiles()
  • Returns data on external files Returns Null handle if no external files are read
Return type:Handle_STEPCAFControl_DictionaryOfExternFile
static FindInstance(*args)
  • Returns label of instance of an assembly component corresponding to a given NAUO
Parameters:
  • NAUO (Handle_StepRepr_NextAssemblyUsageOccurrence &) –
  • STool (Handle_XCAFDoc_ShapeTool &) –
  • Tool (STEPConstruct_Tool &) –
  • PDRFileMap (STEPCAFControl_DataMapOfPDExternFile &) –
  • ShapeLabelMap (XCAFDoc_DataMapOfShapeLabel &) –
Return type:

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
Init()
  • Clears the internal data structures and attaches to a new session Clears the session if it was not yet set for STEP
Parameters:
  • WS (Handle_XSControl_WorkSession &) –
  • scratch (bool) – default value is Standard_True
Return type:

None

NbRootsForTransfer()
  • Returns number of roots recognized for transfer Shortcut for Reader().NbRootsForTransfer()
Return type:int
Perform()
Parameters:
  • filename (TCollection_AsciiString &) –
  • doc (Handle_TDocStd_Document &) –
Return type:

bool

  • Translate STEP file given by filename into the document Return True if succeeded, and False in case of fail
Parameters:
  • filename (char *) –
  • doc (Handle_TDocStd_Document &) –
Return type:

bool

ReadFile()
  • Loads a file and returns the read status Provided for use like single-file reader
Parameters:filename (char *) –
Return type:IFSelect_ReturnStatus
Reader()
  • Returns basic reader as const
Return type:STEPControl_Reader
SetColorMode()
  • Set ColorMode for indicate read Colors or not.
Parameters:colormode (bool) –
Return type:None
SetGDTMode()
  • Set GDT mode for indicate write GDT or not.
Parameters:gdtmode (bool) –
Return type:None
SetLayerMode()
  • Set LayerMode for indicate read Layers or not.
Parameters:layermode (bool) –
Return type:None
SetMatMode()
  • Set Material mode
Parameters:matmode (bool) –
Return type:None
SetNameMode()
  • Set NameMode for indicate read Name or not.
Parameters:namemode (bool) –
Return type:None
SetPropsMode()
  • PropsMode for indicate read Validation properties or not.
Parameters:propsmode (bool) –
Return type:None
SetSHUOMode()
  • Set SHUO mode for indicate write SHUO or not.
Parameters:shuomode (bool) –
Return type:None
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
Parameters:doc (Handle_TDocStd_Document &) –
Return type: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
Parameters:
  • num (int) –
  • doc (Handle_TDocStd_Document &) –
Return type:

bool

thisown

The membership flag

STEPCAFControl_Reader_FindInstance(*args)
  • Returns label of instance of an assembly component corresponding to a given NAUO
Parameters:
  • NAUO (Handle_StepRepr_NextAssemblyUsageOccurrence &) –
  • STool (Handle_XCAFDoc_ShapeTool &) –
  • Tool (STEPConstruct_Tool &) –
  • PDRFileMap (STEPCAFControl_DataMapOfPDExternFile &) –
  • ShapeLabelMap (XCAFDoc_DataMapOfShapeLabel &) –
Return type:

TDF_Label

class STEPCAFControl_StackItemOfDictionaryOfExternFile(*args)

Bases: OCC.MMgt.MMgt_TShared

Return type:None
Parameters:previous (Handle_STEPCAFControl_StackItemOfDictionaryOfExternFile &) –
Return type:None
GetHandle()
Previous()
Return type:Handle_STEPCAFControl_StackItemOfDictionaryOfExternFile
SetValue()
Parameters:cval (Handle_STEPCAFControl_DictionaryOfExternFile &) –
Return type:None
Value()
Return type:Handle_STEPCAFControl_DictionaryOfExternFile
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.
Return type: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
Parameters:
  • WS (Handle_XSControl_WorkSession &) –
  • scratch (bool) – default value is Standard_True
Return type:

None

ChangeWriter()
  • Returns basic reader for root file
Return type:STEPControl_Writer
ExternFile()
  • Returns data on external file by its original label Returns False if no external file with given name is read
Parameters:
  • L (TDF_Label &) –
  • ef (Handle_STEPCAFControl_ExternFile &) –
Return type:

bool

  • Returns data on external file by its name Returns False if no external file with given name is read
Parameters:
  • name (char *) –
  • ef (Handle_STEPCAFControl_ExternFile &) –
Return type:

bool

ExternFiles()
  • Returns data on external files Returns Null handle if no external files are read
Return type:Handle_STEPCAFControl_DictionaryOfExternFile
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
Parameters:
  • WS (Handle_XSControl_WorkSession &) –
  • scratch (bool) – default value is Standard_True
Return type:

None

Perform()
Parameters:
  • doc (Handle_TDocStd_Document &) –
  • filename (TCollection_AsciiString &) –
Return type:

bool

  • Transfers a document and writes it to a STEP file Returns True if translation is OK
Parameters:
  • doc (Handle_TDocStd_Document &) –
  • filename (char *) –
Return type:

bool

SetColorMode()
  • Set ColorMode for indicate write Colors or not.
Parameters:colormode (bool) –
Return type:None
SetDimTolMode()
  • Set dimtolmode for indicate write D&GTs or not.
Parameters:dimtolmode (bool) –
Return type:None
SetLayerMode()
  • Set LayerMode for indicate write Layers or not.
Parameters:layermode (bool) –
Return type:None
SetMaterialMode()
  • Set dimtolmode for indicate write D&GTs or not.
Parameters:matmode (bool) –
Return type:None
SetNameMode()
  • Set NameMode for indicate write Name or not.
Parameters:namemode (bool) –
Return type:None
SetPropsMode()
  • PropsMode for indicate write Validation properties or not.
Parameters:propsmode (bool) –
Return type:None
SetSHUOMode()
  • Set SHUO mode for indicate write SHUO or not.
Parameters:shuomode (bool) –
Return type:None
Transfer()
Parameters:
  • doc (Handle_TDocStd_Document &) –
  • mode (STEPControl_StepModelType) – default value is STEPControl_AsIs
  • multi (char *) – default value is 0
Return type:

bool

  • 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
Parameters:
  • L (TDF_Label &) –
  • mode (STEPControl_StepModelType) – default value is STEPControl_AsIs
  • multi (char *) – default value is 0
Return type:

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
Parameters:filename (char *) –
Return type:IFSelect_ReturnStatus
Writer()
  • Returns basic reader as const
Return type:STEPControl_Writer
thisown

The membership flag

class SwigPyIterator(*args, **kwargs)

Bases: object

advance()
copy()
decr()
distance()
equal()
incr()
next()
previous()
thisown

The membership flag

value()
register_handle(handle, base_object)

Inserts the handle into the base object to prevent memory corruption in certain cases