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

    A container for instances of drivers. You create a new instance of TFunction_Driver and use the method AddDriver to load it into the driver table. More...

    #include <TFunction_DriverTable.hxx>

    Inheritance diagram for TFunction_DriverTable:

    Public Member Functions

     TFunction_DriverTable ()
     Default constructor.
    bool AddDriver (const Standard_GUID &guid, const occ::handle< TFunction_Driver > &driver, const int thread=0)
     Returns true if the driver has been added successfully to the driver table.
    bool HasDriver (const Standard_GUID &guid, const int thread=0) const
     Returns true if the driver exists in the driver table.
    bool FindDriver (const Standard_GUID &guid, occ::handle< TFunction_Driver > &driver, const int thread=0) const
     Returns true if the driver was found.
    Standard_OStreamDump (Standard_OStream &anOS) const
    Standard_OStreamoperator<< (Standard_OStream &anOS) const
    bool RemoveDriver (const Standard_GUID &guid, const int thread=0)
     Removes a driver with the given GUID. Returns true if the driver has been removed successfully.
    void Clear ()
     Removes all drivers. Returns true if the driver has been removed successfully.
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transientoperator= (const Standard_Transient &)
     Assignment operator, needed to avoid copying reference counter.
    virtual ~Standard_Transient ()=default
     Destructor must be virtual.
    virtual const opencascade::handle< Standard_Type > & DynamicType () const
     Returns a type descriptor about this object.
    bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
     Returns a true value if this is an instance of Type.
    bool IsInstance (const char *const theTypeName) const
     Returns a true value if this is an instance of TypeName.
    bool IsKind (const opencascade::handle< Standard_Type > &theType) const
     Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
    bool IsKind (const char *const theTypeName) const
     Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
    Standard_TransientThis () const
     Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
    int GetRefCount () const noexcept
     Get the reference counter of this object.
    void IncrementRefCounter () noexcept
     Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
    int DecrementRefCounter () noexcept
     Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
    virtual void Delete () const
     Memory deallocator for transient classes.

    Static Public Member Functions

    static occ::handle< TFunction_DriverTableGet ()
     Returns the driver table. If a driver does not exist, creates it.
    static constexpr const char * get_type_name ()
     Returns a type descriptor about this object.
    static const opencascade::handle< Standard_Type > & get_type_descriptor ()
     Returns type descriptor of Standard_Transient class.

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.

    Detailed Description

    A container for instances of drivers. You create a new instance of TFunction_Driver and use the method AddDriver to load it into the driver table.

    Constructor & Destructor Documentation

    ◆ TFunction_DriverTable()

    TFunction_DriverTable::TFunction_DriverTable ( )

    Default constructor.

    Member Function Documentation

    ◆ AddDriver()

    bool TFunction_DriverTable::AddDriver ( const Standard_GUID & guid,
    const occ::handle< TFunction_Driver > & driver,
    const int thread = 0 )

    Returns true if the driver has been added successfully to the driver table.

    ◆ Clear()

    void TFunction_DriverTable::Clear ( )

    Removes all drivers. Returns true if the driver has been removed successfully.

    ◆ Dump()

    Standard_OStream & TFunction_DriverTable::Dump ( Standard_OStream & anOS) const

    ◆ FindDriver()

    bool TFunction_DriverTable::FindDriver ( const Standard_GUID & guid,
    occ::handle< TFunction_Driver > & driver,
    const int thread = 0 ) const

    Returns true if the driver was found.

    ◆ Get()

    occ::handle< TFunction_DriverTable > TFunction_DriverTable::Get ( )
    static

    Returns the driver table. If a driver does not exist, creates it.

    ◆ HasDriver()

    bool TFunction_DriverTable::HasDriver ( const Standard_GUID & guid,
    const int thread = 0 ) const

    Returns true if the driver exists in the driver table.

    ◆ operator<<()

    Standard_OStream & TFunction_DriverTable::operator<< ( Standard_OStream & anOS) const
    inline

    ◆ RemoveDriver()

    bool TFunction_DriverTable::RemoveDriver ( const Standard_GUID & guid,
    const int thread = 0 )

    Removes a driver with the given GUID. Returns true if the driver has been removed successfully.


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