a VoidBinder is used to bind a starting item with a status, error or warning messages, but no result It is interpreted by TransferProcess, which admits a VoidBinder to be over-written, and copies its check to the new Binder More...
#include <Transfer_VoidBinder.hxx>
Inheritance diagram for Transfer_VoidBinder:
Public Member Functions | |
| Transfer_VoidBinder () | |
| a VoidBinder is not Multiple (Remark : it is not Simple too) But it can bring next results ... | |
| Handle< Standard_Type > | ResultType () const override |
| while a VoidBinder admits no Result, its ResultType returns the type of <me> | |
| Standard_CString | ResultTypeName () const override |
| Returns "(void)". | |
 Public Member Functions inherited from Transfer_Binder | |
| void | Merge (const Handle< Transfer_Binder > &other) |
| Merges basic data (Check, ExecStatus) from another Binder but keeps its result. Used when a binder is replaced by another one, this allows to keep messages. | |
| virtual Standard_Boolean | IsMultiple () const |
| Returns True if a Binder has several results, either by itself or because it has next results Can be defined by sub-classes. | |
| void | AddResult (const Handle< Transfer_Binder > &next) |
| Adds a next result (at the end of the list) Remark : this information is not processed by Merge. | |
| Handle< Transfer_Binder > | NextResult () const |
| Returns the next result, Null if none. | |
| Standard_Boolean | HasResult () const |
| Returns True if a Result is available (StatusResult = Defined) A Unique Result will be gotten by Result (which must be defined in each sub-class according to result type) For a Multiple Result, see class MultipleBinder For other case, specific access has to be forecast. | |
| void | SetAlreadyUsed () |
| Declares that result is now used by another one, it means that it cannot be modified (by Rebind) | |
| Transfer_StatusResult | Status () const |
| Returns status, which can be Initial (not yet done), Made (a result is recorded, not yet shared), Used (it is shared and cannot be modified) | |
| Transfer_StatusExec | StatusExec () const |
| Returns execution status. | |
| void | SetStatusExec (const Transfer_StatusExec stat) |
| Modifies execution status; called by TransferProcess only (for StatusError, rather use SetError, below) | |
| void | AddFail (const Standard_CString mess, const Standard_CString orig="") |
| Used to declare an individual transfer as being erroneous (Status is set to Void, StatusExec is set to Error, <errmess> is added to Check's list of Fails) It is possible to record several messages of error. | |
| void | AddWarning (const Standard_CString mess, const Standard_CString orig="") |
| Used to attach a Warning Message to an individual Transfer It has no effect on the Status. | |
| const Handle< Interface_Check > | Check () const |
| Returns Check which stores Fail messages Note that no Entity is associated in this Check. | |
| Handle< Interface_Check > | CCheck () |
| Returns Check which stores Fail messages, in order to modify it (adding messages, or replacing it) | |
| ~Transfer_Binder () | |
| Destructor. | |
| 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 () |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| 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. | |
| 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. | |
| 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. | |
| Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. | |
| Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
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 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. | |
| Protected Member Functions inherited from Transfer_Binder | |
| Transfer_Binder () | |
| Sets fields at initial values. | |
| void | SetResultPresent () |
| Used to declare that a result is recorded for an individual transfer (works by setting StatusResult to Defined) | |
Detailed Description
a VoidBinder is used to bind a starting item with a status, error or warning messages, but no result It is interpreted by TransferProcess, which admits a VoidBinder to be over-written, and copies its check to the new Binder
Constructor & Destructor Documentation
◆ Transfer_VoidBinder()
| Transfer_VoidBinder::Transfer_VoidBinder | ( | ) |
a VoidBinder is not Multiple (Remark : it is not Simple too) But it can bring next results ...
Member Function Documentation
◆ ResultType()
|
overridevirtual |
while a VoidBinder admits no Result, its ResultType returns the type of <me>
Implements Transfer_Binder.
◆ ResultTypeName()
|
overridevirtual |
Returns "(void)".
Implements Transfer_Binder.
The documentation for this class was generated from the following file:
