Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions
IGESData_FileRecognizer Class Referenceabstract

#include <IGESData_FileRecognizer.hxx>

Inheritance diagram for IGESData_FileRecognizer:
Inheritance graph
[legend]

Public Member Functions

bool Evaluate (const IGESData_IGESType &akey, occ::handle< IGESData_IGESEntity > &res)
 Evaluates if recognition has a result, returns it if yes In case of success, Returns True and puts result in "res" In case of Failure, simply Returns False Works by calling deferred method Eval, and in case of failure, looks for Added Recognizers to work.
 
occ::handle< IGESData_IGESEntityResult () const
 Returns result of last recognition (call of Evaluate)
 
void Add (const occ::handle< IGESData_FileRecognizer > &reco)
 Adds a new Recognizer to the Compound, at the end Several calls to Add work by adding in the order of calls : Hence, when Eval has failed to recognize, Evaluate will call Evaluate from the first added Recognizer if there is one, and to the second if there is still no result, and so on.
 
- 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.
 

Protected Member Functions

 IGESData_FileRecognizer ()
 Assumes that no result has yet been recognized.
 
void SetOK (const occ::handle< IGESData_IGESEntity > &aresult)
 Records the result of the recognition. Called by specific method Eval to record a result : after calling it, Eval has finished and can return.
 
void SetKO ()
 Records that recognition gives no result.
 
virtual void Eval (const IGESData_IGESType &akey)=0
 THIS METHOD DEFINES THE RECOGNITION PROTOCOL, it is proper to each precise type of Recognizer For a suitable type of akey, it calls SetOK(result) where result is an empty result of appropriate type, then returns.
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Static Public Member Functions inherited from Standard_Transient
static constexpr const charget_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.
 

Constructor & Destructor Documentation

◆ IGESData_FileRecognizer()

IGESData_FileRecognizer::IGESData_FileRecognizer ( )
protected

Assumes that no result has yet been recognized.

Member Function Documentation

◆ Add()

void IGESData_FileRecognizer::Add ( const occ::handle< IGESData_FileRecognizer > & reco)

Adds a new Recognizer to the Compound, at the end Several calls to Add work by adding in the order of calls : Hence, when Eval has failed to recognize, Evaluate will call Evaluate from the first added Recognizer if there is one, and to the second if there is still no result, and so on.

◆ Eval()

virtual void IGESData_FileRecognizer::Eval ( const IGESData_IGESType & akey)
protectedpure virtual

THIS METHOD DEFINES THE RECOGNITION PROTOCOL, it is proper to each precise type of Recognizer For a suitable type of akey, it calls SetOK(result) where result is an empty result of appropriate type, then returns.

◆ Evaluate()

bool IGESData_FileRecognizer::Evaluate ( const IGESData_IGESType & akey,
occ::handle< IGESData_IGESEntity > & res )

Evaluates if recognition has a result, returns it if yes In case of success, Returns True and puts result in "res" In case of Failure, simply Returns False Works by calling deferred method Eval, and in case of failure, looks for Added Recognizers to work.

◆ Result()

occ::handle< IGESData_IGESEntity > IGESData_FileRecognizer::Result ( ) const

Returns result of last recognition (call of Evaluate)

◆ SetKO()

void IGESData_FileRecognizer::SetKO ( )
protected

Records that recognition gives no result.

◆ SetOK()

void IGESData_FileRecognizer::SetOK ( const occ::handle< IGESData_IGESEntity > & aresult)
protected

Records the result of the recognition. Called by specific method Eval to record a result : after calling it, Eval has finished and can return.


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