This class, in conjunction with ResultFromModel, allows to record the result of a transfer initially stored in a TransientProcess. More...
#include <Transfer_ResultFromTransient.hxx>
Public Member Functions | |
| Transfer_ResultFromTransient () | |
| Creates a ResultFromTransient, empty. More... | |
| void | SetStart (const Handle< Standard_Transient > &start) |
| Sets starting entity. More... | |
| void | SetBinder (const Handle< Transfer_Binder > &binder) |
| Sets Binder (for result plus individual check) More... | |
| Handle< Standard_Transient > | Start () const |
| Returns the starting entity. More... | |
| Handle< Transfer_Binder > | Binder () const |
| Returns the binder. More... | |
| Standard_Boolean | HasResult () const |
| Returns True if a result is recorded. More... | |
| const Handle< Interface_Check > | Check () const |
| Returns the check (or an empty one if no binder) More... | |
| Interface_CheckStatus | CheckStatus () const |
| Returns the check status. More... | |
| void | ClearSubs () |
| Clears the list of (immediate) sub-results. More... | |
| void | AddSubResult (const Handle< Transfer_ResultFromTransient > &sub) |
| Adds a sub-result. More... | |
| Standard_Integer | NbSubResults () const |
| Returns the count of recorded sub-results. More... | |
| Handle< Transfer_ResultFromTransient > | SubResult (const Standard_Integer num) const |
| Returns a sub-result, given its rank. More... | |
| Handle< Transfer_ResultFromTransient > | ResultFromKey (const Handle< Standard_Transient > &key) const |
| Returns the ResultFromTransient attached to a given starting entity (the key). Returns a null handle if not found. More... | |
| void | FillMap (TColStd_IndexedMapOfTransient &map) const |
| This method is used by ResultFromModel to collate the list of ResultFromTransient, avoiding duplications with a map Remark : <me> is already in the map and has not to be bound. More... | |
| void | Fill (const Handle< Transfer_TransientProcess > &TP) |
| Fills from a TransientProcess, with the starting entity which must have been set before. It works with scopes, calls Fill on each of its sub-results. More... | |
| void | Strip () |
| Clears some data attached to binders used by TransientProcess, which become useless once the transfer has been done : the list of sub-scoped binders, which is now recorded as sub-results. More... | |
| void | FillBack (const Handle< Transfer_TransientProcess > &TP) const |
| Fills back a TransientProcess with definition of a ResultFromTransient, respectfully to its structuration in scopes. 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... | |
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... | |
Detailed Description
This class, in conjunction with ResultFromModel, allows to record the result of a transfer initially stored in a TransientProcess.
A ResultFromTransient records a couple (Transient,Binder for the result and checks) plus a list of "sub-results", which have been recorded in the TrabsientProcess, under scope attached to the starting transient.
Constructor & Destructor Documentation
◆ Transfer_ResultFromTransient()
| Transfer_ResultFromTransient::Transfer_ResultFromTransient | ( | ) |
Creates a ResultFromTransient, empty.
Member Function Documentation
◆ AddSubResult()
| void Transfer_ResultFromTransient::AddSubResult | ( | const Handle< Transfer_ResultFromTransient > & | sub | ) |
Adds a sub-result.
◆ Binder()
| Handle< Transfer_Binder > Transfer_ResultFromTransient::Binder | ( | ) | const |
Returns the binder.
◆ Check()
| const Handle< Interface_Check > Transfer_ResultFromTransient::Check | ( | ) | const |
Returns the check (or an empty one if no binder)
◆ CheckStatus()
| Interface_CheckStatus Transfer_ResultFromTransient::CheckStatus | ( | ) | const |
Returns the check status.
◆ ClearSubs()
| void Transfer_ResultFromTransient::ClearSubs | ( | ) |
Clears the list of (immediate) sub-results.
◆ Fill()
| void Transfer_ResultFromTransient::Fill | ( | const Handle< Transfer_TransientProcess > & | TP | ) |
Fills from a TransientProcess, with the starting entity which must have been set before. It works with scopes, calls Fill on each of its sub-results.
◆ FillBack()
| void Transfer_ResultFromTransient::FillBack | ( | const Handle< Transfer_TransientProcess > & | TP | ) | const |
Fills back a TransientProcess with definition of a ResultFromTransient, respectfully to its structuration in scopes.
◆ FillMap()
| void Transfer_ResultFromTransient::FillMap | ( | TColStd_IndexedMapOfTransient & | map | ) | const |
This method is used by ResultFromModel to collate the list of ResultFromTransient, avoiding duplications with a map Remark : <me> is already in the map and has not to be bound.
◆ HasResult()
| Standard_Boolean Transfer_ResultFromTransient::HasResult | ( | ) | const |
Returns True if a result is recorded.
◆ NbSubResults()
| Standard_Integer Transfer_ResultFromTransient::NbSubResults | ( | ) | const |
Returns the count of recorded sub-results.
◆ ResultFromKey()
| Handle< Transfer_ResultFromTransient > Transfer_ResultFromTransient::ResultFromKey | ( | const Handle< Standard_Transient > & | key | ) | const |
Returns the ResultFromTransient attached to a given starting entity (the key). Returns a null handle if not found.
◆ SetBinder()
| void Transfer_ResultFromTransient::SetBinder | ( | const Handle< Transfer_Binder > & | binder | ) |
Sets Binder (for result plus individual check)
◆ SetStart()
| void Transfer_ResultFromTransient::SetStart | ( | const Handle< Standard_Transient > & | start | ) |
Sets starting entity.
◆ Start()
| Handle< Standard_Transient > Transfer_ResultFromTransient::Start | ( | ) | const |
Returns the starting entity.
◆ Strip()
| void Transfer_ResultFromTransient::Strip | ( | ) |
Clears some data attached to binders used by TransientProcess, which become useless once the transfer has been done : the list of sub-scoped binders, which is now recorded as sub-results.
◆ SubResult()
| Handle< Transfer_ResultFromTransient > Transfer_ResultFromTransient::SubResult | ( | const Standard_Integer | num | ) | const |
Returns a sub-result, given its rank.
The documentation for this class was generated from the following file:
