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

    Defines additional commands for XSControl to : More...

    #include <XSControl_FuncShape.hxx>

    Static Public Member Functions

    static void Init ()
     Defines and loads all functions which work on shapes for XSControl (as ActFunc).
    static int MoreShapes (const occ::handle< XSControl_WorkSession > &session, occ::handle< NCollection_HSequence< TopoDS_Shape > > &list, const char *const namename)
     Analyses a name as designating Shapes from a Vars or from XSTEP transfer (last Transfer on Reading). <name> can be : "*" : all the root shapes produced by last Transfer (Read) i.e. considers roots of the TransientProcess a name : a name of a variable DRAW.
    static bool FileAndVar (const occ::handle< XSControl_WorkSession > &session, const char *const file, const char *const var, const char *const def, TCollection_AsciiString &resfile, TCollection_AsciiString &resvar)
     Analyses given file name and variable name, with a default name for variables. Returns resulting file name and variable name plus status "file to read"(True) or "already read"(False) In the latter case, empty resfile means no file available.

    Detailed Description

    Defines additional commands for XSControl to :

    • control of initialisation (xinit, xnorm, newmodel)
    • analyse of the result of a transfer (recorded in a TransientProcess for Read, FinderProcess for Write) : statistics, various lists (roots,complete,abnormal), what about one specific entity, producing a model with the abnormal result

    This appendix of XSControl is compiled separately to distinguish basic features from user callable forms

    Member Function Documentation

    ◆ FileAndVar()

    bool XSControl_FuncShape::FileAndVar ( const occ::handle< XSControl_WorkSession > & session,
    const char *const file,
    const char *const var,
    const char *const def,
    TCollection_AsciiString & resfile,
    TCollection_AsciiString & resvar )
    static

    Analyses given file name and variable name, with a default name for variables. Returns resulting file name and variable name plus status "file to read"(True) or "already read"(False) In the latter case, empty resfile means no file available.

    If <file> is null or empty or equates ".", considers Session and returned status is False Else, returns resfile = file and status is True If is neither null nor empty, resvar = var Else, the root part of <resfile> is considered, if defined Else, <def> is taken

    ◆ Init()

    void XSControl_FuncShape::Init ( )
    static

    Defines and loads all functions which work on shapes for XSControl (as ActFunc).

    ◆ MoreShapes()

    int XSControl_FuncShape::MoreShapes ( const occ::handle< XSControl_WorkSession > & session,
    occ::handle< NCollection_HSequence< TopoDS_Shape > > & list,
    const char *const name )
    static

    Analyses a name as designating Shapes from a Vars or from XSTEP transfer (last Transfer on Reading). <name> can be : "*" : all the root shapes produced by last Transfer (Read) i.e. considers roots of the TransientProcess a name : a name of a variable DRAW.

    Returns the count of designated Shapes. Their list is put in

    If

    null, it is firstly created. Then it is completed (Append without Clear) by the Shapes found Returns 0 if no Shape could be found


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