OCC.STEPCAFControl module¶
-Purpose : This package provides external access and control for STEP,on the level of CAF (shapes with attributes, externalreferences etc.)
-
class
Handle_STEPCAFControl_ActorWrite
(*args)¶ Bases:
OCC.STEPControl.Handle_STEPControl_ActorWrite
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_STEPCAFControl_Controller
(*args)¶ Bases:
OCC.STEPControl.Handle_STEPControl_Controller
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_STEPCAFControl_DataMapNodeOfDataMapOfLabelExternFile
(*args)¶ Bases:
OCC.TCollection.Handle_TCollection_MapNode
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_STEPCAFControl_DataMapNodeOfDataMapOfLabelShape
(*args)¶ Bases:
OCC.TCollection.Handle_TCollection_MapNode
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_STEPCAFControl_DataMapNodeOfDataMapOfPDExternFile
(*args)¶ Bases:
OCC.TCollection.Handle_TCollection_MapNode
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_STEPCAFControl_DataMapNodeOfDataMapOfSDRExternFile
(*args)¶ Bases:
OCC.TCollection.Handle_TCollection_MapNode
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_STEPCAFControl_DataMapNodeOfDataMapOfShapePD
(*args)¶ Bases:
OCC.TCollection.Handle_TCollection_MapNode
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_STEPCAFControl_DataMapNodeOfDataMapOfShapeSDR
(*args)¶ Bases:
OCC.TCollection.Handle_TCollection_MapNode
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_STEPCAFControl_DictionaryOfExternFile
(*args)¶ Bases:
OCC.MMgt.Handle_MMgt_TShared
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_STEPCAFControl_ExternFile
(*args)¶ Bases:
OCC.MMgt.Handle_MMgt_TShared
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
Handle_STEPCAFControl_StackItemOfDictionaryOfExternFile
(*args)¶ Bases:
OCC.MMgt.Handle_MMgt_TShared
-
static
DownCast
()¶
-
GetObject
()¶
-
IsNull
()¶
-
Nullify
()¶
-
thisown
¶ The membership flag
-
static
-
class
STEPCAFControl_ActorWrite
(*args)¶ Bases:
OCC.STEPControl.STEPControl_ActorWrite
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
()¶ - 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
()¶ - 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 -
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 -
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 -
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 -
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 -
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 -
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: -
GetHandle
()¶
-
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: -
GetHandle
()¶
-
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: -
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: -
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: -
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: -
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
-
ChangeFind
()¶ Parameters: K (TDF_Label &) – Return type: Handle_STEPCAFControl_ExternFile
-
ChangeFind1
()¶ Parameters: K (TDF_Label &) – Return type: Standard_Address
-
Find
()¶ Parameters: K (TDF_Label &) – Return type: Handle_STEPCAFControl_ExternFile
-
Find1
()¶ Parameters: K (TDF_Label &) – Return type: Standard_Address
-
Set
()¶ Parameters: Other (STEPCAFControl_DataMapOfLabelExternFile &) – Return type: STEPCAFControl_DataMapOfLabelExternFile
-
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
-
ChangeFind
()¶ Parameters: K (TDF_Label &) – Return type: TopoDS_Shape
-
ChangeFind1
()¶ Parameters: K (TDF_Label &) – Return type: Standard_Address
-
Find
()¶ Parameters: K (TDF_Label &) – Return type: TopoDS_Shape
-
Find1
()¶ Parameters: K (TDF_Label &) – Return type: Standard_Address
-
Set
()¶ Parameters: Other (STEPCAFControl_DataMapOfLabelShape &) – Return type: STEPCAFControl_DataMapOfLabelShape
-
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:
-
ChangeFind
()¶ Parameters: K (Handle_StepBasic_ProductDefinition &) – Return type: Handle_STEPCAFControl_ExternFile
-
ChangeFind1
()¶ Parameters: K (Handle_StepBasic_ProductDefinition &) – Return type: Standard_Address
-
Find
()¶ Parameters: K (Handle_StepBasic_ProductDefinition &) – Return type: Handle_STEPCAFControl_ExternFile
-
Find1
()¶ Parameters: K (Handle_StepBasic_ProductDefinition &) – Return type: Standard_Address
-
Set
()¶ Parameters: Other (STEPCAFControl_DataMapOfPDExternFile &) – Return type: STEPCAFControl_DataMapOfPDExternFile
-
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:
-
ChangeFind
()¶ Parameters: K (Handle_StepShape_ShapeDefinitionRepresentation &) – Return type: Handle_STEPCAFControl_ExternFile
-
ChangeFind1
()¶ Parameters: K (Handle_StepShape_ShapeDefinitionRepresentation &) – Return type: Standard_Address
-
Find
()¶ Parameters: K (Handle_StepShape_ShapeDefinitionRepresentation &) – Return type: Handle_STEPCAFControl_ExternFile
-
Find1
()¶ Parameters: K (Handle_StepShape_ShapeDefinitionRepresentation &) – Return type: Standard_Address
-
Set
()¶ Parameters: Other (STEPCAFControl_DataMapOfSDRExternFile &) – Return type: STEPCAFControl_DataMapOfSDRExternFile
-
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:
-
ChangeFind
()¶ Parameters: K (TopoDS_Shape &) – Return type: Handle_StepBasic_ProductDefinition
-
ChangeFind1
()¶ Parameters: K (TopoDS_Shape &) – Return type: Standard_Address
-
Find
()¶ Parameters: K (TopoDS_Shape &) – Return type: Handle_StepBasic_ProductDefinition
-
Find1
()¶ Parameters: K (TopoDS_Shape &) – Return type: Standard_Address
-
Set
()¶ Parameters: Other (STEPCAFControl_DataMapOfShapePD &) – Return type: STEPCAFControl_DataMapOfShapePD
-
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:
-
ChangeFind
()¶ Parameters: K (TopoDS_Shape &) – Return type: Handle_StepShape_ShapeDefinitionRepresentation
-
ChangeFind1
()¶ Parameters: K (TopoDS_Shape &) – Return type: Standard_Address
-
Find
()¶ Parameters: K (TopoDS_Shape &) – Return type: Handle_StepShape_ShapeDefinitionRepresentation
-
Find1
()¶ Parameters: K (TopoDS_Shape &) – Return type: Standard_Address
-
Set
()¶ Parameters: Other (STEPCAFControl_DataMapOfShapeSDR &) – Return type: STEPCAFControl_DataMapOfShapeSDR
-
thisown
¶ The membership flag
-
-
class
STEPCAFControl_DictionaryOfExternFile
(*args)¶ Bases:
OCC.MMgt.MMgt_TShared
Return type: None -
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: Return type:
-
HasItem
()¶ Parameters: - name (TCollection_AsciiString &) –
- exact (bool) – default value is Standard_False
- name –
- exact – default value is Standard_True
Return type: Return type:
-
Item
()¶ Parameters: - name (TCollection_AsciiString &) –
- exact (bool) – default value is Standard_True
- name –
- exact – default value is Standard_True
Return type: Return type:
-
NewItem
()¶ Parameters: Return type: Return type:
-
RemoveItem
()¶ Parameters: Return type: Return type:
-
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: Return type:
-
thisown
¶ The membership flag
-
-
class
STEPCAFControl_ExternFile
(*args)¶ Bases:
OCC.MMgt.MMgt_TShared
- Creates an empty structure
Return type: None -
GetHandle
()¶
-
GetLoadStatus
()¶ Return type: IFSelect_ReturnStatus
-
GetName
()¶ Return type: Handle_TCollection_HAsciiString
-
GetWS
()¶ Return type: Handle_XSControl_WorkSession
-
GetWriteStatus
()¶ Return type: IFSelect_ReturnStatus
-
thisown
¶ The membership flag
-
class
STEPCAFControl_IteratorOfDictionaryOfExternFile
(*args)¶ Bases:
object
Parameters: - acell (Handle_STEPCAFControl_DictionaryOfExternFile &) –
- acell –
- basename (TCollection_AsciiString &) –
- acell –
- basename –
Return type: Return type: Return type: -
Name
()¶ Return type: TCollection_AsciiString
-
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: -
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:
-
ExternFiles
()¶ - Returns data on external files Returns Null handle if no external files are read
Return type: Handle_STEPCAFControl_DictionaryOfExternFile
-
static
FindInstance
()¶ - 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:
-
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:
-
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: - 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:
-
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
-
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:
-
thisown
¶ The membership flag
-
STEPCAFControl_Reader_FindInstance
()¶ - 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:
-
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
-
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: -
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: - 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:
-
ExternFiles
()¶ - Returns data on external files Returns Null handle if no external files are read
Return type: Handle_STEPCAFControl_DictionaryOfExternFile
-
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:
-
Perform
()¶ Parameters: - doc (Handle_TDocStd_Document &) –
- filename (TCollection_AsciiString &) –
Return type: - 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:
-
SetColorMode
()¶ - Set ColorMode for indicate write Colors or not.
Parameters: colormode (bool) – Return type: None
-
SetDimTolMode
()¶ - Set dimtolmode for indicate write D>s 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>s 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: - 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:
-
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
()¶
-
-
new_instancemethod
(func, inst, cls)¶
-
register_handle
(handle, base_object)¶ Inserts the handle into the base object to prevent memory corruption in certain cases