OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    Law_BSpFunc Class Reference

    Law Function based on a BSpline curve 1d. Package methods and classes are implemented in package Law to construct the basis curve with several constraints. More...

    #include <Law_BSpFunc.hxx>

    Inheritance diagram for Law_BSpFunc:

    Public Member Functions

     Law_BSpFunc ()
     Law_BSpFunc (const occ::handle< Law_BSpline > &C, const double First, const double Last)
    GeomAbs_Shape Continuity () const override
    int NbIntervals (const GeomAbs_Shape S) const override
     Returns the number of intervals for continuity . May be one if Continuity(me) >= .
    void Intervals (NCollection_Array1< double > &T, const GeomAbs_Shape S) const override
     Stores in <T> the parameters bounding the intervals of continuity . The array must provide enough room to accommodate for the parameters, i.e. T.Length() > NbIntervals().
    double Value (const double X) override
     Returns the value of the function at the point of parameter X.
    void D1 (const double X, double &F, double &D) override
     Returns the value F and the first derivative D of the function at the point of parameter X.
    void D2 (const double X, double &F, double &D, double &D2) override
     Returns the value, first and second derivatives at parameter X.
    occ::handle< Law_Function > Trim (const double PFirst, const double PLast, const double Tol) const override
     Returns a law equivalent of <me> between parameters <First> and <Last>. <Tol> is used to test for 3d points confusion. It is usfule to determines the derivatives in these values <First> and <Last> if the Law is not Cn.
    void Bounds (double &PFirst, double &PLast) override
     Returns the parametric bounds of the function.
    occ::handle< Law_BSpline > Curve () const
    void SetCurve (const occ::handle< Law_BSpline > &C)
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transient & operator= (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_Transient * This () 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.

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    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.

    Detailed Description

    Law Function based on a BSpline curve 1d. Package methods and classes are implemented in package Law to construct the basis curve with several constraints.

    Constructor & Destructor Documentation

    ◆ Law_BSpFunc() [1/2]

    Law_BSpFunc::Law_BSpFunc ( )

    ◆ Law_BSpFunc() [2/2]

    Law_BSpFunc::Law_BSpFunc ( const occ::handle< Law_BSpline > & C,
    const double First,
    const double Last )

    Member Function Documentation

    ◆ Bounds()

    void Law_BSpFunc::Bounds ( double & PFirst,
    double & PLast )
    overridevirtual

    Returns the parametric bounds of the function.

    Implements Law_Function.

    ◆ Continuity()

    GeomAbs_Shape Law_BSpFunc::Continuity ( ) const
    overridevirtual

    Implements Law_Function.

    ◆ Curve()

    occ::handle< Law_BSpline > Law_BSpFunc::Curve ( ) const

    ◆ D1()

    void Law_BSpFunc::D1 ( const double X,
    double & F,
    double & D )
    overridevirtual

    Returns the value F and the first derivative D of the function at the point of parameter X.

    Implements Law_Function.

    ◆ D2()

    void Law_BSpFunc::D2 ( const double X,
    double & F,
    double & D,
    double & D2 )
    overridevirtual

    Returns the value, first and second derivatives at parameter X.

    Implements Law_Function.

    ◆ Intervals()

    void Law_BSpFunc::Intervals ( NCollection_Array1< double > & T,
    const GeomAbs_Shape S ) const
    overridevirtual

    Stores in <T> the parameters bounding the intervals of continuity . The array must provide enough room to accommodate for the parameters, i.e. T.Length() > NbIntervals().

    Implements Law_Function.

    ◆ NbIntervals()

    int Law_BSpFunc::NbIntervals ( const GeomAbs_Shape S) const
    overridevirtual

    Returns the number of intervals for continuity . May be one if Continuity(me) >= .

    Implements Law_Function.

    ◆ SetCurve()

    void Law_BSpFunc::SetCurve ( const occ::handle< Law_BSpline > & C)

    ◆ Trim()

    occ::handle< Law_Function > Law_BSpFunc::Trim ( const double PFirst,
    const double PLast,
    const double Tol ) const
    overridevirtual

    Returns a law equivalent of <me> between parameters <First> and <Last>. <Tol> is used to test for 3d points confusion. It is usfule to determines the derivatives in these values <First> and <Last> if the Law is not Cn.

    Implements Law_Function.

    ◆ Value()

    double Law_BSpFunc::Value ( const double X)
    overridevirtual

    Returns the value of the function at the point of parameter X.

    Implements Law_Function.


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