ResultFromModel is used to store a final result stored in a TransientProcess, respectfully to its structuration in scopes by using a set of ResultFromTransient Hence, it can be regarded as a passive equivalent of the stored data in the TransientProcess, while an Iterator gives a flat view of it. More...
#include <Transfer_ResultFromModel.hxx>
Public Member Functions | |
| Transfer_ResultFromModel () | |
| Creates a ResultFromModel, empty. | |
| void | SetModel (const Handle< Interface_InterfaceModel > &model) |
| Sets starting Model. | |
| void | SetFileName (const Standard_CString filename) |
| Sets starting File Name. | |
| Handle< Interface_InterfaceModel > | Model () const |
| Returns starting Model (null if not set) | |
| Standard_CString | FileName () const |
| Returns starting File Name (empty if not set) | |
| Standard_Boolean | Fill (const Handle< Transfer_TransientProcess > &TP, const Handle< Standard_Transient > &ent) |
| Fills from a TransientProcess, with the result attached to a starting entity. Considers its Model if it is set. This action produces a structured set of ResultFromTransient, considering scopes, starting by that of <ent>. If <ent> has no recorded result, it remains empty Returns True if a result is recorded, False else. | |
| void | Strip (const Standard_Integer mode) |
| Clears some data attached to binders used by TransientProcess, which become useless once the transfer has been done, by calling Strip on its ResultFromTransient. | |
| void | FillBack (const Handle< Transfer_TransientProcess > &TP) const |
| Fills back a TransientProcess from the structured set of binders. Also sets the Model. | |
| Standard_Boolean | HasResult () const |
| Returns True if a Result is recorded. | |
| Handle< Transfer_ResultFromTransient > | MainResult () const |
| Returns the main recorded ResultFromTransient, or a null. | |
| void | SetMainResult (const Handle< Transfer_ResultFromTransient > &amain) |
| Sets a new value for the main recorded ResultFromTransient. | |
| Standard_CString | MainLabel () const |
| Returns the label in starting model attached to main entity (updated by Fill or SetMainResult, if Model is known) | |
| Standard_Integer | MainNumber () const |
| Returns the label in starting model attached to main entity. | |
| Handle< Transfer_ResultFromTransient > | ResultFromKey (const Handle< Standard_Transient > &start) const |
| Searches for a key (starting entity) and returns its result Returns a null handle if not found. | |
| Handle< TColStd_HSequenceOfTransient > | Results (const Standard_Integer level) const |
| Internal method which returns the list of ResultFromTransient, according level (2:complete; 1:sub-level 1; 0:main only) | |
| Handle< TColStd_HSequenceOfTransient > | TransferredList (const Standard_Integer level=2) const |
| Returns the list of recorded starting entities, ending by the root. Entities with check but no transfer result are ignored <level> = 2 (D), considers the complete list <level> = 1 considers the main result plus immediate subs <level> = 0 just the main result. | |
| Handle< TColStd_HSequenceOfTransient > | CheckedList (const Interface_CheckStatus check, const Standard_Boolean result) const |
| Returns the list of starting entities to which a check status is attached. <check> = -2 , all entities whatever the check (see result) <check> = -1 , entities with no fail (warning allowed) <check> = 0 , entities with no check at all <check> = 1 , entities with warning but no fail <check> = 2 , entities with fail <result> : if True, only entities with an attached result Remark : result True and check=0 will give an empty list. | |
| Interface_CheckIterator | CheckList (const Standard_Boolean erronly, const Standard_Integer level=2) const |
| Returns the check-list of this set of results <erronly> true : only fails are considered <level> = 0 : considers only main binder <level> = 1 : considers main binder plus immediate subs <level> = 2 (D) : considers all checks. | |
| Interface_CheckStatus | CheckStatus () const |
| Returns the check status with corresponds to the content of this ResultFromModel; considers all levels of transfer (worst status). Returns CheckAny if not yet computed Reads it from recorded status if already computed, else recomputes one. | |
| Interface_CheckStatus | ComputeCheckStatus (const Standard_Boolean enforce) |
| Computes and records check status (see CheckStatus) Does not computes it if already done and <enforce> False. | |
 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. | |
