#include <StepData_FileRecognizer.hxx>
Inheritance diagram for StepData_FileRecognizer:
Public Member Functions | |
| Standard_Boolean | Evaluate (const TCollection_AsciiString &akey, Handle< Standard_Transient > &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. More... | |
| Handle< Standard_Transient > | Result () const |
| Returns result of last recognition (call of Evaluate) More... | |
| void | Add (const Handle< StepData_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. More... | |
 Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. More... | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. More... | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. More... | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. More... | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. More... | |
| Standard_Boolean | 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. More... | |
| Standard_Boolean | IsKind (const Standard_CString 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. More... | |
| 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. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
| void | IncrementRefCounter () const |
| Increments the reference counter of this object. More... | |
| Standard_Integer | DecrementRefCounter () const |
| Decrements the reference counter of this object; returns the decremented value. More... | |
Protected Member Functions | |
| StepData_FileRecognizer () | |
| Assumes that no result has yet been recognized. More... | |
| void | SetOK (const Handle< Standard_Transient > &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. More... | |
| void | SetKO () |
| Records that recognition gives no result. More... | |
| virtual void | Eval (const TCollection_AsciiString &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. More... | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. More... | |
| Static Public Member Functions inherited from Standard_Transient | |
| static const char * | get_type_name () |
| Returns a type descriptor about this object. More... | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. More... | |
Constructor & Destructor Documentation
◆ StepData_FileRecognizer()
|
protected |
Assumes that no result has yet been recognized.
Member Function Documentation
◆ Add()
| void StepData_FileRecognizer::Add | ( | const Handle< StepData_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()
|
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()
| Standard_Boolean StepData_FileRecognizer::Evaluate | ( | const TCollection_AsciiString & | akey, |
| Handle< Standard_Transient > & | 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()
| Handle< Standard_Transient > StepData_FileRecognizer::Result | ( | ) | const |
Returns result of last recognition (call of Evaluate)
◆ SetKO()
|
protected |
Records that recognition gives no result.
◆ SetOK()
|
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:
