OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    Units_Lexicon Class Reference

    This class defines a lexicon useful to analyse and recognize the different key words included in a sentence. The lexicon is stored in a sequence of tokens. More...

    #include <Units_Lexicon.hxx>

    Inheritance diagram for Units_Lexicon:

    Public Member Functions

     Units_Lexicon ()
     Creates an empty instance of Lexicon.
    void Creates ()
     Reads the file <afilename> to create a sequence of tokens stored in <thesequenceoftokens>.
    occ::handle< NCollection_HSequence< occ::handle< Units_Token > > > Sequence () const
     Returns the first item of the sequence of tokens.
    void AddToken (const char *const aword, const char *const amean, const double avalue)
     Adds to the lexicon a new token with <aword>, <amean>, <avalue> as arguments. If there is already a token with the field <theword> equal to <aword>, the existing token is updated.
    virtual void Dump () const
     Useful for debugging.
    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

    This class defines a lexicon useful to analyse and recognize the different key words included in a sentence. The lexicon is stored in a sequence of tokens.

    Constructor & Destructor Documentation

    ◆ Units_Lexicon()

    Units_Lexicon::Units_Lexicon ( )

    Creates an empty instance of Lexicon.

    Member Function Documentation

    ◆ AddToken()

    void Units_Lexicon::AddToken ( const char *const aword,
    const char *const amean,
    const double avalue )

    Adds to the lexicon a new token with <aword>, <amean>, <avalue> as arguments. If there is already a token with the field <theword> equal to <aword>, the existing token is updated.

    ◆ Creates()

    void Units_Lexicon::Creates ( )

    Reads the file <afilename> to create a sequence of tokens stored in <thesequenceoftokens>.

    ◆ Dump()

    virtual void Units_Lexicon::Dump ( ) const
    virtual

    Useful for debugging.

    Reimplemented in Units_UnitsLexicon.

    ◆ Sequence()

    occ::handle< NCollection_HSequence< occ::handle< Units_Token > > > Units_Lexicon::Sequence ( ) const

    Returns the first item of the sequence of tokens.


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