Detailed Description
ResultFromModel is used to store a final result stored in a TransientProcess, respectfully to its structuration in scopes by using a set of ResultFromTransient Hence, it can be regarded as a passive equivalent of the stored data in the TransientProcess, while an Iterator gives a flat view of it.
A ResultFromModel is intended to be attached to the transfer of one entity (typically root entity but it is not mandatory)
It is then possible to :
- Create and fill a ResultFromModel from a TransientProcess, by designating a starting entity
- Fill back the TransientProcess from a ResultFromModel, as it were filled by the operation which filled it the first time
Constructor & Destructor Documentation
◆ Transfer_ResultFromModel()
| Transfer_ResultFromModel::Transfer_ResultFromModel | ( | ) |
Creates a ResultFromModel, empty.
Member Function Documentation
◆ CheckedList()
| Handle< TColStd_HSequenceOfTransient > Transfer_ResultFromModel::CheckedList | ( | const Interface_CheckStatus | check, |
| const Standard_Boolean | result | ||
| ) | const |
Returns the list of starting entities to which a check status is attached. <check> = -2 , all entities whatever the check (see result) <check> = -1 , entities with no fail (warning allowed) <check> = 0 , entities with no check at all <check> = 1 , entities with warning but no fail <check> = 2 , entities with fail <result> : if True, only entities with an attached result Remark : result True and check=0 will give an empty list.
◆ CheckList()
| Interface_CheckIterator Transfer_ResultFromModel::CheckList | ( | const Standard_Boolean | erronly, |
| const Standard_Integer | level = 2 |
||
| ) | const |
Returns the check-list of this set of results <erronly> true : only fails are considered <level> = 0 : considers only main binder <level> = 1 : considers main binder plus immediate subs <level> = 2 (D) : considers all checks.
◆ CheckStatus()
| Interface_CheckStatus Transfer_ResultFromModel::CheckStatus | ( | ) | const |
Returns the check status with corresponds to the content of this ResultFromModel; considers all levels of transfer (worst status). Returns CheckAny if not yet computed Reads it from recorded status if already computed, else recomputes one.
◆ ComputeCheckStatus()
| Interface_CheckStatus Transfer_ResultFromModel::ComputeCheckStatus | ( | const Standard_Boolean | enforce | ) |
Computes and records check status (see CheckStatus) Does not computes it if already done and <enforce> False.
◆ FileName()
| Standard_CString Transfer_ResultFromModel::FileName | ( | ) | const |
Returns starting File Name (empty if not set)
◆ Fill()
| Standard_Boolean Transfer_ResultFromModel::Fill | ( | const Handle< Transfer_TransientProcess > & | TP, |
| const Handle< Standard_Transient > & | ent | ||
| ) |
Fills from a TransientProcess, with the result attached to a starting entity. Considers its Model if it is set. This action produces a structured set of ResultFromTransient, considering scopes, starting by that of <ent>. If <ent> has no recorded result, it remains empty Returns True if a result is recorded, False else.
◆ FillBack()
| void Transfer_ResultFromModel::FillBack | ( | const Handle< Transfer_TransientProcess > & | TP | ) | const |
Fills back a TransientProcess from the structured set of binders. Also sets the Model.
◆ HasResult()
| Standard_Boolean Transfer_ResultFromModel::HasResult | ( | ) | const |
Returns True if a Result is recorded.
◆ MainLabel()
| Standard_CString Transfer_ResultFromModel::MainLabel | ( | ) | const |
Returns the label in starting model attached to main entity (updated by Fill or SetMainResult, if Model is known)
◆ MainNumber()
| Standard_Integer Transfer_ResultFromModel::MainNumber | ( | ) | const |
Returns the label in starting model attached to main entity.
◆ MainResult()
| Handle< Transfer_ResultFromTransient > Transfer_ResultFromModel::MainResult | ( | ) | const |
Returns the main recorded ResultFromTransient, or a null.
◆ Model()
| Handle< Interface_InterfaceModel > Transfer_ResultFromModel::Model | ( | ) | const |
Returns starting Model (null if not set)
◆ ResultFromKey()
| Handle< Transfer_ResultFromTransient > Transfer_ResultFromModel::ResultFromKey | ( | const Handle< Standard_Transient > & | start | ) | const |
Searches for a key (starting entity) and returns its result Returns a null handle if not found.
◆ Results()
| Handle< TColStd_HSequenceOfTransient > Transfer_ResultFromModel::Results | ( | const Standard_Integer | level | ) | const |
Internal method which returns the list of ResultFromTransient, according level (2:complete; 1:sub-level 1; 0:main only)
◆ SetFileName()
| void Transfer_ResultFromModel::SetFileName | ( | const Standard_CString | filename | ) |
Sets starting File Name.
◆ SetMainResult()
| void Transfer_ResultFromModel::SetMainResult | ( | const Handle< Transfer_ResultFromTransient > & | amain | ) |
Sets a new value for the main recorded ResultFromTransient.
◆ SetModel()
| void Transfer_ResultFromModel::SetModel | ( | const Handle< Interface_InterfaceModel > & | model | ) |
Sets starting Model.
◆ Strip()
| void Transfer_ResultFromModel::Strip | ( | const Standard_Integer | mode | ) |
Clears some data attached to binders used by TransientProcess, which become useless once the transfer has been done, by calling Strip on its ResultFromTransient.
mode = 0 : minimum, clears data remaining from TransferProcess mode = 10 : just keeps file name, label, check status ..., and MainResult but only the result (Binder) mode = 11 : also clears MainResult (status and names remain)
◆ TransferredList()
| Handle< TColStd_HSequenceOfTransient > Transfer_ResultFromModel::TransferredList | ( | const Standard_Integer | level = 2 | ) | const |
Returns the list of recorded starting entities, ending by the root. Entities with check but no transfer result are ignored <level> = 2 (D), considers the complete list <level> = 1 considers the main result plus immediate subs <level> = 0 just the main result.
The documentation for this class was generated from the following file:
