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
    XSControl_Writer Class Reference

    This class gives a simple way to create then write a Model compliant to a given norm, from a Shape The model can then be edited by tools by other appropriate tools. More...

    #include <XSControl_Writer.hxx>

    Public Member Functions

     XSControl_Writer ()
     Creates a Writer from scratch.
     XSControl_Writer (const char *const norm)
     Creates a Writer from scratch, with a norm name which identifie a Controller.
     XSControl_Writer (const occ::handle< XSControl_WorkSession > &WS, const bool scratch=true)
     Creates a Writer from an already existing Session If <scratch> is True (D), clears already recorded data.
    bool SetNorm (const char *const norm)
     Sets a specific norm to <me> Returns True if done, False if <norm> is not available.
    void SetWS (const occ::handle< XSControl_WorkSession > &WS, const bool scratch=true)
     Sets a specific session to <me>.
    occ::handle< XSControl_WorkSessionWS () const
     Returns the session used in <me>.
    occ::handle< Interface_InterfaceModelModel (const bool newone=false)
     Returns the produced model. Produces a new one if not yet done or if <newone> is True This method allows for instance to edit product or header data before writing.
    IFSelect_ReturnStatus TransferShape (const TopoDS_Shape &sh, const int modemode=0, const Message_ProgressRange &theProgress=Message_ProgressRange())
     Transfers a Shape according to the mode.
    IFSelect_ReturnStatus WriteFile (const char *const filename)
     Writes the produced model.
    void PrintStatsTransfer (const int what, const int modemode=0) const
     Prints Statistics about Transfer.

    Detailed Description

    This class gives a simple way to create then write a Model compliant to a given norm, from a Shape The model can then be edited by tools by other appropriate tools.

    Constructor & Destructor Documentation

    ◆ XSControl_Writer() [1/3]

    XSControl_Writer::XSControl_Writer ( )

    Creates a Writer from scratch.

    ◆ XSControl_Writer() [2/3]

    XSControl_Writer::XSControl_Writer ( const char *const norm)

    Creates a Writer from scratch, with a norm name which identifie a Controller.

    ◆ XSControl_Writer() [3/3]

    XSControl_Writer::XSControl_Writer ( const occ::handle< XSControl_WorkSession > & WS,
    const bool scratch = true )

    Creates a Writer from an already existing Session If <scratch> is True (D), clears already recorded data.

    Member Function Documentation

    ◆ Model()

    occ::handle< Interface_InterfaceModel > XSControl_Writer::Model ( const bool newone = false)

    Returns the produced model. Produces a new one if not yet done or if <newone> is True This method allows for instance to edit product or header data before writing.

    ◆ PrintStatsTransfer()

    void XSControl_Writer::PrintStatsTransfer ( const int what,
    const int mode = 0 ) const

    Prints Statistics about Transfer.

    ◆ SetNorm()

    bool XSControl_Writer::SetNorm ( const char *const norm)

    Sets a specific norm to <me> Returns True if done, False if <norm> is not available.

    ◆ SetWS()

    void XSControl_Writer::SetWS ( const occ::handle< XSControl_WorkSession > & WS,
    const bool scratch = true )

    Sets a specific session to <me>.

    ◆ TransferShape()

    IFSelect_ReturnStatus XSControl_Writer::TransferShape ( const TopoDS_Shape & sh,
    const int mode = 0,
    const Message_ProgressRange & theProgress = Message_ProgressRange() )

    Transfers a Shape according to the mode.

    ◆ WriteFile()

    IFSelect_ReturnStatus XSControl_Writer::WriteFile ( const char *const filename)

    Writes the produced model.

    ◆ WS()

    occ::handle< XSControl_WorkSession > XSControl_Writer::WS ( ) const

    Returns the session used in <me>.


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