OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    TObj_Assistant Class Reference

    This class provides interface to the static data to be used during save or load models. More...

    #include <TObj_Assistant.hxx>

    Static Public Member Functions

    static occ::handle< TObj_Model > FindModel (const char *const theName)
     Finds model by name.
    static void BindModel (const occ::handle< TObj_Model > &theModel)
     Binds model to the map.
    static void ClearModelMap ()
     Clears all records from the model map.
    static occ::handle< Standard_Type > FindType (const int theTypeIndex)
     Finds Standard_Type by index; returns NULL handle if not found.
    static int FindTypeIndex (const occ::handle< Standard_Type > &theType)
     Rinds index by Standard_Type; returns 0 if not found.
    static int BindType (const occ::handle< Standard_Type > &theType)
     Binds Standard_Type to the map; returns index of bound type.
    static void ClearTypeMap ()
     Clears map of types.
    static void SetCurrentModel (const occ::handle< TObj_Model > &theModel)
     Sets current model.
    static occ::handle< TObj_Model > GetCurrentModel ()
     Returns current model.
    static void UnSetCurrentModel ()
     Unsets current model.
    static int GetAppVersion ()
     Returns the version of application which wrote the currently read document. Returns 0 if it has not been set yet for the current document.

    Detailed Description

    This class provides interface to the static data to be used during save or load models.

    Static data:

    1. DataMap of Modeller name - handle to model to be used in loading of references
    2. Indexed map of Standard_Type to be used during save or load of object type
    3. Handle to the current model - model that is loaded at the current moment

    Member Function Documentation

    ◆ BindModel()

    void TObj_Assistant::BindModel ( const occ::handle< TObj_Model > & theModel)
    static

    Binds model to the map.

    ◆ BindType()

    int TObj_Assistant::BindType ( const occ::handle< Standard_Type > & theType)
    static

    Binds Standard_Type to the map; returns index of bound type.

    ◆ ClearModelMap()

    void TObj_Assistant::ClearModelMap ( )
    static

    Clears all records from the model map.

    ◆ ClearTypeMap()

    void TObj_Assistant::ClearTypeMap ( )
    static

    Clears map of types.

    ◆ FindModel()

    occ::handle< TObj_Model > TObj_Assistant::FindModel ( const char *const theName)
    static

    Finds model by name.

    Interface for DataMap of Modeller name

    ◆ FindType()

    occ::handle< Standard_Type > TObj_Assistant::FindType ( const int theTypeIndex)
    static

    Finds Standard_Type by index; returns NULL handle if not found.

    Interface for Map of Standard Types

    ◆ FindTypeIndex()

    int TObj_Assistant::FindTypeIndex ( const occ::handle< Standard_Type > & theType)
    static

    Rinds index by Standard_Type; returns 0 if not found.

    ◆ GetAppVersion()

    int TObj_Assistant::GetAppVersion ( )
    static

    Returns the version of application which wrote the currently read document. Returns 0 if it has not been set yet for the current document.

    ◆ GetCurrentModel()

    occ::handle< TObj_Model > TObj_Assistant::GetCurrentModel ( )
    static

    Returns current model.

    ◆ SetCurrentModel()

    void TObj_Assistant::SetCurrentModel ( const occ::handle< TObj_Model > & theModel)
    static

    Sets current model.

    Interface to the current model

    ◆ UnSetCurrentModel()

    void TObj_Assistant::UnSetCurrentModel ( )
    static

    Unsets current model.


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