Allows direct binding between a starting Object and the Result of its transfer, when it can be made of several Transient Objects. Compared to a Transcriptor, it has no Transfer Action. More...
#include <Transfer_MultipleBinder.hxx>
Inheritance diagram for Transfer_MultipleBinder:
Public Member Functions | |
| Transfer_MultipleBinder () | |
| normal standard constructor, creates an empty MultipleBinder | |
| virtual Standard_Boolean | IsMultiple () const override |
| Returns True if a starting object is bound with SEVERAL results : Here, returns always True. | |
| Handle< Standard_Type > | ResultType () const override |
| Returns the Type permitted for Results, i.e. here Transient. | |
| Standard_CString | ResultTypeName () const override |
| Returns the Name of the Type which characterizes the Result Here, returns "(list)". | |
| void | AddResult (const Handle< Standard_Transient > &res) |
| Adds a new Item to the Multiple Result. | |
| Standard_Integer | NbResults () const |
| Returns the actual count of recorded (Transient) results. | |
| Handle< Standard_Transient > | ResultValue (const Standard_Integer num) const |
| Returns the value of the recorded result n0 <num> | |
| Handle< TColStd_HSequenceOfTransient > | MultipleResult () const |
| Returns the Multiple Result, if it is defined (at least one Item). Else, returns a Null Handle. | |
| void | SetMultipleResult (const Handle< TColStd_HSequenceOfTransient > &mulres) |
| Defines a Binding with a Multiple Result, given as a Sequence Error if a Unique Result has yet been defined. | |
 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. | |
| 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
Allows direct binding between a starting Object and the Result of its transfer, when it can be made of several Transient Objects. Compared to a Transcriptor, it has no Transfer Action.
Result is a list of Transient Results. Unique Result is not available : SetResult is redefined to start the list on the first call, and refuse the other times.
rr
Remark : MultipleBinder itself is intended to be created and filled by TransferProcess itself (method Bind). In particular, conflicts between Unique (Standard) result and Multiple result are avoided through management made by TransferProcess.
Also, a Transcriptor (with an effective Transfer Method) which can produce a Multiple Result, may be defined as a sub-class of MultipleBinder by redefining method Transfer.
Constructor & Destructor Documentation
◆ Transfer_MultipleBinder()
| Transfer_MultipleBinder::Transfer_MultipleBinder | ( | ) |
normal standard constructor, creates an empty MultipleBinder
Member Function Documentation
◆ AddResult()
| void Transfer_MultipleBinder::AddResult | ( | const Handle< Standard_Transient > & | res | ) |
Adds a new Item to the Multiple Result.
◆ IsMultiple()
|
overridevirtual |
Returns True if a starting object is bound with SEVERAL results : Here, returns always True.
Reimplemented from Transfer_Binder.
◆ MultipleResult()
| Handle< TColStd_HSequenceOfTransient > Transfer_MultipleBinder::MultipleResult | ( | ) | const |
Returns the Multiple Result, if it is defined (at least one Item). Else, returns a Null Handle.
◆ NbResults()
| Standard_Integer Transfer_MultipleBinder::NbResults | ( | ) | const |
Returns the actual count of recorded (Transient) results.
◆ ResultType()
|
overridevirtual |
Returns the Type permitted for Results, i.e. here Transient.
Implements Transfer_Binder.
◆ ResultTypeName()
|
overridevirtual |
Returns the Name of the Type which characterizes the Result Here, returns "(list)".
Implements Transfer_Binder.
◆ ResultValue()
| Handle< Standard_Transient > Transfer_MultipleBinder::ResultValue | ( | const Standard_Integer | num | ) | const |
Returns the value of the recorded result n0 <num>
◆ SetMultipleResult()
| void Transfer_MultipleBinder::SetMultipleResult | ( | const Handle< TColStd_HSequenceOfTransient > & | mulres | ) |
Defines a Binding with a Multiple Result, given as a Sequence Error if a Unique Result has yet been defined.
The documentation for this class was generated from the following file:
