OCC.Core.STEPConstruct module¶
STEPConstruct module, see official documentation at https://www.opencascade.com/doc/occt-7.4.0/refman/html/package_stepconstruct.html
-
class
STEPConstruct_AP203Context(*args)¶ Bases:
object- Creates tool and fills constant fields
- rtype
None
-
Clear()¶ - Clears all fields describing entities specific to each part
- rtype
None
-
DefaultApproval()¶ - Returns default approval entity which is used when no other data are available
- rtype
opencascade::handle<StepBasic_Approval>
-
DefaultDateAndTime()¶ - Returns default date_and_time entity which is used when no other data are available
- rtype
opencascade::handle<StepBasic_DateAndTime>
-
DefaultPersonAndOrganization()¶ - Returns default person_and_organization entity which is used when no other data are available
- rtype
opencascade::handle<StepBasic_PersonAndOrganization>
-
DefaultSecurityClassificationLevel()¶ - Returns default security_classification_level entity which is used when no other data are available
- rtype
opencascade::handle<StepBasic_SecurityClassificationLevel>
-
GetApproval()¶ - Return type
opencascade::handle<StepAP203_CcDesignApproval>
-
GetApprovalDateTime()¶ - Return type
opencascade::handle<StepBasic_ApprovalDateTime>
-
GetApprover()¶ - Return type
opencascade::handle<StepBasic_ApprovalPersonOrganization>
-
GetClassificationDate()¶ - Return type
opencascade::handle<StepAP203_CcDesignDateAndTimeAssignment>
-
GetClassificationOfficer()¶ - Return type
opencascade::handle<StepAP203_CcDesignPersonAndOrganizationAssignment>
-
GetCreationDate()¶ - Return type
opencascade::handle<StepAP203_CcDesignDateAndTimeAssignment>
-
GetCreator()¶ - Return type
opencascade::handle<StepAP203_CcDesignPersonAndOrganizationAssignment>
-
GetDesignOwner()¶ - Return type
opencascade::handle<StepAP203_CcDesignPersonAndOrganizationAssignment>
-
GetDesignSupplier()¶ - Return type
opencascade::handle<StepAP203_CcDesignPersonAndOrganizationAssignment>
-
GetProductCategoryRelationship()¶ - Return entities (roots) instantiated for the part by method Init
- rtype
opencascade::handle<StepBasic_ProductCategoryRelationship>
-
GetSecurity()¶ - Return type
opencascade::handle<StepAP203_CcDesignSecurityClassification>
-
Init()¶ - Takes SDR (part) which brings all standard data around part (common for AP203 and AP214) and creates all the additional entities required for AP203
- param sdr
- type sdr
StepShape_ShapeDefinitionRepresentation
- rtype
None* Takes tool which describes standard data around part (common for AP203 and AP214) and creates all the additional entities required for AP203 //! The created entities can be obtained by calls to methods GetCreator(), GetDesignOwner(), GetDesignSupplier(), GetClassificationOfficer(), GetSecurity(), GetCreationDate(), GetClassificationDate(), GetApproval(), GetApprover(), GetApprovalDateTime(), GetProductCategoryRelationship()
- param SDRTool
- type SDRTool
STEPConstruct_Part
- rtype
None* Takes NAUO which describes assembly link to component and creates the security_classification entity associated to it as required by the AP203 //! Instantiated (or existing previously) entities concerned can be obtained by calls to methods GetClassificationOfficer(), GetSecurity(), GetClassificationDate(), GetApproval(), GetApprover(), GetApprovalDateTime() Takes tool which describes standard data around part (common for AP203 and AP214) and takes from model (or creates if missing) all the additional entities required by AP203
- param nauo
- type nauo
StepRepr_NextAssemblyUsageOccurrence
- rtype
None
-
InitApprovalRequisites()¶ - Initializes Approver and ApprovalDateTime entities according to Approval entity
- rtype
None
-
InitAssembly()¶ - Initializes all missing data which are required for assembly
- param nauo
- type nauo
StepRepr_NextAssemblyUsageOccurrence
- rtype
None
-
InitRoles()¶ - Initializes constant fields (shared entities)
- rtype
None
-
InitSecurityRequisites()¶ - Initializes ClassificationOfficer and ClassificationDate entities according to Security entity
- rtype
None
-
RoleApprover()¶ - Return predefined PersonAndOrganizationRole and DateTimeRole entities named ‘creator’, ‘design owner’, ‘design supplier’, ‘classification officer’, ‘creation date’, ‘classification date’, ‘approver’
- rtype
opencascade::handle<StepBasic_ApprovalRole>
-
RoleClassificationDate()¶ - Return type
opencascade::handle<StepBasic_DateTimeRole>
-
RoleClassificationOfficer()¶ - Return type
opencascade::handle<StepBasic_PersonAndOrganizationRole>
-
RoleCreationDate()¶ - Return type
opencascade::handle<StepBasic_DateTimeRole>
-
RoleCreator()¶ - Return type
opencascade::handle<StepBasic_PersonAndOrganizationRole>
-
RoleDesignOwner()¶ - Return type
opencascade::handle<StepBasic_PersonAndOrganizationRole>
-
RoleDesignSupplier()¶ - Return type
opencascade::handle<StepBasic_PersonAndOrganizationRole>
-
SetDefaultApproval()¶ - Sets default approval
- param app
- type app
StepBasic_Approval
- rtype
None
-
SetDefaultDateAndTime()¶ - Sets default date_and_time entity
- param dt
- type dt
StepBasic_DateAndTime
- rtype
None
-
SetDefaultPersonAndOrganization()¶ - Sets default person_and_organization entity
- param po
- type po
StepBasic_PersonAndOrganization
- rtype
None
-
SetDefaultSecurityClassificationLevel()¶ - Sets default security_classification_level
- param sc
- type sc
StepBasic_SecurityClassificationLevel
- rtype
None
-
property
thisown¶ The membership flag
-
class
STEPConstruct_Assembly(*args)¶ Bases:
object- Return type
-
static
CheckSRRReversesNAUO()¶ - Checks whether SRR’s definition of assembly and component contradicts with NAUO definition or not, according to model schema (AP214 or AP203)
- param theGraph
- type theGraph
Interface_Graph
- param CDSR
- type CDSR
StepShape_ContextDependentShapeRepresentation
- rtype
bool
-
GetNAUO()¶ - Returns NAUO object describing the assembly link
- rtype
opencascade::handle<StepRepr_NextAssemblyUsageOccurrence>
-
Init()¶ - Initialises with starting values Ax0origin axis (typically, standard XYZ) Loclocation to which place the item Makes a MappedItem Resulting Value is returned by ItemValue
- param aSR
- type aSR
StepShape_ShapeDefinitionRepresentation
- param SDR0
- type SDR0
StepShape_ShapeDefinitionRepresentation
- param Ax0
- type Ax0
StepGeom_Axis2Placement3d
- param Loc
- type Loc
StepGeom_Axis2Placement3d
- rtype
None
-
ItemLocation()¶ - Returns the location of the item, computed from starting aLoc
- rtype
opencascade::handle<StepGeom_Axis2Placement3d>
-
ItemValue()¶ - Returns the Value If no Make… has been called, returns the starting SR
- rtype
opencascade::handle<Standard_Transient>
-
MakeRelationship()¶ - Make a (ShapeRepresentationRelationship,…WithTransformation) Resulting Value is returned by ItemValue
- rtype
None
-
property
thisown¶ The membership flag
-
class
STEPConstruct_ContextTool(*args)¶ Bases:
object- Return type
None:param aStepModel: :type aStepModel: StepData_StepModel :rtype: None
-
AP203Context()¶ - Returns tool which maintains context specific for AP203
- rtype
STEPConstruct_AP203Context
-
AddAPD()¶ - Parameters
enforce – default value is Standard_False :type enforce: bool :rtype: None
-
GetACname()¶ - Return type
opencascade::handle<TCollection_HAsciiString>
-
GetACschemaName()¶ - Return type
opencascade::handle<TCollection_HAsciiString>
-
GetACstatus()¶ - Return type
opencascade::handle<TCollection_HAsciiString>
-
GetAPD()¶ - Return type
opencascade::handle<StepBasic_ApplicationProtocolDefinition>
-
GetDefaultAxis()¶ - Returns a default axis placement
- rtype
opencascade::handle<StepGeom_Axis2Placement3d>
-
GetProductName()¶ - Generates a product name basing on write.step.product.name parameter and current position in the assembly structure
- rtype
opencascade::handle<TCollection_HAsciiString>
-
GetRootsForAssemblyLink()¶ - Produces and returns a full list of root entities required for assembly link identified by assembly (including NAUO and CDSR)
- param assembly
- type assembly
STEPConstruct_Assembly
- rtype
opencascade::handle<TColStd_HSequenceOfTransient>
-
GetRootsForPart()¶ - Produces and returns a full list of root entities required for part identified by SDRTool (including SDR itself)
- param SDRTool
- type SDRTool
STEPConstruct_Part
- rtype
opencascade::handle<TColStd_HSequenceOfTransient>
-
Index()¶ - Returns current index of assembly component on current level
- rtype
int
-
IsAP203()¶ - Returns True if APD.schema_name is config_control_design
- rtype
bool
-
IsAP214()¶ - Returns True if APD.schema_name is automotive_design
- rtype
bool
-
IsAP242()¶ - Returns True if APD.schema_name is ap242_managed_model_based_3d_engineering
- rtype
bool
-
Level()¶ - Returns current assembly level
- rtype
int
-
SetACname()¶ - Parameters
name –
- type name
TCollection_HAsciiString
- rtype
None
-
SetACschemaName()¶ - Parameters
schemaName –
- type schemaName
TCollection_HAsciiString
- rtype
None
-
SetACstatus()¶ - Parameters
status –
- type status
TCollection_HAsciiString
- rtype
None
-
SetACyear()¶ - Parameters
year –
- type year
int
- rtype
None
-
SetIndex()¶ - Changes current index of assembly component on current level
- param ind
- type ind
int
- rtype
None
-
SetLevel()¶ - Changes current assembly level
- param lev
- type lev
int
- rtype
None
-
SetModel()¶ - Initialize ApplicationProtocolDefinition by the first entity of that type found in the model
- param aStepModel
- type aStepModel
StepData_StepModel
- rtype
None
-
property
thisown¶ The membership flag
-
class
STEPConstruct_DataMapOfAsciiStringTransient(*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
STEPConstruct_DataMapOfPointTransient(*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
STEPConstruct_ExternRefs(*args)¶ Bases:
OCC.Core.STEPConstruct.STEPConstruct_Tool- Creates an empty tool
- rtype
None* Creates a tool and initializes it
- param WS
- type WS
XSControl_WorkSession
- rtype
None
-
AddExternRef()¶ - Create a new external reference with specified attributes attached to a given SDR <format> can be Null string, in that case this information is not written. Else, it can be ‘STEP AP214’ or ‘STEP AP203’ Returns index of a new extern ref
- param filename
- type filename
char *
- param PD
- type PD
StepBasic_ProductDefinition
- param format
- type format
char *
- rtype
int
-
Clear()¶ - Clears internal fields (list of defined extern refs)
- rtype
None
-
FileName()¶ - Returns filename for numth extern reference Returns Null if FileName is not defined or bad
- param num
- type num
int
- rtype
char *
-
Format()¶ - Returns format identification string for the extern document Returns Null handle if format is not defined
- param num
- type num
int
- rtype
opencascade::handle<TCollection_HAsciiString>
-
GetAP214APD()¶ - Returns the ApplicationProtocolDefinition of the PDM schema NOTE: if not defined then create new APD with new Application Context
- rtype
opencascade::handle<StepBasic_ApplicationProtocolDefinition>
-
Init()¶ - Initializes tool; returns True if succeeded
- param WS
- type WS
XSControl_WorkSession
- rtype
bool
-
LoadExternRefs()¶ - Searches current STEP model for external references and loads them to the internal data structures NOTE: does not clear data structures before loading
- rtype
bool
-
NbExternRefs()¶ - Returns number of defined extern references
- rtype
int
-
ProdDef()¶ - Returns ProductDefinition to which numth extern reference is associated. Returns Null if cannot be detected or if extern reference is not associated to SDR in a proper way.
- param num
- type num
int
- rtype
opencascade::handle<StepBasic_ProductDefinition>
-
SetAP214APD()¶ - Set the ApplicationProtocolDefinition of the PDM schema
- param APD
- type APD
StepBasic_ApplicationProtocolDefinition
- rtype
None
-
WriteExternRefs()¶ - Adds all the currently defined external refs to the model Returns number of written extern refs
- param num
- type num
int
- rtype
int
- Check (create if it is null) all shared entities for the model
- rtype
None
-
property
thisown¶ The membership flag
-
class
STEPConstruct_Part(*args)¶ Bases:
object- Return type
-
AC()¶ - Return type
opencascade::handle<StepBasic_ApplicationContext>
-
ACapplication()¶ - Return type
opencascade::handle<TCollection_HAsciiString>
-
MakeSDR()¶ - Parameters
aShape –
- type aShape
StepShape_ShapeRepresentation
- param aName
- type aName
TCollection_HAsciiString
- param AC
- type AC
StepBasic_ApplicationContext
- rtype
None
-
PC()¶ - Return type
opencascade::handle<StepBasic_ProductContext>
-
PCdisciplineType()¶ - Return type
opencascade::handle<TCollection_HAsciiString>
-
PCname()¶ - Return type
opencascade::handle<TCollection_HAsciiString>
-
PD()¶ - Return type
opencascade::handle<StepBasic_ProductDefinition>
-
PDC()¶ - Return type
opencascade::handle<StepBasic_ProductDefinitionContext>
-
PDCname()¶ - Return type
opencascade::handle<TCollection_HAsciiString>
-
PDCstage()¶ - Return type
opencascade::handle<TCollection_HAsciiString>
-
PDF()¶ - Return type
opencascade::handle<StepBasic_ProductDefinitionFormation>
-
PDFdescription()¶ - Return type
opencascade::handle<TCollection_HAsciiString>
-
PDFid()¶ - Return type
opencascade::handle<TCollection_HAsciiString>
-
PDS()¶ - Return type
opencascade::handle<StepRepr_ProductDefinitionShape>
-
PDSdescription()¶ - Return type
opencascade::handle<TCollection_HAsciiString>
-
PDSname()¶ - Return type
opencascade::handle<TCollection_HAsciiString>
-
PDdescription()¶ - Return type
opencascade::handle<TCollection_HAsciiString>
-
PRPC()¶ - Return type
opencascade::handle<StepBasic_ProductRelatedProductCategory>
-
PRPCdescription()¶ - Return type
opencascade::handle<TCollection_HAsciiString>
-
PRPCname()¶ - Return type
opencascade::handle<TCollection_HAsciiString>
-
Pdescription()¶ - Return type
opencascade::handle<TCollection_HAsciiString>
-
Pid()¶ - Return type
opencascade::handle<TCollection_HAsciiString>
-
Pname()¶ - Return type
opencascade::handle<TCollection_HAsciiString>
-
Product()¶ - Return type
opencascade::handle<StepBasic_Product>
-
ReadSDR()¶ - Parameters
aShape –
- type aShape
StepShape_ShapeDefinitionRepresentation
- rtype
None
-
SDRValue()¶ - Returns SDR or Null if not done
- rtype
opencascade::handle<StepShape_ShapeDefinitionRepresentation>
-
SRValue()¶ - Returns SDR->UsedRepresentation() or Null if not done
- rtype
opencascade::handle<StepShape_ShapeRepresentation>
-
SetACapplication()¶ - Parameters
text –
- type text
TCollection_HAsciiString
- rtype
None
-
SetPCdisciplineType()¶ - Parameters
label –
- type label
TCollection_HAsciiString
- rtype
None
-
SetPCname()¶ - Parameters
name –
- type name
TCollection_HAsciiString
- rtype
None
-
SetPDCname()¶ - Parameters
label –
- type label
TCollection_HAsciiString
- rtype
None
-
SetPDCstage()¶ - Parameters
label –
- type label
TCollection_HAsciiString
- rtype
None
-
SetPDFdescription()¶ - Parameters
text –
- type text
TCollection_HAsciiString
- rtype
None
-
SetPDFid()¶ - Parameters
id –
- type id
TCollection_HAsciiString
- rtype
None
-
SetPDSdescription()¶ - Parameters
text –
- type text
TCollection_HAsciiString
- rtype
None
-
SetPDSname()¶ - Parameters
label –
- type label
TCollection_HAsciiString
- rtype
None
-
SetPDdescription()¶ - Parameters
text –
- type text
TCollection_HAsciiString
- rtype
None
-
SetPRPCdescription()¶ - Parameters
text –
- type text
TCollection_HAsciiString
- rtype
None
-
SetPRPCname()¶ - Parameters
label –
- type label
TCollection_HAsciiString
- rtype
None
-
SetPdescription()¶ - Parameters
text –
- type text
TCollection_HAsciiString
- rtype
None
-
SetPid()¶ - Parameters
id –
- type id
TCollection_HAsciiString
- rtype
None
-
SetPname()¶ - Parameters
label –
- type label
TCollection_HAsciiString
- rtype
None
-
property
thisown¶ The membership flag
-
class
STEPConstruct_PointHasher¶ Bases:
object-
static
HashCode()¶ - Computes a hash code for the point, in the range [1, theUpperBound] @param thePoint the point which hash code is to be computed @param theUpperBound the upper bound of the range a computing hash code must be within returns a computed hash code, in the range [1, theUpperBound]
- param thePoint
- type thePoint
gp_Pnt
- param theUpperBound
- type theUpperBound
int
- rtype
int
-
static
IsEqual()¶ - Returns True when the two keys are the same. Two same keys must have the same hashcode, the contrary is not necessary.
- param Point1
- type Point1
gp_Pnt
- param Point2
- type Point2
gp_Pnt
- rtype
bool
-
property
thisown¶ The membership flag
-
static
-
class
STEPConstruct_Styles(*args)¶ Bases:
OCC.Core.STEPConstruct.STEPConstruct_Tool- Creates an empty tool
- rtype
None* Creates a tool and initializes it
- param WS
- type WS
XSControl_WorkSession
- rtype
None
-
AddStyle()¶ - Adds a style to a sequence
- param style
- type style
StepVisual_StyledItem
- rtype
None* Create a style linking giving PSA to the item, and add it to the sequence of stored styles. If Override is not Null, then the resulting style will be of the subtype OverridingStyledItem.
- param item
- type item
StepRepr_RepresentationItem
- param PSA
- type PSA
StepVisual_PresentationStyleAssignment
- param Override
- type Override
StepVisual_StyledItem
- rtype
opencascade::handle<StepVisual_StyledItem>* Create a style linking giving PSA to the Shape, and add it to the sequence of stored styles. If Override is not Null, then the resulting style will be of the subtype OverridingStyledItem. The Sape is used to find corresponding STEP entity by call to STEPConstruct::FindEntity(), then previous method is called.
- param Shape
- type Shape
TopoDS_Shape
- param PSA
- type PSA
StepVisual_PresentationStyleAssignment
- param Override
- type Override
StepVisual_StyledItem
- rtype
opencascade::handle<StepVisual_StyledItem>
-
ClearStyles()¶ - Clears all defined styles and PSA sequence
- rtype
None
-
CreateMDGPR()¶ - Create MDGPR, fill it with all the styles previously defined, and add it to the model
- param Context
- type Context
StepRepr_RepresentationContext
- param MDGPR
- type MDGPR
StepVisual_MechanicalDesignGeometricPresentationRepresentation
- rtype
bool
-
CreateNAUOSRD()¶ - Create MDGPR, fill it with all the styles previously defined, and add it to the model IMPORTANT: <initPDS> must be null when use for NAUO colors <initPDS> initialised only for SHUO case.
- param Context
- type Context
StepRepr_RepresentationContext
- param CDSR
- type CDSR
StepShape_ContextDependentShapeRepresentation
- param initPDS
- type initPDS
StepRepr_ProductDefinitionShape
- rtype
bool
-
static
DecodeColor()¶ - Decodes STEP color and fills the Quantity_Color. Returns True if OK or False if color is not recognized
- param Colour
- type Colour
StepVisual_Colour
- param Col
- type Col
Quantity_Color
- rtype
bool
-
static
EncodeColor()¶ - Create STEP color entity by given Quantity_Color The analysis is performed for whether the color corresponds to one of standard colors predefined in STEP. In that case, PredefinedColour entity is created instead of RGBColour
- param Col
- type Col
Quantity_Color
- rtype
opencascade::handle<StepVisual_Colour>* Create STEP color entity by given Quantity_Color The analysis is performed for whether the color corresponds to one of standard colors predefined in STEP. In that case, PredefinedColour entity is created instead of RGBColour
- param Col
- type Col
Quantity_Color
- param DPDCs
- type DPDCs
STEPConstruct_DataMapOfAsciiStringTransient
- param ColRGBs
- type ColRGBs
STEPConstruct_DataMapOfPointTransient
- rtype
opencascade::handle<StepVisual_Colour>
-
FindContext()¶ - Searches the STEP model for the RepresentationContext in which given shape is defined. This context (if found) can be used then in call to CreateMDGPR()
- param Shape
- type Shape
TopoDS_Shape
- rtype
opencascade::handle<StepRepr_RepresentationContext>
-
GetColorPSA()¶ - Returns a PresentationStyleAssignment entity which defines surface and curve colors as Col. This PSA is either created or taken from internal map where all PSAs created by this method are remembered.
- param item
- type item
StepRepr_RepresentationItem
- param Col
- type Col
StepVisual_Colour
- rtype
opencascade::handle<StepVisual_PresentationStyleAssignment>
-
GetColors()¶ - Extract color definitions from the style entity For each type of color supported, result can be either NULL if it is not defined by that style, or last definition (if they are 1 or more)
- param style
- type style
StepVisual_StyledItem
- param SurfCol
- type SurfCol
StepVisual_Colour
- param BoundCol
- type BoundCol
StepVisual_Colour
- param CurveCol
- type CurveCol
StepVisual_Colour
- param IsComponent
- type IsComponent
bool
- rtype
bool
-
Init()¶ - Initializes tool; returns True if succeeded
- param WS
- type WS
XSControl_WorkSession
- rtype
bool
-
LoadInvisStyles()¶ - Searches the STEP model for the INISIBILITY enteties (which bring styles) and fills out sequence of styles
- param InvSyles
- type InvSyles
TColStd_HSequenceOfTransient
- rtype
bool
-
LoadStyles()¶ - Searches the STEP model for the MDGPR or DM entities (which bring styles) and fills sequence of styles
- rtype
bool
-
MakeColorPSA()¶ - Create a PresentationStyleAssignment entity which defines two colors (for filling surfaces and curves) if isForNAUO true then returns PresentationStyleByContext
- param item
- type item
StepRepr_RepresentationItem
- param SurfCol
- type SurfCol
StepVisual_Colour
- param CurveCol
- type CurveCol
StepVisual_Colour
- param isForNAUO
default value is Standard_False
- type isForNAUO
bool
- rtype
opencascade::handle<StepVisual_PresentationStyleAssignment>
-
NbStyles()¶ - Returns number of defined styles
- rtype
int
-
Style()¶ - Returns style with given index
- param i
- type i
int
- rtype
opencascade::handle<StepVisual_StyledItem>
-
property
thisown¶ The membership flag
-
class
STEPConstruct_Tool(*args)¶ Bases:
object- Creates an empty tool
- rtype
None* Creates a tool and loads it with worksession
- param WS
- type WS
XSControl_WorkSession
- rtype
None
-
FinderProcess()¶ - Returns FinderProcess (writing; Null if not loaded)
- rtype
opencascade::handle<Transfer_FinderProcess>
-
Graph()¶ - Returns current graph (recomputing if necessary)
- param recompute
default value is Standard_False
- type recompute
bool
- rtype
Interface_Graph
-
Model()¶ - Returns current model (Null if not loaded)
- rtype
opencascade::handle<Interface_InterfaceModel>
-
TransientProcess()¶ - Returns TransientProcess (reading; Null if not loaded)
- rtype
opencascade::handle<Transfer_TransientProcess>
-
WS()¶ - Returns currently loaded WorkSession
- rtype
opencascade::handle<XSControl_WorkSession>
-
property
thisown¶ The membership flag
-
class
STEPConstruct_UnitContext(*args)¶ Bases:
object- Creates empty tool
- rtype
None
-
AreaDone()¶ - Returns true if areaFactor is computed
- rtype
bool
-
AreaFactor()¶ - Returns the areaFactor
- rtype
float
-
ComputeFactors()¶ - Computes the length, plane angle and solid angle conversion factor . Returns a status, 0 if OK
- param aContext
- type aContext
StepRepr_GlobalUnitAssignedContext
- rtype
int:param aUnit:
- type aUnit
StepBasic_NamedUnit
- rtype
int
-
ComputeTolerance()¶ - Computes the uncertainty value (for length)
- param aContext
- type aContext
StepRepr_GlobalUncertaintyAssignedContext
- rtype
int
-
static
ConvertSiPrefix()¶ - Convert SI prefix defined by enumertaion to corresponding real factor (e.g. 1e6 for mega)
- param aPrefix
- type aPrefix
StepBasic_SiPrefix
- rtype
float
-
HasUncertainty()¶ - Tells if a Uncertainty (for length) is recorded
- rtype
bool
-
Init()¶ - Creates new context (units are MM and radians, uncertainty equal to Tol3d)
- param Tol3d
- type Tol3d
float
- rtype
None
-
IsDone()¶ - Returns True if Init was called successfully
- rtype
bool
-
LengthDone()¶ - Returns true if ComputeFactors has calculated a LengthFactor
- rtype
bool
-
LengthFactor()¶ - Returns the lengthFactor
- rtype
float
-
PlaneAngleDone()¶ - Returns true if ComputeFactors has calculated a PlaneAngleFactor
- rtype
bool
-
PlaneAngleFactor()¶ - Returns the planeAngleFactor
- rtype
float
-
SolidAngleDone()¶ - Returns true if ComputeFactors has calculated a SolidAngleFactor
- rtype
bool
-
SolidAngleFactor()¶ - Returns the solidAngleFactor
- rtype
float
-
StatusMessage()¶ - Returns a message for a given status (0 - empty) This message can then be added as warning for transfer
- param status
- type status
int
- rtype
char *
-
Uncertainty()¶ - Returns the Uncertainty value (for length) It has been converted with LengthFactor
- rtype
float
-
Value()¶ - Returns context (or Null if not done)
- rtype
opencascade::handle<StepGeom_GeomRepContextAndGlobUnitAssCtxAndGlobUncertaintyAssCtx>
-
VolumeDone()¶ - Returns true if volumeFactor is computed
- rtype
bool
-
VolumeFactor()¶ - Returns the volumeFactor
- rtype
float
-
property
thisown¶ The membership flag
-
class
STEPConstruct_ValidationProps(*args)¶ Bases:
OCC.Core.STEPConstruct.STEPConstruct_Tool- Creates an empty tool
- rtype
None* Creates a tool and loads it with worksession
- param WS
- type WS
XSControl_WorkSession
- rtype
None
-
AddArea()¶ - Adds surface area property for given shape (already mapped). Returns True if success, False in case of fail
- param Shape
- type Shape
TopoDS_Shape
- param Area
- type Area
float
- rtype
bool
-
AddCentroid()¶ - Adds centroid property for given shape (already mapped). Returns True if success, False in case of fail If instance is True, then centroid is assigned to an instance of component in assembly
- param Shape
- type Shape
TopoDS_Shape
- param Pnt
- type Pnt
gp_Pnt
- param instance
default value is Standard_False
- type instance
bool
- rtype
bool
-
AddProp()¶ - General method for adding (writing) a validation property for shape which should be already mapped on writing itself. It uses FindTarget() to find target STEP entity resulting from given shape, and associated context Returns True if success, False in case of fail
- param Shape
- type Shape
TopoDS_Shape
- param Prop
- type Prop
StepRepr_RepresentationItem
- param Descr
- type Descr
char *
- param instance
default value is Standard_False
- type instance
bool
- rtype
bool* General method for adding (writing) a validation property for shape which should be already mapped on writing itself. It takes target and Context entities which correspond to shape Returns True if success, False in case of fail
- param target
- type target
StepRepr_CharacterizedDefinition
- param Context
- type Context
StepRepr_RepresentationContext
- param Prop
- type Prop
StepRepr_RepresentationItem
- param Descr
- type Descr
char *
- rtype
bool
-
AddVolume()¶ - Adds volume property for given shape (already mapped). Returns True if success, False in case of fail
- param Shape
- type Shape
TopoDS_Shape
- param Vol
- type Vol
float
- rtype
bool
-
FindTarget()¶ - Finds target STEP entity to which validation props should be assigned, and corresponding context, starting from shape Returns True if success, False in case of fail
- param S
- type S
TopoDS_Shape
- param target
- type target
StepRepr_CharacterizedDefinition
- param Context
- type Context
StepRepr_RepresentationContext
- param instance
default value is Standard_False
- type instance
bool
- rtype
bool
-
GetPropNAUO()¶ - Returns CDSR associated with given PpD or NULL if not found (when, try GetPropSDR)
- param PD
- type PD
StepRepr_PropertyDefinition
- rtype
opencascade::handle<StepRepr_NextAssemblyUsageOccurrence>
-
GetPropPD()¶ - Returns SDR associated with given PpD or NULL if not found (when, try GetPropCDSR)
- param PD
- type PD
StepRepr_PropertyDefinition
- rtype
opencascade::handle<StepBasic_ProductDefinition>
-
GetPropPnt()¶ - Returns value of Centriod property (or False if it is not)
- param item
- type item
StepRepr_RepresentationItem
- param Context
- type Context
StepRepr_RepresentationContext
- param Pnt
- type Pnt
gp_Pnt
- rtype
bool
-
GetPropReal()¶ - Returns value of Real-Valued property (Area or Volume) If Property is neither Area nor Volume, returns False Else returns True and isArea indicates whether property is area or volume
- param item
- type item
StepRepr_RepresentationItem
- param Val
- type Val
float
- param isArea
- type isArea
bool
- rtype
bool
-
GetPropShape()¶ - Returns Shape associated with given SDR or Null Shape if not found
- param ProdDef
- type ProdDef
StepBasic_ProductDefinition
- rtype
TopoDS_Shape* Returns Shape associated with given PpD or Null Shape if not found
- param PD
- type PD
StepRepr_PropertyDefinition
- rtype
TopoDS_Shape
-
Init()¶ - Load worksession; returns True if succeeded
- param WS
- type WS
XSControl_WorkSession
- rtype
bool
-
LoadProps()¶ - Searches for entities of the type PropertyDefinitionRepresentation in the model and fills the sequence by them
- param seq
- type seq
TColStd_SequenceOfTransient
- rtype
bool
-
SetAssemblyShape()¶ - Sets current assembly shape SDR (for FindCDSR calls)
- param shape
- type shape
TopoDS_Shape
- rtype
None
-
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()¶
-
-
class
stepconstruct¶ Bases:
object-
static
FindCDSR()¶ - Find CDSR correcponding to the component in the specified assembly
- param ComponentBinder
- type ComponentBinder
Transfer_Binder
- param AssemblySDR
- type AssemblySDR
StepShape_ShapeDefinitionRepresentation
- param ComponentCDSR
- type ComponentCDSR
StepShape_ContextDependentShapeRepresentation
- rtype
bool
-
static
FindEntity()¶ - Returns STEP entity of the (sub)type of RepresentationItem which is a result of the tranalation of the Shape, or Null if no result is recorded
- param FinderProcess
- type FinderProcess
Transfer_FinderProcess
- param Shape
- type Shape
TopoDS_Shape
- rtype
opencascade::handle<StepRepr_RepresentationItem>* The same as above, but in the case if item not found, repeats search on the same shape without location. The Loc corresponds to the location with which result is found (either location of the Shape, or Null)
- param FinderProcess
- type FinderProcess
Transfer_FinderProcess
- param Shape
- type Shape
TopoDS_Shape
- param Loc
- type Loc
TopLoc_Location
- rtype
opencascade::handle<StepRepr_RepresentationItem>
-
static
FindShape()¶ - Returns Shape resulting from given STEP entity (Null if not mapped)
- param TransientProcess
- type TransientProcess
Transfer_TransientProcess
- param item
- type item
StepRepr_RepresentationItem
- rtype
TopoDS_Shape
-
property
thisown¶ The membership flag
-
static