OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    STEPConstruct_ContextTool Class Reference

    Maintains global context tool for writing. Gives access to Product Definition Context (one per Model) Maintains ApplicationProtocolDefinition entity (common for all products) Also maintains context specific for AP203 and provides set of methods to work with various STEP constructs as required by Actor. More...

    #include <STEPConstruct_ContextTool.hxx>

    Public Member Functions

     STEPConstruct_ContextTool ()
     STEPConstruct_ContextTool (const occ::handle< StepData_StepModel > &aStepModel)
    void SetModel (const occ::handle< StepData_StepModel > &aStepModel)
     Initialize ApplicationProtocolDefinition by the first entity of that type found in the model.
    void SetGlobalFactor (const StepData_Factors &theGlobalFactor)
    occ::handle< StepBasic_ApplicationProtocolDefinitionGetAPD ()
    void AddAPD (const bool enforce=false)
    bool IsAP203 () const
     Returns True if APD.schema_name is config_control_design.
    bool IsAP214 () const
     Returns True if APD.schema_name is automotive_design.
    bool IsAP242 () const
     Returns True if APD.schema_name is ap242_managed_model_based_3d_engineering.
    occ::handle< TCollection_HAsciiStringGetACstatus ()
    occ::handle< TCollection_HAsciiStringGetACschemaName ()
    int GetACyear ()
    occ::handle< TCollection_HAsciiStringGetACname ()
    void SetACstatus (const occ::handle< TCollection_HAsciiString > &status)
    void SetACschemaName (const occ::handle< TCollection_HAsciiString > &schemaName)
    void SetACyear (const int year)
    void SetACname (const occ::handle< TCollection_HAsciiString > &namename)
    occ::handle< StepGeom_Axis2Placement3dGetDefaultAxis ()
     Returns a default axis placement.
    STEPConstruct_AP203ContextAP203Context ()
     Returns tool which maintains context specific for AP203.
    int Level () const
     Returns current assembly level.
    void NextLevel ()
    void PrevLevel ()
    void SetLevel (const int lev)
     Changes current assembly level.
    int Index () const
     Returns current index of assembly component on current level.
    void NextIndex ()
    void PrevIndex ()
    void SetIndex (const int ind)
     Changes current index of assembly component on current level.
    occ::handle< TCollection_HAsciiStringGetProductName () const
     Generates a product name basing on write.step.product.name parameter and current position in the assembly structure.
    occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > GetRootsForPart (const STEPConstruct_Part &SDRTool)
     Produces and returns a full list of root entities required for part identified by SDRTool (including SDR itself).
    occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > GetRootsForAssemblyLink (const STEPConstruct_Assembly &assembly)
     Produces and returns a full list of root entities required for assembly link identified by assembly (including NAUO and CDSR).

    Detailed Description

    Maintains global context tool for writing. Gives access to Product Definition Context (one per Model) Maintains ApplicationProtocolDefinition entity (common for all products) Also maintains context specific for AP203 and provides set of methods to work with various STEP constructs as required by Actor.

    Constructor & Destructor Documentation

    ◆ STEPConstruct_ContextTool() [1/2]

    STEPConstruct_ContextTool::STEPConstruct_ContextTool ( )

    ◆ STEPConstruct_ContextTool() [2/2]

    STEPConstruct_ContextTool::STEPConstruct_ContextTool ( const occ::handle< StepData_StepModel > & aStepModel)

    Member Function Documentation

    ◆ AddAPD()

    void STEPConstruct_ContextTool::AddAPD ( const bool enforce = false)

    ◆ AP203Context()

    STEPConstruct_AP203Context & STEPConstruct_ContextTool::AP203Context ( )

    Returns tool which maintains context specific for AP203.

    ◆ GetACname()

    occ::handle< TCollection_HAsciiString > STEPConstruct_ContextTool::GetACname ( )

    ◆ GetACschemaName()

    occ::handle< TCollection_HAsciiString > STEPConstruct_ContextTool::GetACschemaName ( )

    ◆ GetACstatus()

    occ::handle< TCollection_HAsciiString > STEPConstruct_ContextTool::GetACstatus ( )

    ◆ GetACyear()

    int STEPConstruct_ContextTool::GetACyear ( )

    ◆ GetAPD()

    occ::handle< StepBasic_ApplicationProtocolDefinition > STEPConstruct_ContextTool::GetAPD ( )

    ◆ GetDefaultAxis()

    occ::handle< StepGeom_Axis2Placement3d > STEPConstruct_ContextTool::GetDefaultAxis ( )

    Returns a default axis placement.

    ◆ GetProductName()

    occ::handle< TCollection_HAsciiString > STEPConstruct_ContextTool::GetProductName ( ) const

    Generates a product name basing on write.step.product.name parameter and current position in the assembly structure.

    ◆ GetRootsForAssemblyLink()

    occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > STEPConstruct_ContextTool::GetRootsForAssemblyLink ( const STEPConstruct_Assembly & assembly)

    Produces and returns a full list of root entities required for assembly link identified by assembly (including NAUO and CDSR).

    ◆ GetRootsForPart()

    occ::handle< NCollection_HSequence< occ::handle< Standard_Transient > > > STEPConstruct_ContextTool::GetRootsForPart ( const STEPConstruct_Part & SDRTool)

    Produces and returns a full list of root entities required for part identified by SDRTool (including SDR itself).

    ◆ Index()

    int STEPConstruct_ContextTool::Index ( ) const

    Returns current index of assembly component on current level.

    ◆ IsAP203()

    bool STEPConstruct_ContextTool::IsAP203 ( ) const

    Returns True if APD.schema_name is config_control_design.

    ◆ IsAP214()

    bool STEPConstruct_ContextTool::IsAP214 ( ) const

    Returns True if APD.schema_name is automotive_design.

    ◆ IsAP242()

    bool STEPConstruct_ContextTool::IsAP242 ( ) const

    Returns True if APD.schema_name is ap242_managed_model_based_3d_engineering.

    ◆ Level()

    int STEPConstruct_ContextTool::Level ( ) const

    Returns current assembly level.

    ◆ NextIndex()

    void STEPConstruct_ContextTool::NextIndex ( )

    ◆ NextLevel()

    void STEPConstruct_ContextTool::NextLevel ( )

    ◆ PrevIndex()

    void STEPConstruct_ContextTool::PrevIndex ( )

    ◆ PrevLevel()

    void STEPConstruct_ContextTool::PrevLevel ( )

    ◆ SetACname()

    void STEPConstruct_ContextTool::SetACname ( const occ::handle< TCollection_HAsciiString > & name)

    ◆ SetACschemaName()

    void STEPConstruct_ContextTool::SetACschemaName ( const occ::handle< TCollection_HAsciiString > & schemaName)

    ◆ SetACstatus()

    void STEPConstruct_ContextTool::SetACstatus ( const occ::handle< TCollection_HAsciiString > & status)

    ◆ SetACyear()

    void STEPConstruct_ContextTool::SetACyear ( const int year)

    ◆ SetGlobalFactor()

    void STEPConstruct_ContextTool::SetGlobalFactor ( const StepData_Factors & theGlobalFactor)

    ◆ SetIndex()

    void STEPConstruct_ContextTool::SetIndex ( const int ind)

    Changes current index of assembly component on current level.

    ◆ SetLevel()

    void STEPConstruct_ContextTool::SetLevel ( const int lev)

    Changes current assembly level.

    ◆ SetModel()

    void STEPConstruct_ContextTool::SetModel ( const occ::handle< StepData_StepModel > & aStepModel)

    Initialize ApplicationProtocolDefinition by the first entity of that type found in the model.


    The documentation for this class was generated from the following file: